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/958554f2-8f8b-451c-a642-b33481e6408a/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/958554f2-8f8b-451c-a642-b33481e6408a/results/439871/?format=api",
            "id": 439871,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/db372ece-c30d-406c-8c3a-e57fd81d6125/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/958554f2-8f8b-451c-a642-b33481e6408a/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T120333Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c61e065fca6aaef2a2158343310cbcae8e30a46aa63d8de0fa92e512fa52d7d0"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/958554f2-8f8b-451c-a642-b33481e6408a/results/439872/?format=api",
            "id": 439872,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/9a791261-d5f5-4e72-9a3f-395ee4772766/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/958554f2-8f8b-451c-a642-b33481e6408a/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T120333Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ca26a039ee23436e3076c386cb6e00d7ec192f8c946f5969ca91c8d9b42ca636"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/958554f2-8f8b-451c-a642-b33481e6408a/results/439873/?format=api",
            "id": 439873,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/f8c9dc70-7186-4eb9-8582-74aa53fb4a41/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/958554f2-8f8b-451c-a642-b33481e6408a/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T120333Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2a4ff8513d6366fecd73d1a8b47f1494cf5f568a2a4cc1daf74393d29959d166"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/958554f2-8f8b-451c-a642-b33481e6408a/results/439874/?format=api",
            "id": 439874,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/ce2d5932-7411-4bd8-8957-0c72f6666fbe/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/958554f2-8f8b-451c-a642-b33481e6408a/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T120333Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4c7e85541f341a61d9f44989ebcfa728bc8525623ea70fe78d06d6986310b063"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/958554f2-8f8b-451c-a642-b33481e6408a/results/439875/?format=api",
            "id": 439875,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2c15b347-174a-4f4b-9b61-ceb6c007d965/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/958554f2-8f8b-451c-a642-b33481e6408a/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T120333Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0cd64604159703e9e5b65357145a0c97bd889b0c6716b17303ce5c553bb5e776"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/958554f2-8f8b-451c-a642-b33481e6408a/results/439876/?format=api",
            "id": 439876,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/02fa51ae-07dc-4fbc-876b-9a06e35ce099/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/958554f2-8f8b-451c-a642-b33481e6408a/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T120333Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=17f90ee7177ac9008d876febf6423bdc0cc65116145f013d010229412bc89806"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/958554f2-8f8b-451c-a642-b33481e6408a/results/439877/?format=api",
            "id": 439877,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d0b44829-d99f-4e1b-82ba-e9285854890d/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/958554f2-8f8b-451c-a642-b33481e6408a/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T120333Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6aa6b010d985458c8391f06ac8ffc6e40ff3a9d72d0bdb1a88801c617b632c7c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/958554f2-8f8b-451c-a642-b33481e6408a/results/439878/?format=api",
            "id": 439878,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/12ff6f6d-a2dc-4dab-8599-aa2aeef3d349/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/958554f2-8f8b-451c-a642-b33481e6408a/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T120333Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=525606620e894669408a413f6dcdc942703044138f647b50dba0907e770e4796"
        }
    ]
}