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/5ce1ebf1-59f5-4adf-8673-8c9cdd0dcc88/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/5ce1ebf1-59f5-4adf-8673-8c9cdd0dcc88/results/500106/?format=api",
            "id": 500106,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/52ccb28f-3732-4e81-b83e-743ff06bf3fb/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5ce1ebf1-59f5-4adf-8673-8c9cdd0dcc88/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T140705Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ca6d38cc0455194a0389489152f9eed90f64e25354bb8223202ad087d8d6a861"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5ce1ebf1-59f5-4adf-8673-8c9cdd0dcc88/results/500107/?format=api",
            "id": 500107,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/f53f9411-cb3d-4c25-899e-4ce792359350/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5ce1ebf1-59f5-4adf-8673-8c9cdd0dcc88/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T140705Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=41933e8ef8b3767e268b412e2c351ecca0b693f188716075a088874339b6bffd"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5ce1ebf1-59f5-4adf-8673-8c9cdd0dcc88/results/500108/?format=api",
            "id": 500108,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/39654b4c-8996-4c0a-9fa2-6b832e7f1278/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5ce1ebf1-59f5-4adf-8673-8c9cdd0dcc88/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T140705Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5475b97c1a1a1f48e8a10eff4cacb78cc18484e2005127330d82ff4a91b1d595"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5ce1ebf1-59f5-4adf-8673-8c9cdd0dcc88/results/500109/?format=api",
            "id": 500109,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2e395746-f247-4af9-a1c4-ddc5cf92430c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5ce1ebf1-59f5-4adf-8673-8c9cdd0dcc88/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T140705Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=cfabfcf1d16583d01cfdb9ca6d354cff3e79c57363a2346d2deff15eb78ba41d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5ce1ebf1-59f5-4adf-8673-8c9cdd0dcc88/results/500110/?format=api",
            "id": 500110,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b567643c-8117-4731-8e75-c2c00df3de32/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5ce1ebf1-59f5-4adf-8673-8c9cdd0dcc88/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T140705Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=aa414938e5e96140a90067cc35a7b257d103f7af7577c774420b3b59564f9696"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5ce1ebf1-59f5-4adf-8673-8c9cdd0dcc88/results/500111/?format=api",
            "id": 500111,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/fe151e5f-da3e-4ab7-84e1-76364ab0cc68/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5ce1ebf1-59f5-4adf-8673-8c9cdd0dcc88/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T140705Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=468fd3f98f16aa2d13d1816412874bc8c30db6ff73f9bef0a766b63bf644fbd9"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5ce1ebf1-59f5-4adf-8673-8c9cdd0dcc88/results/500112/?format=api",
            "id": 500112,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d248eeac-81aa-461e-9a86-5406c7f2a636/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5ce1ebf1-59f5-4adf-8673-8c9cdd0dcc88/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T140705Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=68f0e72d27a4dd44aa848981e4d1b39a3196e2e41a5edef688e74a7a395e5757"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5ce1ebf1-59f5-4adf-8673-8c9cdd0dcc88/results/500113/?format=api",
            "id": 500113,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/71446d90-0d2c-45fb-9dae-dae277d2b0a9/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5ce1ebf1-59f5-4adf-8673-8c9cdd0dcc88/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T140705Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=198f7332b43e737e22d3008c0e3de72739a4c76389085c34d783b46342fc58ce"
        }
    ]
}