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/1c54cb29-a4a4-4fa8-8acd-15bfcf68aa6b/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/1c54cb29-a4a4-4fa8-8acd-15bfcf68aa6b/results/448801/?format=api",
            "id": 448801,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2bf7d8fc-8fcd-4fc1-8249-0fb9bb007383/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1c54cb29-a4a4-4fa8-8acd-15bfcf68aa6b/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191927Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7a66cd7413f5169a9f8e92b02b161339589fa36c8ad63a4387b5ff9d3d7dd445"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1c54cb29-a4a4-4fa8-8acd-15bfcf68aa6b/results/448802/?format=api",
            "id": 448802,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/8c109e66-b8c7-4708-ba6d-225411532939/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1c54cb29-a4a4-4fa8-8acd-15bfcf68aa6b/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191927Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=84e206998c0726d48bee2fe8ccaa5844cb85f548420fb952889e71b26d7af8b5"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1c54cb29-a4a4-4fa8-8acd-15bfcf68aa6b/results/448803/?format=api",
            "id": 448803,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b1c4d816-dc16-4ecd-9e2b-97c2009e63ba/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1c54cb29-a4a4-4fa8-8acd-15bfcf68aa6b/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191927Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d7c9e66660102f592ce333c94c5eaf5e5b636c84329cbeb9aa1449e7b2afbbb9"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1c54cb29-a4a4-4fa8-8acd-15bfcf68aa6b/results/448804/?format=api",
            "id": 448804,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/8f969ec8-8711-4ace-ae3f-c99eab414e3a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1c54cb29-a4a4-4fa8-8acd-15bfcf68aa6b/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191927Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=84832501764a42a64fca0e5e277ce8c8fe6f0f6152657a625f40596d3f9dfdd5"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1c54cb29-a4a4-4fa8-8acd-15bfcf68aa6b/results/448805/?format=api",
            "id": 448805,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/dd4275a2-3c56-4c12-bc27-ca865f0aa8d2/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1c54cb29-a4a4-4fa8-8acd-15bfcf68aa6b/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191927Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=92621ef18aa73cd3f6004103fe36c7f68b79a4cf0cab2abbdbb28fbf99b4e8a7"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1c54cb29-a4a4-4fa8-8acd-15bfcf68aa6b/results/448806/?format=api",
            "id": 448806,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/7630e236-6faf-4c86-8fce-1fd41955695e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1c54cb29-a4a4-4fa8-8acd-15bfcf68aa6b/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191927Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=739758493be759c12733f3f6b1da84ec11731d9aef907f4db10feee0ea33eece"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1c54cb29-a4a4-4fa8-8acd-15bfcf68aa6b/results/448807/?format=api",
            "id": 448807,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/e4664131-e7f3-4416-adc4-b05f2c966512/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1c54cb29-a4a4-4fa8-8acd-15bfcf68aa6b/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191927Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3f4f0c14177fb8037e2b4d0b6d6a5333da26086fcd148481bd0edc8017530296"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1c54cb29-a4a4-4fa8-8acd-15bfcf68aa6b/results/448808/?format=api",
            "id": 448808,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2c86e6b1-b197-41b5-89d1-560321b147e0/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1c54cb29-a4a4-4fa8-8acd-15bfcf68aa6b/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191927Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=59fb6426e5c78fb8608d31a7eefc43bd3a584d1ed83f06ae531d8c13c00734d5"
        }
    ]
}