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/e4f63032-4d58-44ef-9fc5-697c6e5ee21f/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/e4f63032-4d58-44ef-9fc5-697c6e5ee21f/results/263083/?format=api",
            "id": 263083,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": "Water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/bae0e594-46af-4d85-904e-c923a39c8fe0/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e4f63032-4d58-44ef-9fc5-697c6e5ee21f/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T133650Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f02070dbe17fd447d3b305759a38f457405fa035b2c06761786c77b2e654f0cc"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e4f63032-4d58-44ef-9fc5-697c6e5ee21f/results/263084/?format=api",
            "id": 263084,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": "Max water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/29ce63a0-f8c4-4ad6-a855-11306121a1f6/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e4f63032-4d58-44ef-9fc5-697c6e5ee21f/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T133650Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=78fe8cba123c15b32ce645dd6b8c91c48cfa06e5557d7d532ed1138dc898ed73"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e4f63032-4d58-44ef-9fc5-697c6e5ee21f/results/263085/?format=api",
            "id": 263085,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": "Flood hazard rating",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/819aa9fb-96b7-4ab2-a8ec-dcd9794d996a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e4f63032-4d58-44ef-9fc5-697c6e5ee21f/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T133650Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1c635facffd8fabedcc94341460c827d848e71e2113b4d9e50f2f79b9ab8902c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e4f63032-4d58-44ef-9fc5-697c6e5ee21f/results/263086/?format=api",
            "id": 263086,
            "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/4f06d7af-3fa8-4ddf-9a03-5a6f35514078/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e4f63032-4d58-44ef-9fc5-697c6e5ee21f/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T133650Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=11dec1a7831756b3809df1004494cc9d256f7154f7c5e9cbade6b7228944683f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e4f63032-4d58-44ef-9fc5-697c6e5ee21f/results/263087/?format=api",
            "id": 263087,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": "Water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c346a63b-1eaa-4013-b746-53af43a13b7b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e4f63032-4d58-44ef-9fc5-697c6e5ee21f/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T133650Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=99688d255d03551caa59948afd15b8520a46af2b9475de97714e9fd271ec05ca"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e4f63032-4d58-44ef-9fc5-697c6e5ee21f/results/263088/?format=api",
            "id": 263088,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": "Max water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/5be124eb-1a0a-4fa2-a44a-3487120beab7/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e4f63032-4d58-44ef-9fc5-697c6e5ee21f/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T133650Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2d3ecc3a5d9decece9890b08025e27fdb879d5d2a7d43bc3785886eba7af1a48"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e4f63032-4d58-44ef-9fc5-697c6e5ee21f/results/263089/?format=api",
            "id": 263089,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": "Max flow velocity",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/34f5a985-075a-4420-baf1-ce0ca8f86289/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e4f63032-4d58-44ef-9fc5-697c6e5ee21f/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T133650Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=152aa1132c0b324bcc9fb699a7ceed11ecb53ccd9acf91fd334fdeb96309b6ea"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e4f63032-4d58-44ef-9fc5-697c6e5ee21f/results/263090/?format=api",
            "id": 263090,
            "name": "Rain",
            "code": "rain-quad",
            "description": "Rain",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b10feddd-3ad0-4866-af04-d35277029932/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e4f63032-4d58-44ef-9fc5-697c6e5ee21f/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T133650Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=bb0d9e8af14b4862a6d52fe92c2b8126aa9bed8a57580c9554c97d28e98d5e0c"
        }
    ]
}