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/57d0ece2-d452-4b52-ae6f-cdaaefb395c6/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/57d0ece2-d452-4b52-ae6f-cdaaefb395c6/results/263355/?format=api",
            "id": 263355,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": "Water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c2a6a4fa-3215-46e8-bb44-954602bddfff/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/57d0ece2-d452-4b52-ae6f-cdaaefb395c6/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T185237Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d5828c77d2b1de6b134f1ebcca7041f83ff88c1af707a8a7e97ad52eff135f7a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/57d0ece2-d452-4b52-ae6f-cdaaefb395c6/results/263356/?format=api",
            "id": 263356,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": "Max water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/0ba5a989-ffcd-49ec-a8ec-b833906a078b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/57d0ece2-d452-4b52-ae6f-cdaaefb395c6/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T185237Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0ab6dfd75dac915e2564ba3ad557374400926835d19334558e012a166d2e86d5"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/57d0ece2-d452-4b52-ae6f-cdaaefb395c6/results/263357/?format=api",
            "id": 263357,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": "Flood hazard rating",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4480e766-46e8-42e7-ac2e-a6b9e568485b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/57d0ece2-d452-4b52-ae6f-cdaaefb395c6/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T185237Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=33ef9071fc8dc8d4e36e31176b4d3fcbabef930496be6716d19dd42002714dc5"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/57d0ece2-d452-4b52-ae6f-cdaaefb395c6/results/263358/?format=api",
            "id": 263358,
            "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/7ff30ac0-5848-4940-864f-38724ec36612/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/57d0ece2-d452-4b52-ae6f-cdaaefb395c6/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T185237Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=fa3c2160596a9b6029e507f337250ff3f60ba0ae0fa7eb1e1fd391d759d27e94"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/57d0ece2-d452-4b52-ae6f-cdaaefb395c6/results/263359/?format=api",
            "id": 263359,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": "Water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/f9b00cce-a9d6-4c5e-8c92-e51b05c81c61/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/57d0ece2-d452-4b52-ae6f-cdaaefb395c6/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T185237Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=318ada906b6e98b350d09f0019f22a3e9220c10ba23be2e2f9bd39aabe2532ed"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/57d0ece2-d452-4b52-ae6f-cdaaefb395c6/results/263360/?format=api",
            "id": 263360,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": "Max water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b2702b84-7d77-48bf-8e4a-d76222fc90c1/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/57d0ece2-d452-4b52-ae6f-cdaaefb395c6/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T185237Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=957b47e8bab70321c5cef20570a3a39e9c0e58d21086dfcf0c4853004ced404c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/57d0ece2-d452-4b52-ae6f-cdaaefb395c6/results/263361/?format=api",
            "id": 263361,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": "Max flow velocity",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/3c05079c-b9a6-4b4f-8e4e-1ab518843086/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/57d0ece2-d452-4b52-ae6f-cdaaefb395c6/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T185237Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f87f8749b94a16a2336c58e526197054bccd7e352058b45b34e92e6a0ea99fb6"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/57d0ece2-d452-4b52-ae6f-cdaaefb395c6/results/263362/?format=api",
            "id": 263362,
            "name": "Rain",
            "code": "rain-quad",
            "description": "Rain",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/29a7799e-3065-4c26-a13c-f1c8208724ad/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/57d0ece2-d452-4b52-ae6f-cdaaefb395c6/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T185237Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=572822838e217dc702b48a49e0afd8e5e906ab464a13f3dad40fbf60bd2509f6"
        }
    ]
}