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/2e7907d3-4364-4060-ac5a-22c2ffb1e492/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/2e7907d3-4364-4060-ac5a-22c2ffb1e492/results/432414/?format=api",
            "id": 432414,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2f12de49-f151-4396-bc38-87e3a632cf74/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2e7907d3-4364-4060-ac5a-22c2ffb1e492/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T122226Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3c277379d5e1a5a3bed48071f7484b6deb30bda57f54812276ca60146663f459"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2e7907d3-4364-4060-ac5a-22c2ffb1e492/results/432415/?format=api",
            "id": 432415,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/29e5ed03-2bba-4117-bf3e-4b5f49a74905/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2e7907d3-4364-4060-ac5a-22c2ffb1e492/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T122226Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7cd37718b334208f8b2f625e80f2dc9ad64d090344d54cf410edd4d89c8e1410"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2e7907d3-4364-4060-ac5a-22c2ffb1e492/results/432416/?format=api",
            "id": 432416,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/e147c7e2-27f9-4b45-8a3d-feb9e3e6dac6/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2e7907d3-4364-4060-ac5a-22c2ffb1e492/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T122226Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b759574e02d3a5390d174a5b620968682b79d787d70d78635c378bd19e4d3866"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2e7907d3-4364-4060-ac5a-22c2ffb1e492/results/432417/?format=api",
            "id": 432417,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/664b5c46-e581-46e0-b80f-4d20f4a32065/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2e7907d3-4364-4060-ac5a-22c2ffb1e492/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T122226Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6205ddd16ff379029c5c6b0533b2b1f7bc1764d3a7baa36a4472e8b002d8e9e3"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2e7907d3-4364-4060-ac5a-22c2ffb1e492/results/432418/?format=api",
            "id": 432418,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/e8212472-d056-4b0b-97e8-089576b0c9cd/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2e7907d3-4364-4060-ac5a-22c2ffb1e492/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T122226Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a42c6bbf33f32945a79256375746ff62b3bea3c72cdb970fc47ccc1871e6db28"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2e7907d3-4364-4060-ac5a-22c2ffb1e492/results/432419/?format=api",
            "id": 432419,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/78fbbde4-2b0a-48b8-9a19-ef1bc28031c2/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2e7907d3-4364-4060-ac5a-22c2ffb1e492/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T122226Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=61240cf5c12132bd5c715106e7abf89d928ad969861b5288f7a422333b6b9988"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2e7907d3-4364-4060-ac5a-22c2ffb1e492/results/432420/?format=api",
            "id": 432420,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/1f1257cc-67be-4503-9aec-e7aba2adf511/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2e7907d3-4364-4060-ac5a-22c2ffb1e492/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T122226Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=56569fa2ef9ce09dc924805161d94d3132afff7201e851eeabe4809e4cae20e0"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2e7907d3-4364-4060-ac5a-22c2ffb1e492/results/432421/?format=api",
            "id": 432421,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c71a22bc-07a3-40da-89ac-2ffaaf8cb6a9/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2e7907d3-4364-4060-ac5a-22c2ffb1e492/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T122226Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=27730c44a5b976f6ddc7440b849c79af231980aa49f051f3e3415870722ca86e"
        }
    ]
}