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/e36134fc-e96c-4a0b-86c8-d7e028e06db8/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/e36134fc-e96c-4a0b-86c8-d7e028e06db8/results/452191/?format=api",
            "id": 452191,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/6f11705b-4695-4a24-9fe7-a38483aa779c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T065730Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=be4c48de7938356d2130f665e3ca7934a2e66b594534d5143d48fc5995ea9338"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/results/452192/?format=api",
            "id": 452192,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2da69008-0a3b-40b9-aa2c-e02fbb21d970/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T065730Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=03b0a2dde1d5723720b4dda3cda29417f46bac2b7154a1f04b2cf2814597d917"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/results/452193/?format=api",
            "id": 452193,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/9f6ecf32-9a5f-4254-b42a-35c20965552e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T065730Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2632ce8350c9c65bc8052288226ec597daef239ff8b68c64ff3116c417586aaa"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/results/452194/?format=api",
            "id": 452194,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/8690fde9-0da4-4e75-af7e-aa270fa3f9a0/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T065730Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9e48138106b685a754690038c177790f126d2e1432e3eb6453735995815f123f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/results/452195/?format=api",
            "id": 452195,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/e5ce011f-f663-4fd6-9969-f991179ba694/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T065730Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=bdc6d3768a2cda08733872bc3382a2d84a7290dd8e1aa506a4ccc6b07749650f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/results/452196/?format=api",
            "id": 452196,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/e3878393-5592-416e-a042-c1e59c96c256/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T065730Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3c151f64f9a649596cbbc60b34d754613b04a826ce85dfdd21d82d26a18a223c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/results/452197/?format=api",
            "id": 452197,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/3277000e-3b1a-474e-ad89-188c9d788bc1/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T065730Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f367dd2b23e290099e4974404ea39bbf6fa962a6b133c5a2bbc913833fdd3968"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/results/452198/?format=api",
            "id": 452198,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b979ee73-f7c7-4841-812c-dffb1d8c6211/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e36134fc-e96c-4a0b-86c8-d7e028e06db8/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T065730Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d8e18c514bac9047e0edf4c3ceb96f9d639bf746ac7ed0647d9694c312e1ca10"
        }
    ]
}