Basic – Django REST framework

Endpoint for interacting with 3Di scenario results.

Add attachments to newly created results by uploading a file (using a PUT request) to the temporary upload_url of a result.

Subendpoints

The subendpoints below have been defined for convienience and may be used for viewing or deleting a specific class of results. They are also available via the "Extra Actions" button in the top-right corner when viewing a result list.

/api/v4/scenarios/{uuid}/results/arrival/
/api/v4/scenarios/{uuid}/results/basic/
/api/v4/scenarios/{uuid}/results/damage/
/api/v4/scenarios/{uuid}/results/raw/
/api/v4/scenarios/{uuid}/results/tiles/

For example, a DELETE request on /api/v4/scenarios/{uuid}/results/raw/ would schedule all raw results for deletion. This is more convenient than deleting results one by one via /api/v4/scenarios/{uuid}/results/{id}/.

GET /api/v4/scenarios/91373aa6-f692-4f3b-bd69-a4d88dc5f26d/results/basic/?format=api

HTTP 200 OK
Allow: GET, DELETE, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "count": 8,
    "next": null,
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/91373aa6-f692-4f3b-bd69-a4d88dc5f26d/results/454917/?format=api",
            "id": 454917,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d64db472-b7bb-4a43-8ab1-8ec2d5969056/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/91373aa6-f692-4f3b-bd69-a4d88dc5f26d/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250317%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250317T030100Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=da4edb03324ef9b933c728ee1428aa372472de55897cc5b129bd0eb4337d4aa5"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/91373aa6-f692-4f3b-bd69-a4d88dc5f26d/results/454918/?format=api",
            "id": 454918,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/04767549-b054-4aa3-a03e-96cda82ddfdf/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/91373aa6-f692-4f3b-bd69-a4d88dc5f26d/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250317%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250317T030100Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ab9d0da01c3ae5c8e79448dd009004c607f0965565d2af657125ba0c52c50073"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/91373aa6-f692-4f3b-bd69-a4d88dc5f26d/results/454919/?format=api",
            "id": 454919,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/7e906a54-085d-43be-9e12-2af337e62010/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/91373aa6-f692-4f3b-bd69-a4d88dc5f26d/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250317%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250317T030100Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=701b2d16c12cd57e236038141e404d09aeb8ec240519cc5419d7c4c2d76e3ee1"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/91373aa6-f692-4f3b-bd69-a4d88dc5f26d/results/454920/?format=api",
            "id": 454920,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/402f43a2-57dd-4c50-819f-e45367f71881/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/91373aa6-f692-4f3b-bd69-a4d88dc5f26d/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250317%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250317T030100Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=bd9131073aeeafdc4200153d09c2422a43dc6a5c4ad3aa7d0c0cad204d9d7820"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/91373aa6-f692-4f3b-bd69-a4d88dc5f26d/results/454921/?format=api",
            "id": 454921,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/ea3b1d28-7d71-4d04-ad30-42c42e7e816a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/91373aa6-f692-4f3b-bd69-a4d88dc5f26d/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250317%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250317T030100Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=cbd0c0a843cc658ec2ed02a08dff1f18e21d322b1c64db54a3ec8eb2db4c1e03"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/91373aa6-f692-4f3b-bd69-a4d88dc5f26d/results/454922/?format=api",
            "id": 454922,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2368eba9-20d3-436c-b718-a30aa7e95af8/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/91373aa6-f692-4f3b-bd69-a4d88dc5f26d/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250317%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250317T030100Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a6b9ff6f97f36cd6906e721ac3383030c5f0549f6e698a794caaef5bd6a81285"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/91373aa6-f692-4f3b-bd69-a4d88dc5f26d/results/454923/?format=api",
            "id": 454923,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d782beb9-58e5-4ff1-8fcd-d3532dd5e58b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/91373aa6-f692-4f3b-bd69-a4d88dc5f26d/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250317%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250317T030100Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=321cce541a7cb6814c769a10fb838941622cef6a0d8b9c50c88ac3ff994ec930"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/91373aa6-f692-4f3b-bd69-a4d88dc5f26d/results/454924/?format=api",
            "id": 454924,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/fe0cd676-479c-4245-900e-619265370b74/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/91373aa6-f692-4f3b-bd69-a4d88dc5f26d/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250317%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250317T030100Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ffe866aea48647d37268a8a6160f044c32017fb42a1747651a66ff62de5bf021"
        }
    ]
}