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/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/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/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/results/448026/?format=api",
            "id": 448026,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/719f529f-9e81-49eb-8e5f-0a5fe4b8ad03/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011751Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8c5f476162c57b0e9f9b9b0e5f46113b5ae7cf9e2000d720c506aee5bdd9218f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/results/448027/?format=api",
            "id": 448027,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/5f07c6c3-fe8b-4c40-9fd0-72c41fd867e4/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011751Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8c2c1a62c5e244b7e5b88ce4c214312d7e8b6d26875d897a0d7009c5facd12b3"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/results/448028/?format=api",
            "id": 448028,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/057080bc-843d-4305-93fb-0aee1e1beb95/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011751Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=96d7c749505dbc5ecc8b41c77f510369d0002438f1b1645f785ae1f5809b7a64"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/results/448029/?format=api",
            "id": 448029,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/32d3f06d-1f1b-4d8e-a4ed-d9550f709676/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011751Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=08bf414ff29278b9bd88b0b5c67c346837e1e270e11213bf6bae4f3a2539f4c3"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/results/448030/?format=api",
            "id": 448030,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/bf4e2b7e-733e-4e28-9697-fd6d7d2e80ad/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011751Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=82478a5b21f841e63a29decaeddcedb031d039fa6e592182034a4fc505bbd583"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/results/448031/?format=api",
            "id": 448031,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c91c2d4e-cc71-4c7a-9dd2-067142e25937/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011751Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2587fe1fbc24be0f4fe7627328eee8913fcaa9040b9a086af7dcada45b3c8f21"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/results/448032/?format=api",
            "id": 448032,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c0b4d732-9a96-49a5-95a9-b1546cebc6d0/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011751Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3f394fb5febf1f547c11cf0e20cd326b8d1fb5b84185b49c61bf6591d69ba9e9"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/results/448033/?format=api",
            "id": 448033,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/350d9e86-0d56-4b27-b630-1bf125a16546/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011751Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f8979d9af784badad887e87226ce9ca053f8b6f6206d0fc40df8f452c58a958f"
        }
    ]
}