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/ef61f7f1-0c8f-46e8-a55f-16be545d9f8a/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/ef61f7f1-0c8f-46e8-a55f-16be545d9f8a/results/452295/?format=api",
            "id": 452295,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/5af4f30e-e123-4b20-9986-456f57a7f463/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ef61f7f1-0c8f-46e8-a55f-16be545d9f8a/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T102751Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a33e89706e2c1454ebffb26d5762ee56502f78795194060c0ae7560779ea94fa"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ef61f7f1-0c8f-46e8-a55f-16be545d9f8a/results/452296/?format=api",
            "id": 452296,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d41f4063-f157-40cf-8a57-0907d20448fd/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ef61f7f1-0c8f-46e8-a55f-16be545d9f8a/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T102751Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2eab3b2af8c26e047bd35535fbc27941784778d2e029ef06ac3bafde81383f99"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ef61f7f1-0c8f-46e8-a55f-16be545d9f8a/results/452297/?format=api",
            "id": 452297,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4ed8f2ef-6279-4a75-9f51-cf40e541e45a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ef61f7f1-0c8f-46e8-a55f-16be545d9f8a/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T102751Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=034d98b37daef0ae76d0fe29f850d05f689aa9f55e4f3f6594dba00834a2786f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ef61f7f1-0c8f-46e8-a55f-16be545d9f8a/results/452298/?format=api",
            "id": 452298,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/7b57a8aa-3f19-4522-a7e0-0d4cf3df1184/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ef61f7f1-0c8f-46e8-a55f-16be545d9f8a/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T102752Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=555a7166926600796d29db83df05554fe9edc4f7ee32de03d6a6893404d60e0c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ef61f7f1-0c8f-46e8-a55f-16be545d9f8a/results/452299/?format=api",
            "id": 452299,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a0727ed3-b9a1-4c47-bc12-48af01b3bdad/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ef61f7f1-0c8f-46e8-a55f-16be545d9f8a/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T102752Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0d29f41c50e48f22a51d3e20f8f7db071ffa50cd85483a6c438533ff04c9bca9"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ef61f7f1-0c8f-46e8-a55f-16be545d9f8a/results/452300/?format=api",
            "id": 452300,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/08641dc0-f3ed-4e0a-bc7f-757b2a15b2ce/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ef61f7f1-0c8f-46e8-a55f-16be545d9f8a/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T102752Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9d4c1b744f2184f6ddf4beea9467b7bfbda6a6dda2cb4681a3803b756ebf062e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ef61f7f1-0c8f-46e8-a55f-16be545d9f8a/results/452301/?format=api",
            "id": 452301,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/6d712513-cef4-4c54-84c5-16364bd6a523/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ef61f7f1-0c8f-46e8-a55f-16be545d9f8a/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T102752Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e8699dc5fcc328c84a7eb8e71f7ecea6029a94c246bd58ed09e1127eda517538"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ef61f7f1-0c8f-46e8-a55f-16be545d9f8a/results/452302/?format=api",
            "id": 452302,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a79e7a41-b0b8-4142-a370-7d6f4e5d4f33/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ef61f7f1-0c8f-46e8-a55f-16be545d9f8a/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T102752Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=df2f25ab02ce80b19dd95d8716d0fc862bcfea4f9ea14fa0d33b2610deddcea2"
        }
    ]
}