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/19fb48b7-d43d-4a1c-846a-e7d8b1eac594/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/19fb48b7-d43d-4a1c-846a-e7d8b1eac594/results/448781/?format=api",
            "id": 448781,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/44a76d72-d865-4d7a-89d3-878996031b05/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/19fb48b7-d43d-4a1c-846a-e7d8b1eac594/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191557Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0f49e467a1d70ed5080a8a04b503ab1e025e9c89b85588434101f891ea54a82d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/19fb48b7-d43d-4a1c-846a-e7d8b1eac594/results/448782/?format=api",
            "id": 448782,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/84bc690f-a897-4c6e-b804-7544d70d2f20/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/19fb48b7-d43d-4a1c-846a-e7d8b1eac594/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191557Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=dd8e260b46f7d29bbe8b02e5755461aa033027c5fc419d89b172391cc93e004c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/19fb48b7-d43d-4a1c-846a-e7d8b1eac594/results/448783/?format=api",
            "id": 448783,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/61c48cad-d6c0-4f23-8802-94194978ce33/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/19fb48b7-d43d-4a1c-846a-e7d8b1eac594/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191557Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3276d2568bd60cd0e994b6c822647ca643bbaeabfbd2b65e69b9b82db89ced28"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/19fb48b7-d43d-4a1c-846a-e7d8b1eac594/results/448784/?format=api",
            "id": 448784,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d8a7ab82-9ba9-4349-a2a1-2d2306bb49d4/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/19fb48b7-d43d-4a1c-846a-e7d8b1eac594/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191557Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9040493df82b9054d767d13048cbb90d1d597100eba4e462cfa1ade84549b789"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/19fb48b7-d43d-4a1c-846a-e7d8b1eac594/results/448785/?format=api",
            "id": 448785,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/523a417e-4fdc-42cd-9775-6cd1a6b2001f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/19fb48b7-d43d-4a1c-846a-e7d8b1eac594/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191557Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2b3d683f8c2f9431163ea282a8ebfbcc2d6441524d05890b6df5d1a935a7e878"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/19fb48b7-d43d-4a1c-846a-e7d8b1eac594/results/448786/?format=api",
            "id": 448786,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/18053b27-7d16-4a54-8cf6-5bb2af9fd8c1/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/19fb48b7-d43d-4a1c-846a-e7d8b1eac594/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191557Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4ac9102e37e55da548c4d099f1df633f822270cc1561ebf2bcb7fe2f6dca2707"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/19fb48b7-d43d-4a1c-846a-e7d8b1eac594/results/448787/?format=api",
            "id": 448787,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d43060ab-a20f-4be2-8fa8-821c2ee8a138/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/19fb48b7-d43d-4a1c-846a-e7d8b1eac594/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191557Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=880d6c8c2f3f6e4737c6fe0173e4bccd5204e74792b872eda854365d96d24c55"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/19fb48b7-d43d-4a1c-846a-e7d8b1eac594/results/448788/?format=api",
            "id": 448788,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/9c2e438d-52e9-44dd-81ba-d6aca7312153/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/19fb48b7-d43d-4a1c-846a-e7d8b1eac594/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191557Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5b4d8d04397c0bd584e09ebe1dd83352c6db6fd0a735229b513a11d65580420d"
        }
    ]
}