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/94b50294-3a0f-4d0b-a642-f8ca4b029b44/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/94b50294-3a0f-4d0b-a642-f8ca4b029b44/results/263391/?format=api",
            "id": 263391,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": "Water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/82efb462-2c95-46e4-98c1-ec02f8debaa3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/94b50294-3a0f-4d0b-a642-f8ca4b029b44/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010609Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=02a5e17b0fc9b6e34f8d7da0f5d3173206e59f7ce10d57aa416e0ea79d757ec5"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/94b50294-3a0f-4d0b-a642-f8ca4b029b44/results/263392/?format=api",
            "id": 263392,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": "Max water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/ff432930-0708-499d-a150-4986ff412495/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/94b50294-3a0f-4d0b-a642-f8ca4b029b44/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010609Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=93380bbbb067dd9816451a02e2b2771cb61e1580f23515c757e4551fd34e06a1"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/94b50294-3a0f-4d0b-a642-f8ca4b029b44/results/263393/?format=api",
            "id": 263393,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": "Flood hazard rating",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/af2185fa-9e31-4652-884a-19864924af15/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/94b50294-3a0f-4d0b-a642-f8ca4b029b44/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010609Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=23ec417026fb53367ec015d829559950b725cbcf1949b166281b9d47afa6bb8d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/94b50294-3a0f-4d0b-a642-f8ca4b029b44/results/263394/?format=api",
            "id": 263394,
            "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/0678d6f0-4b44-400e-b73f-0bb3dd7cf8dd/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/94b50294-3a0f-4d0b-a642-f8ca4b029b44/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010609Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=332f21f3ca7daec3b139c1441397d263ced9d1b2c418c3008d68beaf5a5e7258"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/94b50294-3a0f-4d0b-a642-f8ca4b029b44/results/263395/?format=api",
            "id": 263395,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": "Water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/404a639a-9205-46be-a311-d8efaba0830c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/94b50294-3a0f-4d0b-a642-f8ca4b029b44/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010609Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=df0725e72e07ddd07e0297f34ff92601887009dbdb644cfb35196654d3bbba9d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/94b50294-3a0f-4d0b-a642-f8ca4b029b44/results/263396/?format=api",
            "id": 263396,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": "Max water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/cf85bc76-c15c-41b6-92e4-74863109d40b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/94b50294-3a0f-4d0b-a642-f8ca4b029b44/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010609Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=dcb780517de4bd901f1b5b70c2f9690de5ec858ffd79d3e5852297b151c66174"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/94b50294-3a0f-4d0b-a642-f8ca4b029b44/results/263397/?format=api",
            "id": 263397,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": "Max flow velocity",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/5f4ea41f-3773-420d-b735-3ac8003ac32c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/94b50294-3a0f-4d0b-a642-f8ca4b029b44/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010609Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b1ebc145042fb756faa497eea0ecffb6ece2a6b32e8a63522ca82a05cefb7b0a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/94b50294-3a0f-4d0b-a642-f8ca4b029b44/results/263398/?format=api",
            "id": 263398,
            "name": "Rain",
            "code": "rain-quad",
            "description": "Rain",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/13fc4a64-3708-45bf-8824-c7917b8048ac/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/94b50294-3a0f-4d0b-a642-f8ca4b029b44/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010609Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f9490b7c0abebb9053c45f5873be255cd7078ceb329547d52ebd9dec3bfedd76"
        }
    ]
}