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/8e7a4ba0-3a98-4770-b4e6-05ff9b7bf95e/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/8e7a4ba0-3a98-4770-b4e6-05ff9b7bf95e/results/434047/?format=api",
            "id": 434047,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/518ef8cb-3020-41b9-9fbe-16830ec4221f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/8e7a4ba0-3a98-4770-b4e6-05ff9b7bf95e/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T120815Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=dcf062762d1c2ec81fb80b384d93e30c949bbb2c027d98138cec19bd3d00e731"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/8e7a4ba0-3a98-4770-b4e6-05ff9b7bf95e/results/434048/?format=api",
            "id": 434048,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/1b20111c-1e39-4f03-ade1-7ff4bc62df78/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/8e7a4ba0-3a98-4770-b4e6-05ff9b7bf95e/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T120815Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=440f4281e9515f01e860e1b2f3573640ae9ea12ba110bcb242d0fec4ebb0f36b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/8e7a4ba0-3a98-4770-b4e6-05ff9b7bf95e/results/434049/?format=api",
            "id": 434049,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4aab423b-f4d0-450a-a765-44baf385a89c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/8e7a4ba0-3a98-4770-b4e6-05ff9b7bf95e/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T120815Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=81efacefa5d1aed82722b9230f83cdd14c857ccbb822ac68978864148e05b22a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/8e7a4ba0-3a98-4770-b4e6-05ff9b7bf95e/results/434050/?format=api",
            "id": 434050,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2cf2d27c-914c-44f1-9885-97ded7f3e6eb/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/8e7a4ba0-3a98-4770-b4e6-05ff9b7bf95e/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T120815Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1b2eef5bad8679912a66770747d9c95903497b499c2a948b32ea41e167c30d89"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/8e7a4ba0-3a98-4770-b4e6-05ff9b7bf95e/results/434051/?format=api",
            "id": 434051,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/800b9e70-2b5f-489a-8cf2-814ec68b1445/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/8e7a4ba0-3a98-4770-b4e6-05ff9b7bf95e/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T120815Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=17f5422dff37b65a202cd8bac3751be0f070f9987fecd54ee149d085fbda1ea3"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/8e7a4ba0-3a98-4770-b4e6-05ff9b7bf95e/results/434052/?format=api",
            "id": 434052,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c03b3b2c-020f-4006-98bb-ffcb799188f9/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/8e7a4ba0-3a98-4770-b4e6-05ff9b7bf95e/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T120815Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e079168340665f5b6e03fe15eeac3ed750c442f5334ed4077833bf2e23ca4166"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/8e7a4ba0-3a98-4770-b4e6-05ff9b7bf95e/results/434053/?format=api",
            "id": 434053,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/e8f6e146-150c-48b8-ad9b-cf2732b84379/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/8e7a4ba0-3a98-4770-b4e6-05ff9b7bf95e/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T120815Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=97071b7832ce5dcb596bd52f929425f43126bd5ab163b6337232c91c6d17304e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/8e7a4ba0-3a98-4770-b4e6-05ff9b7bf95e/results/434054/?format=api",
            "id": 434054,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/ef7221cb-5d48-454a-846d-ca391242c7e6/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/8e7a4ba0-3a98-4770-b4e6-05ff9b7bf95e/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T120815Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=21a2cc5fef61da540acecbb7a1b546033d300e051706d276cb7d65b0c3db64e7"
        }
    ]
}