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/b7b9155e-5df1-4c47-aa6a-f51a54bbfc81/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/b7b9155e-5df1-4c47-aa6a-f51a54bbfc81/results/263195/?format=api",
            "id": 263195,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": "Water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/e7028d3d-cd47-4dc2-836f-ef6f13a1e975/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b7b9155e-5df1-4c47-aa6a-f51a54bbfc81/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T150046Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8aaf6dd072963543646b5988a6d03758da6bfbe473cbec57b17651496f484713"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b7b9155e-5df1-4c47-aa6a-f51a54bbfc81/results/263196/?format=api",
            "id": 263196,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": "Max water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/89268516-4f97-4f9d-b298-0c98ec60ea96/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b7b9155e-5df1-4c47-aa6a-f51a54bbfc81/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T150046Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5ac9cc28238c0f31bf8b3aa00faa430fec6846a261a0cd798d3719ed68a4f78e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b7b9155e-5df1-4c47-aa6a-f51a54bbfc81/results/263197/?format=api",
            "id": 263197,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": "Flood hazard rating",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/98d2cb86-7482-44da-8379-8e5e8886328d/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b7b9155e-5df1-4c47-aa6a-f51a54bbfc81/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T150046Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a5efac6c64f20c9552741df3ef84199490a794ea50c00935c09bd6bfe1d6033b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b7b9155e-5df1-4c47-aa6a-f51a54bbfc81/results/263198/?format=api",
            "id": 263198,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": "Rate of rise of the water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/0809be86-0bde-4c21-a19b-5a4c23ad9fd3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b7b9155e-5df1-4c47-aa6a-f51a54bbfc81/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T150046Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a4fdb83749fc1e489abe9917c82aaf45f0ba35b86c6d77ccd4c866faad75ef84"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b7b9155e-5df1-4c47-aa6a-f51a54bbfc81/results/263199/?format=api",
            "id": 263199,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": "Water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b2c79f1b-c054-4c51-9579-fcdb1f23a492/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b7b9155e-5df1-4c47-aa6a-f51a54bbfc81/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T150046Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8386e85a797ef85405d1b0f812e8f970e3110b95fba567393a0a2bdea78d976b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b7b9155e-5df1-4c47-aa6a-f51a54bbfc81/results/263200/?format=api",
            "id": 263200,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": "Max water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/cd02f47e-d17d-4dda-9b4a-8763a9c41313/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b7b9155e-5df1-4c47-aa6a-f51a54bbfc81/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T150046Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5f4aa9293deaa839617c831869424889e705bb0513de4f3cc98a4b9ae9157511"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b7b9155e-5df1-4c47-aa6a-f51a54bbfc81/results/263201/?format=api",
            "id": 263201,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": "Max flow velocity",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/311d8be6-564b-4107-94b3-15d55ba59c44/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b7b9155e-5df1-4c47-aa6a-f51a54bbfc81/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T150046Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=44ce797f594cb25103be00d99661c5ebb303efd437d04b547e43e3e6760b6879"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b7b9155e-5df1-4c47-aa6a-f51a54bbfc81/results/263202/?format=api",
            "id": 263202,
            "name": "Rain",
            "code": "rain-quad",
            "description": "Rain",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/70a3a06d-0ca8-4b3b-b4c3-3a529e7928fd/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b7b9155e-5df1-4c47-aa6a-f51a54bbfc81/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T150046Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=63fe809540ee1f74ea9e99a0c9a133fb6c30e69236cfbdaeacc9e8701566ea2d"
        }
    ]
}