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/55331a65-c744-4d7c-8fca-4ebc29704523/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/55331a65-c744-4d7c-8fca-4ebc29704523/results/452279/?format=api",
            "id": 452279,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/224eda40-1638-4b5a-83e8-0667a3be9903/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/55331a65-c744-4d7c-8fca-4ebc29704523/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T081124Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=86db1466fdd0315ebb6b471c1b5bba92412fd2e707577e516da7e63e880da2c0"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/55331a65-c744-4d7c-8fca-4ebc29704523/results/452280/?format=api",
            "id": 452280,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/213ee878-c29b-41a3-a1cd-a7efab1d6d71/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/55331a65-c744-4d7c-8fca-4ebc29704523/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T081124Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c780dcc57ccb17b5a3a17588e79c3b063e4992c9092597516f5441e27f020635"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/55331a65-c744-4d7c-8fca-4ebc29704523/results/452281/?format=api",
            "id": 452281,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/577d07de-80d4-48ec-8777-4125dca51dba/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/55331a65-c744-4d7c-8fca-4ebc29704523/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T081124Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3727ab6ea0cf6b22c537438a9ed9f0d7359603f51c53b43f5e4abfcbe53bf68b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/55331a65-c744-4d7c-8fca-4ebc29704523/results/452282/?format=api",
            "id": 452282,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4e2eb9c1-0bc4-4e4f-9495-6a352e8a68d5/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/55331a65-c744-4d7c-8fca-4ebc29704523/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T081124Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f5e8714b56dd5574468818297954443753356b8cd0bcda93217c8a1f2ed82f65"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/55331a65-c744-4d7c-8fca-4ebc29704523/results/452283/?format=api",
            "id": 452283,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d18b0625-61c4-4097-a243-aed51834973e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/55331a65-c744-4d7c-8fca-4ebc29704523/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T081124Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=bcf691703e07d0a9c0be8038366394702facc6499fecf8db303542f773cbf04b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/55331a65-c744-4d7c-8fca-4ebc29704523/results/452284/?format=api",
            "id": 452284,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2344403d-e142-442c-a8ef-fcc813b5eb08/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/55331a65-c744-4d7c-8fca-4ebc29704523/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T081124Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9b08651c597802cdc592a976542907fd3cc6bba9e946ef636b9977f74fd9c54d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/55331a65-c744-4d7c-8fca-4ebc29704523/results/452285/?format=api",
            "id": 452285,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/cf57cfed-583d-4aa4-9e59-c8ca787c52b3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/55331a65-c744-4d7c-8fca-4ebc29704523/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T081124Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0eb52a7784019460190fd729a4097cd3f4bbf79c803dfddb62c7cc7fa37a70bb"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/55331a65-c744-4d7c-8fca-4ebc29704523/results/452286/?format=api",
            "id": 452286,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/968e6a11-4d24-4205-8372-8b179dfb43cf/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/55331a65-c744-4d7c-8fca-4ebc29704523/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T081124Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=094c1b033b62a889d780daaf8fccfbb4ad0f09f24ba6ab40ae39760cf919a74f"
        }
    ]
}