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/81d5415e-fcbd-40b9-afb7-dac4858a0f01/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/81d5415e-fcbd-40b9-afb7-dac4858a0f01/results/448098/?format=api",
            "id": 448098,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/00551c79-3f3a-4804-b7a4-7edb1b8016c9/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/81d5415e-fcbd-40b9-afb7-dac4858a0f01/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T004307Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=053c49a246776925ea895f816a52990fe70bfe45a87eccb0ae343d179d4e8306"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/81d5415e-fcbd-40b9-afb7-dac4858a0f01/results/448099/?format=api",
            "id": 448099,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/1a34b39f-456a-42e9-ac8e-c387a27b1113/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/81d5415e-fcbd-40b9-afb7-dac4858a0f01/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T004307Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a8bdd54154ae909c91a386c1ee8f5bce342d88bb675d995e8619bb8c90be89b9"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/81d5415e-fcbd-40b9-afb7-dac4858a0f01/results/448100/?format=api",
            "id": 448100,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/3b0c57bf-f034-4c04-9324-b1af7c5d6ec4/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/81d5415e-fcbd-40b9-afb7-dac4858a0f01/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T004308Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1e030725cd8f333097184a60c319f7dbcc8f70fc27c192a8e3885004be13f8b2"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/81d5415e-fcbd-40b9-afb7-dac4858a0f01/results/448101/?format=api",
            "id": 448101,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a1ce9d0d-700f-4c09-8833-57a520d9a1b5/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/81d5415e-fcbd-40b9-afb7-dac4858a0f01/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T004308Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=01a7ec1db440382bf071cb4de2f66ace295f2d57d7e9274b883b231511014453"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/81d5415e-fcbd-40b9-afb7-dac4858a0f01/results/448102/?format=api",
            "id": 448102,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/aa669d1b-3606-4b8c-bf84-2e2b54d2f9b3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/81d5415e-fcbd-40b9-afb7-dac4858a0f01/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T004308Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=caf9502aa7b4b6a99fc159af7059b13d0c0cac5793fca6ed1e391a02d1f92ab2"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/81d5415e-fcbd-40b9-afb7-dac4858a0f01/results/448103/?format=api",
            "id": 448103,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/7dad8902-7d0e-454b-a20e-f82867849930/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/81d5415e-fcbd-40b9-afb7-dac4858a0f01/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T004308Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1e83bf1da08f75364ad1b6eb7982bb3fa4022fae6a6f2a0aaa6a7af37f096599"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/81d5415e-fcbd-40b9-afb7-dac4858a0f01/results/448104/?format=api",
            "id": 448104,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2b635643-909a-4d29-b255-73539e153353/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/81d5415e-fcbd-40b9-afb7-dac4858a0f01/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T004308Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ca4f6246de2a7a38fde53c78859b560c8242e1b76549b0695b3db1d157324009"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/81d5415e-fcbd-40b9-afb7-dac4858a0f01/results/448105/?format=api",
            "id": 448105,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/05e4fe2a-4165-405a-a789-b4f2700612e1/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/81d5415e-fcbd-40b9-afb7-dac4858a0f01/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T004308Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=daa2014388ffe82af1be2770d23a57783d3ece1f836de1d432aa9e2028bd4e3b"
        }
    ]
}