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/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/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/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/results/449678/?format=api",
            "id": 449678,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/881a6b61-1913-4521-b0ce-bf815b0656b9/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191452Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c563e89f331968ced0865f0704d58316b5d8e926368d856f778da5ca22a6015b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/results/449679/?format=api",
            "id": 449679,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/ee328513-d6bd-44bc-8fc9-bbf7b79a5f73/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191452Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=76600a34e7345493190fd2ea0d693c46919334495228aaaa16b66b83f5d29cfa"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/results/449680/?format=api",
            "id": 449680,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/ba06e5a7-50dc-4652-968a-37594904c69c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191452Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f534c642ad7181a168ea657d3fcfc354ee678600ce3a66d1349b3963f1bcb1ee"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/results/449681/?format=api",
            "id": 449681,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/7049593e-8228-4cfa-a782-809c8c5351d7/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191452Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7af3f7546c407d2445e10e6b0285046bf79f95cada8e8b70b085e56195b46700"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/results/449682/?format=api",
            "id": 449682,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a1af030c-6278-4848-9338-ba508ee5fa7a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191452Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7777ed6b7f94151282a96e880373342c5fa38bf20cad3a8bc62da3adda4bf609"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/results/449683/?format=api",
            "id": 449683,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/6e497628-186e-49b3-a95e-2da7f458b070/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191452Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=76d245c50425da38889fc03fce099fd6e6348536bab840d82a6ec93568b6c11c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/results/449684/?format=api",
            "id": 449684,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/405dee29-bf3b-4c76-8e85-11bdf30fdabc/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191452Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=adbc257d1b94dde45c08135cd5ebd431af8d94ecac451970ba3a5fbb5b35f0b6"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/results/449685/?format=api",
            "id": 449685,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d882d631-b81a-475e-b0d1-16b35f9be517/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191452Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=693df1fd6b000d50d1451b922b016fbd2316826d1ac63b2e2619e9ac47303b87"
        }
    ]
}