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/4f5a4919-4a90-45ef-afc0-3d58061966ed/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/4f5a4919-4a90-45ef-afc0-3d58061966ed/results/263051/?format=api",
            "id": 263051,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": "Water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/cd943fb7-24e3-4f67-9ed1-640bc1e2b6d4/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4f5a4919-4a90-45ef-afc0-3d58061966ed/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T162309Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a3ed212122aa6e96b9221c7cbba49f44edba35c15005b4bb6acde080f013368d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4f5a4919-4a90-45ef-afc0-3d58061966ed/results/263052/?format=api",
            "id": 263052,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": "Max water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/eebccc6d-c624-4c3a-918c-09a7f30d2018/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4f5a4919-4a90-45ef-afc0-3d58061966ed/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T162309Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a45b47ceb71319c229a8c90276bb36740b25b916e7d6f088c58bea95b25d3d0f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4f5a4919-4a90-45ef-afc0-3d58061966ed/results/263053/?format=api",
            "id": 263053,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": "Flood hazard rating",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c531429f-e54b-493b-b4b7-e2c6d6260603/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4f5a4919-4a90-45ef-afc0-3d58061966ed/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T162309Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0fc63eee6316f1f6eaaf7f1652d9569e42761de9950b67e03e6c9ece50d14cc3"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4f5a4919-4a90-45ef-afc0-3d58061966ed/results/263054/?format=api",
            "id": 263054,
            "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/56fc9029-775c-4631-b8cf-ce0474b906c8/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4f5a4919-4a90-45ef-afc0-3d58061966ed/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T162309Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9a56b60f64a69fdd1c045e506e5105538a8b27d0c0d4eec84d936ab2031c9bb0"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4f5a4919-4a90-45ef-afc0-3d58061966ed/results/263055/?format=api",
            "id": 263055,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": "Water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d28e28e8-462e-4c2a-bd1f-723df750b171/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4f5a4919-4a90-45ef-afc0-3d58061966ed/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T162309Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0a5650fef59586b68718343740974ff8553883da159ea7e77f1aa517f7f0bbc3"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4f5a4919-4a90-45ef-afc0-3d58061966ed/results/263056/?format=api",
            "id": 263056,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": "Max water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/95fac84c-ab6d-4e50-990f-247f38b956c7/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4f5a4919-4a90-45ef-afc0-3d58061966ed/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T162309Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7f416758f9a383ad7c8b1fc51b5a2337693b29e13489bc7954ae38eaa3495de6"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4f5a4919-4a90-45ef-afc0-3d58061966ed/results/263057/?format=api",
            "id": 263057,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": "Max flow velocity",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/6b39b134-982f-4f73-8b7c-058c1d0ed7c2/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4f5a4919-4a90-45ef-afc0-3d58061966ed/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T162309Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=95bceb442e6dbbcabf7086cbb9dc5e3b31a77ac2a56184050ec30089bc1e0b02"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4f5a4919-4a90-45ef-afc0-3d58061966ed/results/263058/?format=api",
            "id": 263058,
            "name": "Rain",
            "code": "rain-quad",
            "description": "Rain",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c094bd4f-2c5b-43b1-bffd-041a4d0353e3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4f5a4919-4a90-45ef-afc0-3d58061966ed/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T162309Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0b0d82776a17f8afbd9072e20204563e11ae664d0de3bdee90d3356b23a38cb4"
        }
    ]
}