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/e590d9ea-3c4d-4bd2-b679-6916275aa5bf/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/e590d9ea-3c4d-4bd2-b679-6916275aa5bf/results/263039/?format=api",
            "id": 263039,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": "Water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/7890c254-7c35-43e3-a0af-b3e638a4171c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e590d9ea-3c4d-4bd2-b679-6916275aa5bf/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T200551Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8d0ce208dbb43c203d52709f0b29f2b091d5c335eb82001ff89551dae5b69de0"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e590d9ea-3c4d-4bd2-b679-6916275aa5bf/results/263040/?format=api",
            "id": 263040,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": "Max water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/856c8405-1809-4924-a6fe-e1469ed03712/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e590d9ea-3c4d-4bd2-b679-6916275aa5bf/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T200551Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8eb4e5e7b22db934fa1c44f84c8ba3bbc37595149075111da021dbd998321b0a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e590d9ea-3c4d-4bd2-b679-6916275aa5bf/results/263041/?format=api",
            "id": 263041,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": "Flood hazard rating",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/58ab5f18-9647-40ed-855f-5409f90af137/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e590d9ea-3c4d-4bd2-b679-6916275aa5bf/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T200551Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8d670686165e73a5a73a7d495f24b075297fed42b3d8e8089cfa6d8dcd128cf5"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e590d9ea-3c4d-4bd2-b679-6916275aa5bf/results/263042/?format=api",
            "id": 263042,
            "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/7ae2b528-f37d-46a9-8e2f-3d573a74f36d/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e590d9ea-3c4d-4bd2-b679-6916275aa5bf/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T200551Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6c895cff8469659c64c625835d07caa38e7ed3bd18908790f1f059ba49374d65"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e590d9ea-3c4d-4bd2-b679-6916275aa5bf/results/263043/?format=api",
            "id": 263043,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": "Water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/7aa64587-eea6-4aef-898b-422881f76360/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e590d9ea-3c4d-4bd2-b679-6916275aa5bf/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T200551Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a43149c4e8b9e5da516d9dc3d57da473543c5bc2a62571e959e5c93f8eb50cd0"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e590d9ea-3c4d-4bd2-b679-6916275aa5bf/results/263044/?format=api",
            "id": 263044,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": "Max water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/cb563b61-2b88-44c6-9f5b-76ed26278fee/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e590d9ea-3c4d-4bd2-b679-6916275aa5bf/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T200551Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d8d3e57f607bc8733d3855760ed69be8567bb87d09af83da26759b44313b2e95"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e590d9ea-3c4d-4bd2-b679-6916275aa5bf/results/263045/?format=api",
            "id": 263045,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": "Max flow velocity",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/079ae97f-741c-432b-ade6-16cf0bb139a5/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e590d9ea-3c4d-4bd2-b679-6916275aa5bf/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T200551Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5246edb6dfd01507616896476a9cbb9bcaaaaa58f3a0243baea97f34a10200c5"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e590d9ea-3c4d-4bd2-b679-6916275aa5bf/results/263046/?format=api",
            "id": 263046,
            "name": "Rain",
            "code": "rain-quad",
            "description": "Rain",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/63c808c4-5a99-41d7-b020-23dc0c661b79/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e590d9ea-3c4d-4bd2-b679-6916275aa5bf/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T200551Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=83c407c45e1110f507a4526bc4175a56aae5589626b2c8649564fd4079268acc"
        }
    ]
}