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/0c13aab7-36b0-4ae7-a450-7a03aee015bd/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/0c13aab7-36b0-4ae7-a450-7a03aee015bd/results/453543/?format=api",
            "id": 453543,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/55791e63-95cc-4a67-8f98-f63f5f1d2993/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/0c13aab7-36b0-4ae7-a450-7a03aee015bd/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250316%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250316T091057Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=92d892bb861f774dcbeb1485d44c1aa27fe373fa0ac459a5ed2384f9be9da44c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/0c13aab7-36b0-4ae7-a450-7a03aee015bd/results/453544/?format=api",
            "id": 453544,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/75c5d8b2-c1fb-46fa-a5dc-93f263e27b76/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/0c13aab7-36b0-4ae7-a450-7a03aee015bd/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250316%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250316T091057Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f1d50a92c8b4325a1cd87c415ee326a4db899eb7fae75c080c725e7baa76fa40"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/0c13aab7-36b0-4ae7-a450-7a03aee015bd/results/453545/?format=api",
            "id": 453545,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/8e31a4c3-2500-4b3d-80f3-cf64a9a22272/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/0c13aab7-36b0-4ae7-a450-7a03aee015bd/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250316%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250316T091057Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9413172424b14f02b71866401e37d6d2dce608d5c25f3c45a64a1b727023f4c1"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/0c13aab7-36b0-4ae7-a450-7a03aee015bd/results/453546/?format=api",
            "id": 453546,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/9a5f1649-07d2-4ae2-8274-c26a6d34c3ad/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/0c13aab7-36b0-4ae7-a450-7a03aee015bd/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250316%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250316T091057Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=dc00b0bb9603af2c1963c61519c9556fc09ba7455c96f830087c13bba7628dc7"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/0c13aab7-36b0-4ae7-a450-7a03aee015bd/results/453547/?format=api",
            "id": 453547,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/88356125-b0cd-4e34-a42e-9b2f74e577d6/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/0c13aab7-36b0-4ae7-a450-7a03aee015bd/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250316%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250316T091058Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=006ef559f8dc6f954ea30df3b744ae7a1c88432d9007c49586ed17d7635e893a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/0c13aab7-36b0-4ae7-a450-7a03aee015bd/results/453548/?format=api",
            "id": 453548,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/bb0a137a-a806-414e-8253-19d91e1ff079/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/0c13aab7-36b0-4ae7-a450-7a03aee015bd/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250316%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250316T091058Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2b0f9a7bf3aa91c4b5e2ecad55c8f20d5564c992313c37d7469d02d025f67d97"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/0c13aab7-36b0-4ae7-a450-7a03aee015bd/results/453549/?format=api",
            "id": 453549,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/20768243-9781-4b55-ac93-427368dffe2e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/0c13aab7-36b0-4ae7-a450-7a03aee015bd/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250316%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250316T091058Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5d12e89e0414aad5218053eb7b8ab123ee87c229a0bcf0fb7861a6b7b64508db"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/0c13aab7-36b0-4ae7-a450-7a03aee015bd/results/453550/?format=api",
            "id": 453550,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/6503b126-40d0-4dce-ad41-97ad04f7a6ef/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/0c13aab7-36b0-4ae7-a450-7a03aee015bd/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250316%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250316T091058Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=31d2d59dce9f92ee09e0b7b0adae438c3e067f284648c88f113e9916b1ba8719"
        }
    ]
}