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/ab0784f7-ef67-41b4-b565-373bfa8db2a6/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/ab0784f7-ef67-41b4-b565-373bfa8db2a6/results/449490/?format=api",
            "id": 449490,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/8a1fe0a6-cb8e-4088-804f-a3c38fe50aef/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T110515Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a2802f2bc0df1dc344cab044c534835d56e86c09dff1cfba1427a4ce18ec0fc6"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/results/449491/?format=api",
            "id": 449491,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/de7a615f-432a-4672-b14e-72a606415f99/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T110515Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9602138a0aeee7760301571bf56641aa42eb32210fa23e2e07d5e74ff2067480"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/results/449492/?format=api",
            "id": 449492,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/12ffc2e8-a4f0-4e8b-8a37-7d36258e1eca/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T110515Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=58085f7127e37005ef2938934f1278e0821ec5ad3e6ca36dc15d3a9f0273a684"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/results/449493/?format=api",
            "id": 449493,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4c935b78-f71c-49bc-90e2-c98d04f6b093/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T110515Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=fcf2ab6b09f7f3ddb5920934cfceaf1b7dea39bbf88017fa98c442ade92d515b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/results/449494/?format=api",
            "id": 449494,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/34cd9306-4f7a-41cf-9494-8d7e449a98d9/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T110515Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=275a8801c9c6e0a3b9077e6b7948ec928a86da3e7866455d82cd640ca10aaec0"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/results/449495/?format=api",
            "id": 449495,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/9f127204-9d6a-498c-9e51-92cb20a173d2/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T110515Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=65393eb34b4bd47dc18103b5eac10ce4f7e23d011cfa9b5873bf11b8989eae73"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/results/449496/?format=api",
            "id": 449496,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/652a0b84-c104-4d5a-816e-7ad22383eb45/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T110515Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8f2a2fabbbe8db002d2dc0ab4f1c27fbaec54e65996c079662c6243e47c8fdbe"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/results/449497/?format=api",
            "id": 449497,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/15bcb44d-3997-4ab4-ae6d-d9c1aae73244/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T110515Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ed916156b15df92f48fb2306079666d3ceebf75af981ff0253450feba70e5664"
        }
    ]
}