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/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/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/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/results/449667/?format=api",
            "id": 449667,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/caaa058c-8a63-47c8-b10b-1e16874c7b78/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T101449Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5db783baae8876ea0b4ae02a166976369483c8011e9c1b23baa363f84f7243ee"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/results/449668/?format=api",
            "id": 449668,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/81b972d9-c7b4-4cb0-a6c9-9e8d8aeb169d/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T101449Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=962e3f8f6cd6c5ab3cf0dc36199885927454f8abb9e73b1db75ea665566a6f2b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/results/449669/?format=api",
            "id": 449669,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c0d519c8-ee93-4759-9c0f-1fb04c01e871/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T101449Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ca95b7f43c07479e840b96dbae74e41cc2f2084bd294dc30b35197018a2160b2"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/results/449670/?format=api",
            "id": 449670,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/e92c7882-75cf-45d0-8bed-8830e8c955f0/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T101449Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b782eadde59f2fd01771764ee4767892ce2a13cda35e708586af050893feeef4"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/results/449671/?format=api",
            "id": 449671,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/5c44d838-dd08-45d4-8c56-eb3d8fe08223/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T101449Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=abba53dd8dc444d474935d79963776a91152243f1c5e584adfdd3a6ae970f7e0"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/results/449672/?format=api",
            "id": 449672,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b99d6dd5-5d32-4c81-8c7f-a324b074976e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T101449Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2db587ecaa64ecfb58395a8e1ba4ec5ec21705003b07d50f84156ce26fa4339e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/results/449673/?format=api",
            "id": 449673,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c8f5f461-ac59-48e0-bd03-a5ed34a0b299/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T101449Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=96715d692c55393a75dcfba5873011724cff41a26d8212cc43183a5a63edb586"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/results/449674/?format=api",
            "id": 449674,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/aaf0fd73-6545-469f-843d-e15c71bc152a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T101449Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=256ddce6008b8d5cb04ff623d37091adbd057628d8baf66d0220db0f90186da6"
        }
    ]
}