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/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/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/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/results/448885/?format=api",
            "id": 448885,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a51d6555-5342-4d1b-a257-dcf18319acd8/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T153059Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2e497e9d2611fe1b9ccafda4b880ebb1837cdc335b0b9b17f4c1b98a5b2451b4"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/results/448886/?format=api",
            "id": 448886,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/35e9112e-ae66-4963-afa1-20f9a304f4a8/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T153059Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ac16080790714f192b13d0cc8c1fce5cf14d1cd7b21732674fe8b53298b38bd5"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/results/448887/?format=api",
            "id": 448887,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/287af6d7-25db-45b7-bb99-d1238cb8bca2/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T153059Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2bc686dc3ff93cbc52784721421d15d297d2c7ab3e3422ac065f74c973d850e1"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/results/448888/?format=api",
            "id": 448888,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/f0f09c68-f26a-452f-9bd9-b3be530f5576/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T153059Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d91c3335566b3045296cf09e8d956b1c6655880a15d13222810d069f24b2af06"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/results/448889/?format=api",
            "id": 448889,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4cbb9c80-65b9-4f62-ba32-ead20d56b592/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T153059Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=89463e2b3c6aaea0a6ac39774b3bd40efb0d0494242a0a1f241dbcdad59e9351"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/results/448890/?format=api",
            "id": 448890,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/6933c74a-6ec4-4062-ac74-bba7556ca377/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T153059Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e474322811fbdcefe8c402863e6842ea9b9e4c8acaee210155c0066aac9a7746"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/results/448891/?format=api",
            "id": 448891,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/9d761f0e-9cc0-4fa1-8080-f0031ed26b32/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T153059Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b64ccd1f9781c04027d4d2b36766dee32b24d85bea8e7338f2afdfe72a6f65bb"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/results/448892/?format=api",
            "id": 448892,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/21570d7e-8459-4198-9a7b-3f48107e1883/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T153059Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9bb5e6e550f51c1411fbf26d23c254bfc3019e867d30e1e5ef2346fbabd1037b"
        }
    ]
}