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/21fe7c29-6ef5-4bd1-866d-9b48ff1c2015/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/21fe7c29-6ef5-4bd1-866d-9b48ff1c2015/results/263075/?format=api",
            "id": 263075,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": "Water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/1771f285-437e-4161-80e5-5325866b1f0c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/21fe7c29-6ef5-4bd1-866d-9b48ff1c2015/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T155428Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5d1a65f605ee617318ef0d9787eaf693720604e6b0dc7a954805dee64f1ca8c3"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/21fe7c29-6ef5-4bd1-866d-9b48ff1c2015/results/263076/?format=api",
            "id": 263076,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": "Max water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4a5ac422-973b-41a5-b045-3a53ee7a5599/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/21fe7c29-6ef5-4bd1-866d-9b48ff1c2015/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T155428Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9f0ee8faa800170d09ae183a5644be53ddb63c4b51c6eb21fd1b7646e45b12db"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/21fe7c29-6ef5-4bd1-866d-9b48ff1c2015/results/263077/?format=api",
            "id": 263077,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": "Flood hazard rating",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/85917ce5-090f-4a69-9b22-0e957724ffa8/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/21fe7c29-6ef5-4bd1-866d-9b48ff1c2015/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T155428Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=266cd1782030eef0acaa73a10d6b745cf44a2f52e2fbcf3aa6594d56e3f86644"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/21fe7c29-6ef5-4bd1-866d-9b48ff1c2015/results/263078/?format=api",
            "id": 263078,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": "Rate of rise of the water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/5feed025-2650-4c86-ae14-243be696cbca/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/21fe7c29-6ef5-4bd1-866d-9b48ff1c2015/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T155428Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=766defd69a2f7dc77691a0008d502167b1cc1ee00b00ab74474abe0aea5bfe88"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/21fe7c29-6ef5-4bd1-866d-9b48ff1c2015/results/263079/?format=api",
            "id": 263079,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": "Water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/fe5ba0d5-f2ea-4834-861f-046f3e2ad66a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/21fe7c29-6ef5-4bd1-866d-9b48ff1c2015/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T155428Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9a46ed21d8044dc55deeeda9918b02a9a3ec8ea5036ab9efd51bd2e91e4a9d26"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/21fe7c29-6ef5-4bd1-866d-9b48ff1c2015/results/263080/?format=api",
            "id": 263080,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": "Max water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a0c55819-58ca-4e63-a034-8422482d9977/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/21fe7c29-6ef5-4bd1-866d-9b48ff1c2015/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T155428Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b66b2ad54b32e986fdbee79527a4f2e92dac59faf5c37acb14cee74aa3400f60"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/21fe7c29-6ef5-4bd1-866d-9b48ff1c2015/results/263081/?format=api",
            "id": 263081,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": "Max flow velocity",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/25dbc75e-d688-4c99-8207-87ad23c76426/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/21fe7c29-6ef5-4bd1-866d-9b48ff1c2015/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T155428Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=746b64f2504156b0dbd021b930a623a21a69b892a7326e597bb0fdbbfe330083"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/21fe7c29-6ef5-4bd1-866d-9b48ff1c2015/results/263082/?format=api",
            "id": 263082,
            "name": "Rain",
            "code": "rain-quad",
            "description": "Rain",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/f280e71f-6040-4ebd-a0b5-a3139e6118bb/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/21fe7c29-6ef5-4bd1-866d-9b48ff1c2015/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T155428Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=593aea3df2e7a3a7a1ec05a8c18a52e38990b836d306826a4ba90b705d596914"
        }
    ]
}