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/aee370db-d66d-4864-bcf2-b83149c71f8a/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/aee370db-d66d-4864-bcf2-b83149c71f8a/results/490233/?format=api",
            "id": 490233,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4e860e4e-1aec-4d1b-989c-af730e438ba6/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/aee370db-d66d-4864-bcf2-b83149c71f8a/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T121747Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=50b2254b5b66fa45542354f414fe4564008c8d1301496e5d9157bab44c690bf5"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/aee370db-d66d-4864-bcf2-b83149c71f8a/results/490234/?format=api",
            "id": 490234,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/79585579-bb69-4969-b89c-8c65c7d533a3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/aee370db-d66d-4864-bcf2-b83149c71f8a/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T121747Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d56e1c67f96587a5152163346226c7a9a5c3d1af712e27414a9747ae84f77670"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/aee370db-d66d-4864-bcf2-b83149c71f8a/results/490235/?format=api",
            "id": 490235,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/9cf0dfc0-c8ee-4726-89cf-aeb35283ea3a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/aee370db-d66d-4864-bcf2-b83149c71f8a/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T121747Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6543ebf20c169b474e299e2c2f28d7c71161a42a93d9f1f1dc48844f60344dd3"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/aee370db-d66d-4864-bcf2-b83149c71f8a/results/490236/?format=api",
            "id": 490236,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/137d785a-93bf-48c4-9db0-7ccec2bf4869/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/aee370db-d66d-4864-bcf2-b83149c71f8a/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T121747Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c62b7f43ced7efa0f0d064bf5181e54f74bef8989ae9ec67debf1d81c4172544"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/aee370db-d66d-4864-bcf2-b83149c71f8a/results/490237/?format=api",
            "id": 490237,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/ee8e3d32-1859-4de4-bb01-449d75e1ba2e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/aee370db-d66d-4864-bcf2-b83149c71f8a/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T121747Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=755c85295fb8606a7ca7bb463a1b90d14fddec63d135a7ec5b1aeef5114a1966"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/aee370db-d66d-4864-bcf2-b83149c71f8a/results/490238/?format=api",
            "id": 490238,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/cc33480f-5ce5-427f-89ef-543bd210590a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/aee370db-d66d-4864-bcf2-b83149c71f8a/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T121747Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f15d5f0f416d4dea8753d7c0dfb47f33b3a53546217218b7b710af66a6e350f7"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/aee370db-d66d-4864-bcf2-b83149c71f8a/results/490239/?format=api",
            "id": 490239,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/32580006-d584-4b1e-aeeb-cb9e8c3a391a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/aee370db-d66d-4864-bcf2-b83149c71f8a/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T121747Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d2595ed20d24539fdf4c4fd18da40db3ab7d567b82b757d63162572e6984c73a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/aee370db-d66d-4864-bcf2-b83149c71f8a/results/490240/?format=api",
            "id": 490240,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/8daa885f-b4b9-4b9d-aeca-0b9287c174a1/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/aee370db-d66d-4864-bcf2-b83149c71f8a/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T121747Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0335e530fdac20c01a6922830373a3e96987450569e7c688db864e0285046dc3"
        }
    ]
}