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/69d0f39b-cac2-4af4-8fb5-b3d59308bda4/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/69d0f39b-cac2-4af4-8fb5-b3d59308bda4/results/440825/?format=api",
            "id": 440825,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/3c18b93e-7134-46b7-9f95-dabf7f70ffb8/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/69d0f39b-cac2-4af4-8fb5-b3d59308bda4/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T003337Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=47925e45f0c5190f37246bb048be2b0b046761ba01d0b68d16527d5ee7ef41b3"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/69d0f39b-cac2-4af4-8fb5-b3d59308bda4/results/440826/?format=api",
            "id": 440826,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4ae94ac4-b7b8-4a77-9620-ab461339c79f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/69d0f39b-cac2-4af4-8fb5-b3d59308bda4/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T003337Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ee53dff6d342b5ba42ca9a08629eb224f3dd74d89695ae99645698fa8436837e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/69d0f39b-cac2-4af4-8fb5-b3d59308bda4/results/440827/?format=api",
            "id": 440827,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a1b18a13-12ce-430e-86a1-e303552c88ec/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/69d0f39b-cac2-4af4-8fb5-b3d59308bda4/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T003337Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e34cd8cecd96f7178ccf73a5b8f08d651e89452eb1e0e3eec9b7e76165464e88"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/69d0f39b-cac2-4af4-8fb5-b3d59308bda4/results/440828/?format=api",
            "id": 440828,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/38531ac8-59d3-4a93-b4a3-7722acaa094d/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/69d0f39b-cac2-4af4-8fb5-b3d59308bda4/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T003337Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ade915b7a8f4875f8c6fea42ca9a274bc10d933a32e458a3beea4d170efc7487"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/69d0f39b-cac2-4af4-8fb5-b3d59308bda4/results/440829/?format=api",
            "id": 440829,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/9f6baa4a-ed66-42b5-af3f-5274e454245b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/69d0f39b-cac2-4af4-8fb5-b3d59308bda4/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T003337Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=da8aad8100b595a4c01147a7e94e2a4b77536d78fb47b150aa08a0dc90c489cb"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/69d0f39b-cac2-4af4-8fb5-b3d59308bda4/results/440830/?format=api",
            "id": 440830,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a3058c51-91d9-4027-807e-2e8be00243fd/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/69d0f39b-cac2-4af4-8fb5-b3d59308bda4/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T003337Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=100dd5f11d5aaacff2cea484fb401a436b9cb5371d9eda193e26c06dbc5ef9ae"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/69d0f39b-cac2-4af4-8fb5-b3d59308bda4/results/440831/?format=api",
            "id": 440831,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/34e3b0ec-1f12-4924-bb91-9bb24e9354f4/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/69d0f39b-cac2-4af4-8fb5-b3d59308bda4/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T003337Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7d325f401fa65592a179b9c1467d87dabb993bf889cac32a06c06460643c3166"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/69d0f39b-cac2-4af4-8fb5-b3d59308bda4/results/440832/?format=api",
            "id": 440832,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/855aeeb6-0135-46d1-9841-d62482adfcf5/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/69d0f39b-cac2-4af4-8fb5-b3d59308bda4/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T003337Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=dd809e40cdc71b74c663b9752d6704ffcb3b3286daacdf8f54255ee10a06f241"
        }
    ]
}