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/4f537e62-4489-4dc1-9d67-13eee1e0965a/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/4f537e62-4489-4dc1-9d67-13eee1e0965a/results/449598/?format=api",
            "id": 449598,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2ecef7c8-3174-4e76-8f3a-83610b9a973b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4f537e62-4489-4dc1-9d67-13eee1e0965a/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T111250Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2c39e0d37ab1f94003cf1ec7328d85b433224bcb58f69ce7ec2563c3c36a697e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4f537e62-4489-4dc1-9d67-13eee1e0965a/results/449599/?format=api",
            "id": 449599,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/dab6554f-23c6-46e8-9f43-bdfd32d900c3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4f537e62-4489-4dc1-9d67-13eee1e0965a/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T111250Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=59c8272a0d0d5e41fcd263630b3e693a947d587f690ca60d4b7718fc9b9d18dc"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4f537e62-4489-4dc1-9d67-13eee1e0965a/results/449600/?format=api",
            "id": 449600,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/6c8b39bd-fffa-4a0a-95fd-886f858f7368/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4f537e62-4489-4dc1-9d67-13eee1e0965a/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T111250Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=33306f71b46cb87932fe8bf5daef0cb41f9855359a37acf56babc0379a5b70a6"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4f537e62-4489-4dc1-9d67-13eee1e0965a/results/449601/?format=api",
            "id": 449601,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/84af3b84-9f54-442f-9dce-10a7fdda8948/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4f537e62-4489-4dc1-9d67-13eee1e0965a/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T111250Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1db270449e89404b88850adcaf95839695606576eed9fc9e90ce0b72b4430976"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4f537e62-4489-4dc1-9d67-13eee1e0965a/results/449602/?format=api",
            "id": 449602,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/e50b9a41-03d4-4f25-9b1d-e0685138873b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4f537e62-4489-4dc1-9d67-13eee1e0965a/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T111250Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d70c3decedc17dc337dafac04f985e951179ede88a1c80a655fe7d5f2735f1ea"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4f537e62-4489-4dc1-9d67-13eee1e0965a/results/449603/?format=api",
            "id": 449603,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/587a6f0d-b5d2-4b58-b299-78b5e470ccc0/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4f537e62-4489-4dc1-9d67-13eee1e0965a/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T111250Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=bd9fde209cb300eb68382198aaa3a6ab2d025249a47bcf803418da78719fb1fe"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4f537e62-4489-4dc1-9d67-13eee1e0965a/results/449604/?format=api",
            "id": 449604,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/18c5a755-f147-4c88-8acb-c433e7301f23/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4f537e62-4489-4dc1-9d67-13eee1e0965a/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T111250Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5e8597910b9b95c7386058a3d4484359f97740179f590da0935766f313495b58"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4f537e62-4489-4dc1-9d67-13eee1e0965a/results/449605/?format=api",
            "id": 449605,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/1d76b938-c7d6-4dea-b10a-033c05461591/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4f537e62-4489-4dc1-9d67-13eee1e0965a/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T111250Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9ae27d4d458b1b6dca05457de719d3206cfca3a44cf69681591d04fbcd2e7488"
        }
    ]
}