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/3322ce16-2683-4266-ae10-a14a7d9dce58/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/3322ce16-2683-4266-ae10-a14a7d9dce58/results/263223/?format=api",
            "id": 263223,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": "Water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4173430f-0c8a-4d0e-b3c6-3c35ce6c84fd/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/3322ce16-2683-4266-ae10-a14a7d9dce58/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T193054Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=399f34d2d71f7fbac3ca74983fb868dcda4f5f265af067a90acb73ebfa383cb9"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3322ce16-2683-4266-ae10-a14a7d9dce58/results/263224/?format=api",
            "id": 263224,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": "Max water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/5af3fa16-39b8-41b3-a6c3-ad1767195f61/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/3322ce16-2683-4266-ae10-a14a7d9dce58/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T193054Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=736586d20701b2ac3695af4cbc00ab3d116e0a303eaf687748ad2e78a57877ba"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3322ce16-2683-4266-ae10-a14a7d9dce58/results/263225/?format=api",
            "id": 263225,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": "Flood hazard rating",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a2b9e13f-1c1e-4e18-9d1d-70f3a343dcf3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/3322ce16-2683-4266-ae10-a14a7d9dce58/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T193054Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=44f613cce48fc09d35ee5177ec2d181fcb088d8db036a5f842b0ba7a74fb5e74"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3322ce16-2683-4266-ae10-a14a7d9dce58/results/263226/?format=api",
            "id": 263226,
            "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/9a2f720a-af27-43fa-ba07-154486ca8393/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/3322ce16-2683-4266-ae10-a14a7d9dce58/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T193054Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9e5f66dad95826f5d3e6c71e3c1a4581733d4025560b15d59cd4e3d7a87629fa"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3322ce16-2683-4266-ae10-a14a7d9dce58/results/263227/?format=api",
            "id": 263227,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": "Water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/95b6f5da-e083-4170-95f1-aa5029f3ebc3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/3322ce16-2683-4266-ae10-a14a7d9dce58/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T193054Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d577fc9e0a65513103bf5bb1f4e34e412807fa7b71d13228915d08da87ac9b46"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3322ce16-2683-4266-ae10-a14a7d9dce58/results/263228/?format=api",
            "id": 263228,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": "Max water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/3efa8d89-83b1-4859-acb3-082705446ed3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/3322ce16-2683-4266-ae10-a14a7d9dce58/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T193054Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=649ce0e78b84b375c894e4d1914b09cfca80f8a84bc535e533a10c45838440a9"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3322ce16-2683-4266-ae10-a14a7d9dce58/results/263229/?format=api",
            "id": 263229,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": "Max flow velocity",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/10fed500-f0d3-4f75-9b71-c45d97a8e4ac/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/3322ce16-2683-4266-ae10-a14a7d9dce58/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T193054Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=83d4eec7cb9ce4add5194e7f77716bef68d7362297c022c526f74f691487336c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3322ce16-2683-4266-ae10-a14a7d9dce58/results/263230/?format=api",
            "id": 263230,
            "name": "Rain",
            "code": "rain-quad",
            "description": "Rain",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/3417a272-1bcd-43e1-9995-75ccfdda61b7/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/3322ce16-2683-4266-ae10-a14a7d9dce58/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T193054Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ad8978174dfdd4a274b93d92424323d397adbfbd2bfa0c3aa56f20d01799e793"
        }
    ]
}