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/220d2115-4b4d-43ba-8872-7101b2e9a0b7/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/220d2115-4b4d-43ba-8872-7101b2e9a0b7/results/385162/?format=api",
            "id": 385162,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/8e2f6a5f-862b-4629-8189-9ee1fd7f8210/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/220d2115-4b4d-43ba-8872-7101b2e9a0b7/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=b3a5722222b35cdc57590d88634f10de6f2becd2526084e65e07f03f5ce6c549"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/220d2115-4b4d-43ba-8872-7101b2e9a0b7/results/385163/?format=api",
            "id": 385163,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/e8c649d7-8b27-426f-a58b-31532c097d5e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/220d2115-4b4d-43ba-8872-7101b2e9a0b7/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=1dde9e0e474164cb9e382e2de3ac6280702ab4099fae9656b2043155333e5523"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/220d2115-4b4d-43ba-8872-7101b2e9a0b7/results/385164/?format=api",
            "id": 385164,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c08bf31c-00e7-4969-be2f-328cab1be631/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/220d2115-4b4d-43ba-8872-7101b2e9a0b7/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=6a99da6d206b207d06b348603b5e6ed7c9c14b74f385a1c339e75f9d4b460eb2"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/220d2115-4b4d-43ba-8872-7101b2e9a0b7/results/385165/?format=api",
            "id": 385165,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/61dc6946-ec6e-4d46-b41a-8992254573df/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/220d2115-4b4d-43ba-8872-7101b2e9a0b7/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=075e0d46d91c0ea98ccfb5c1d380e06b169993bdb964251cd40bb62c1df5eb22"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/220d2115-4b4d-43ba-8872-7101b2e9a0b7/results/385166/?format=api",
            "id": 385166,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/f1c67206-50d5-4e95-acbf-f5b519eb5df5/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/220d2115-4b4d-43ba-8872-7101b2e9a0b7/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=40abe6e2986bc9ee2034370cbe9ed3229366b4cb3d3cb813a2863f9ff71ad451"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/220d2115-4b4d-43ba-8872-7101b2e9a0b7/results/385167/?format=api",
            "id": 385167,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/21994905-3a4a-4571-aa0d-dd173e425d9a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/220d2115-4b4d-43ba-8872-7101b2e9a0b7/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=eb5611cad1943b9f6b342feb4710d9bf5fa86e92a3dd98b63a9d6d4f77b758ec"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/220d2115-4b4d-43ba-8872-7101b2e9a0b7/results/385168/?format=api",
            "id": 385168,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/0f992823-cc25-4983-bef4-e89cc0964c4a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/220d2115-4b4d-43ba-8872-7101b2e9a0b7/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=1e465ac9f0462af50871f5bccc4041a7aa05e28b4cbbf24c6dc9f658efe805e5"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/220d2115-4b4d-43ba-8872-7101b2e9a0b7/results/385169/?format=api",
            "id": 385169,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/edfc2961-45e2-4c1e-a5d7-d71e399d5f5a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/220d2115-4b4d-43ba-8872-7101b2e9a0b7/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=9db9dc6f7648cd4615cdefaed10a92a219c3c439bda48c156070fcc58410271f"
        }
    ]
}