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/dc15e84c-00b0-4a4b-852f-5cedcf68db15/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/dc15e84c-00b0-4a4b-852f-5cedcf68db15/results/448848/?format=api",
            "id": 448848,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/47ed72d2-e260-43f6-8fef-1465790ba006/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/dc15e84c-00b0-4a4b-852f-5cedcf68db15/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T151830Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=cdd1823883f5c17a2b3ec86d2e92b4c9b5cb224b9aeb1f538a39f17ab9e9a448"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/dc15e84c-00b0-4a4b-852f-5cedcf68db15/results/448849/?format=api",
            "id": 448849,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/6d05f1b9-f708-4aa5-84ae-b6903710ac70/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/dc15e84c-00b0-4a4b-852f-5cedcf68db15/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T151830Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=86f9e8aaf65ee55ef3f6a0053d0b16a3d68c6323c547476f3f89217572d707c5"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/dc15e84c-00b0-4a4b-852f-5cedcf68db15/results/448850/?format=api",
            "id": 448850,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/cb8a6de4-2c7a-4846-ad4f-45a678917c74/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/dc15e84c-00b0-4a4b-852f-5cedcf68db15/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T151830Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ab65c3a398f9053b7f6149230e5626041e97cf87e716e67a1c154fbf373cbda9"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/dc15e84c-00b0-4a4b-852f-5cedcf68db15/results/448851/?format=api",
            "id": 448851,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/37c334a6-1757-4a32-b9e0-938f3b11da4f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/dc15e84c-00b0-4a4b-852f-5cedcf68db15/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T151830Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=98e9c07113945090699c2dd10020de30eaefa113424fea1eff762da03d42f282"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/dc15e84c-00b0-4a4b-852f-5cedcf68db15/results/448852/?format=api",
            "id": 448852,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d8ce142b-56c6-4160-b60a-2348ac9f9c9a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/dc15e84c-00b0-4a4b-852f-5cedcf68db15/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T151830Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b528ca89d92dba9fa1e63c33f56a0f20d90c815210252842f40eba8a4222e8f5"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/dc15e84c-00b0-4a4b-852f-5cedcf68db15/results/448853/?format=api",
            "id": 448853,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d7c6d93d-b09c-4e7d-95c1-a8934f719071/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/dc15e84c-00b0-4a4b-852f-5cedcf68db15/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T151830Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=692e66eff80055823b6cf54114ef9d7e1804c340f9645b62bfdb46908c9c06a4"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/dc15e84c-00b0-4a4b-852f-5cedcf68db15/results/448854/?format=api",
            "id": 448854,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/1b816918-a161-4390-828c-bd05775c6603/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/dc15e84c-00b0-4a4b-852f-5cedcf68db15/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T151830Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d42087f700151dfcb25edd3dcc522391452462693720490baa4cd89af186448e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/dc15e84c-00b0-4a4b-852f-5cedcf68db15/results/448855/?format=api",
            "id": 448855,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d42a3c73-8b19-43a0-bac8-dcebf97e73e6/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/dc15e84c-00b0-4a4b-852f-5cedcf68db15/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T151830Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f2c9918d4b4c7416131bed930ff3e5af6739133acb6593594e957784ae6cfcb3"
        }
    ]
}