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/09d0661c-84b9-4e32-a0cc-c093887acd50/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/09d0661c-84b9-4e32-a0cc-c093887acd50/results/440681/?format=api",
            "id": 440681,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2097b916-1c22-4ed3-82bb-53b7e019c991/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/09d0661c-84b9-4e32-a0cc-c093887acd50/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T041944Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=45b887c39df2afe8b0a4629978f072e3cc692f83f57ae2d48aadc2b4ca671b21"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/09d0661c-84b9-4e32-a0cc-c093887acd50/results/440682/?format=api",
            "id": 440682,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c7f9aad6-7673-46c9-93cd-38bb1463e304/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/09d0661c-84b9-4e32-a0cc-c093887acd50/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T041944Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3b92bdedf3d80c5d5e0523816188c8cc663de4aeac6adb291592b11f2bb99763"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/09d0661c-84b9-4e32-a0cc-c093887acd50/results/440683/?format=api",
            "id": 440683,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/e918dcd9-fad2-4dee-a8b0-d6a637d12947/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/09d0661c-84b9-4e32-a0cc-c093887acd50/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T041944Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b8e5a2171a73c7b1dbefef5c0ef9d750634ae3b1241612d4930fe69498e91d68"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/09d0661c-84b9-4e32-a0cc-c093887acd50/results/440684/?format=api",
            "id": 440684,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/00796ab1-eb22-4af9-b1b5-e62a0ef25380/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/09d0661c-84b9-4e32-a0cc-c093887acd50/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T041944Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4158fb69efe8f82c2d95292c5493cf3aea0ace46add7ef01d5e5cc0dfaab431e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/09d0661c-84b9-4e32-a0cc-c093887acd50/results/440685/?format=api",
            "id": 440685,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/df6d9d43-339b-4303-b407-f1606e2a93e0/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/09d0661c-84b9-4e32-a0cc-c093887acd50/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T041944Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f0daae7a942f9bfa5d57fdc361f0011e2d89ce2725fc653e9c7ac4cba53b51b0"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/09d0661c-84b9-4e32-a0cc-c093887acd50/results/440686/?format=api",
            "id": 440686,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c4aaa460-e054-4e2c-83b6-5f2d685073d6/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/09d0661c-84b9-4e32-a0cc-c093887acd50/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T041944Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3b938817a3f3e656def286253445d4bd89c3babdda879fa3f1893380a71f03d9"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/09d0661c-84b9-4e32-a0cc-c093887acd50/results/440687/?format=api",
            "id": 440687,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/7f2d497a-43c1-4351-9e49-c574f97570bc/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/09d0661c-84b9-4e32-a0cc-c093887acd50/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T041944Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=80578d71d6e628aacc0ac262e9b118c320eeb8e836ed6bbb52d35b08c454dcf4"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/09d0661c-84b9-4e32-a0cc-c093887acd50/results/440688/?format=api",
            "id": 440688,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/15b363cf-e5aa-4ffa-aa49-49fe59dc457d/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/09d0661c-84b9-4e32-a0cc-c093887acd50/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T041944Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=fe3f83829a479d9f042731d3f2dbdb514ea4478e7862a1ce8024b100baef4cb0"
        }
    ]
}