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/b6dcf3e1-35d2-4d82-84da-32462081c98b/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/b6dcf3e1-35d2-4d82-84da-32462081c98b/results/449294/?format=api",
            "id": 449294,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4ff99087-da11-4a17-b995-0fcafc141e2d/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b6dcf3e1-35d2-4d82-84da-32462081c98b/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T161950Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a212c36cfc8da15e7a1c805e9f14238533e7ac5abcd9d7dd53be582227c6d7f6"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b6dcf3e1-35d2-4d82-84da-32462081c98b/results/449295/?format=api",
            "id": 449295,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/03482eb7-76de-417d-843a-479ac6988393/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b6dcf3e1-35d2-4d82-84da-32462081c98b/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T161950Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6d1857190b130e1426892bfecfb1a94e4d24b9f15fac2a82778ee5d18dfbaec3"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b6dcf3e1-35d2-4d82-84da-32462081c98b/results/449296/?format=api",
            "id": 449296,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/52097b39-a4b8-4f75-8dc6-06b273a23d81/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b6dcf3e1-35d2-4d82-84da-32462081c98b/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T161950Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=33d487e476d9b74180a82fe8ea15b480e93116bcf45a9ca7120638435ac96897"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b6dcf3e1-35d2-4d82-84da-32462081c98b/results/449297/?format=api",
            "id": 449297,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/dcb70aa3-f75b-4719-91e8-375f40dee095/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b6dcf3e1-35d2-4d82-84da-32462081c98b/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T161950Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=36540d20f03fc659f32b6f55f6bfbbc7cbf5a788b5b3d9a44e7a0a14b342b9ad"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b6dcf3e1-35d2-4d82-84da-32462081c98b/results/449298/?format=api",
            "id": 449298,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/71c14a65-8b5b-43ef-8e7a-556a9f361403/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b6dcf3e1-35d2-4d82-84da-32462081c98b/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T161950Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b35065cccffaf2ccd5bfd198d1ffb657713ac91bd6b3016305d6b13126dc0697"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b6dcf3e1-35d2-4d82-84da-32462081c98b/results/449299/?format=api",
            "id": 449299,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/6a3e91b3-f52c-4c93-b5bf-adea1ad0fa59/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b6dcf3e1-35d2-4d82-84da-32462081c98b/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T161950Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9a6ff79d165750cb75b82656cf4e0f5e8989856758cbc91f80f1a36d9032c1c5"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b6dcf3e1-35d2-4d82-84da-32462081c98b/results/449300/?format=api",
            "id": 449300,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/cd76c8ba-7387-4d8c-aae9-f48a54ee9b25/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b6dcf3e1-35d2-4d82-84da-32462081c98b/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T161950Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=93a410a77031530ff2275fbca07647a4fa448e745ba58ec210b9107b1944cbda"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b6dcf3e1-35d2-4d82-84da-32462081c98b/results/449301/?format=api",
            "id": 449301,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/01b5f626-033f-4e98-9be2-c2f42da0e6a4/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b6dcf3e1-35d2-4d82-84da-32462081c98b/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T161950Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=104eefb20ed0918960543d1747ae331c696a17506d93b8e9b0eabdae3de3562f"
        }
    ]
}