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/14489f19-dbb0-4d89-9923-b5b4494439bd/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/14489f19-dbb0-4d89-9923-b5b4494439bd/results/449335/?format=api",
            "id": 449335,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/ee7d9703-becb-4fb7-a23a-3eebf1186a6b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/14489f19-dbb0-4d89-9923-b5b4494439bd/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T161837Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=497681a583d382da07dafdbd70630b4c2718ad1f48d3d2b4b33cf939fb3aa6d4"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/14489f19-dbb0-4d89-9923-b5b4494439bd/results/449336/?format=api",
            "id": 449336,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/dd18fc0c-b913-4b65-bd27-9037b4aa6909/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/14489f19-dbb0-4d89-9923-b5b4494439bd/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T161838Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=67f25b6b145d278b0f2b2d9be6486b5bbde12b806341a5e6c02fd53922699c8c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/14489f19-dbb0-4d89-9923-b5b4494439bd/results/449337/?format=api",
            "id": 449337,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d878919d-85b5-4628-843e-da71029d6961/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/14489f19-dbb0-4d89-9923-b5b4494439bd/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T161838Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0447f49d3728057c570d8e52fe339d452ba24cb5b6fc4587025ac1c3b99e5e75"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/14489f19-dbb0-4d89-9923-b5b4494439bd/results/449338/?format=api",
            "id": 449338,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/1eaf1a36-b46b-47e7-9305-1ff07bd51b78/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/14489f19-dbb0-4d89-9923-b5b4494439bd/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T161838Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=747ff81a785c41ce4f1054ecbca33e9e4b047b0b1800e8c5122e747f1d35fa32"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/14489f19-dbb0-4d89-9923-b5b4494439bd/results/449339/?format=api",
            "id": 449339,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/dde4eebc-3e75-4478-bd95-ebf3646f1e97/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/14489f19-dbb0-4d89-9923-b5b4494439bd/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T161838Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=64f14b4d540634c9aaa4dce65aa10da5b5572708163912009d5200ea8d49fd63"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/14489f19-dbb0-4d89-9923-b5b4494439bd/results/449340/?format=api",
            "id": 449340,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/727ba3e6-4839-4e41-b0ea-c4d14f7360b5/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/14489f19-dbb0-4d89-9923-b5b4494439bd/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T161838Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=bc50578285829990afe3876085e3b6aa27e541198cf759a8b4b32d16a1bcc64c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/14489f19-dbb0-4d89-9923-b5b4494439bd/results/449341/?format=api",
            "id": 449341,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/6851b504-7248-4bf6-a7c1-791ec803fa3b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/14489f19-dbb0-4d89-9923-b5b4494439bd/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T161838Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6c919b7a81cfe3b4e525d9de6b3485ceccc5dbe5a514883360420151b672647f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/14489f19-dbb0-4d89-9923-b5b4494439bd/results/449342/?format=api",
            "id": 449342,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/ec056477-d8e9-4c98-b0ae-0fa4aad8e7b7/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/14489f19-dbb0-4d89-9923-b5b4494439bd/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T161838Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=66d9f44c52fd9dc0bcfc4dc7e85cd92455b585fa4e4fc7cb2af1dcc03d4a6367"
        }
    ]
}