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/078a981f-c816-4c6c-a584-2c94f6831164/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/078a981f-c816-4c6c-a584-2c94f6831164/results/441258/?format=api",
            "id": 441258,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/f3b21d9e-d43b-4bcb-a6a9-3b075b0e3f60/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/078a981f-c816-4c6c-a584-2c94f6831164/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T004953Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e0e10e2030b340bd0460a776ae4ffa47fda1e2198662ae22e7c9a14a3c742704"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/078a981f-c816-4c6c-a584-2c94f6831164/results/441259/?format=api",
            "id": 441259,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2d603949-d785-4e09-b162-7475212ae07c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/078a981f-c816-4c6c-a584-2c94f6831164/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T004953Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8c8764afffd8ba89d34082d3fed4a3e04ab1bd69b140400898d32fd052b5aa53"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/078a981f-c816-4c6c-a584-2c94f6831164/results/441260/?format=api",
            "id": 441260,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/23235520-2d52-4c33-bfa0-96878e4afbdf/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/078a981f-c816-4c6c-a584-2c94f6831164/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T004953Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d063ab6f08ee5882e1adfe388ea9d7ac9acc6e9378f907aef55a9b128a380993"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/078a981f-c816-4c6c-a584-2c94f6831164/results/441261/?format=api",
            "id": 441261,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/bcce628f-fc27-4543-920d-72d59ae8a8cc/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/078a981f-c816-4c6c-a584-2c94f6831164/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T004953Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=43d7f5010b140b1018821de18c74a5af25ed75a208fb24764429381c8de38ad9"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/078a981f-c816-4c6c-a584-2c94f6831164/results/441262/?format=api",
            "id": 441262,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/5e255796-48dd-495c-ac55-e4e9addbeafd/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/078a981f-c816-4c6c-a584-2c94f6831164/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T004953Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=74e7cb331f3a6953a6caba24cd5936f86e92d28c889d995e7b59f6204b9e4dea"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/078a981f-c816-4c6c-a584-2c94f6831164/results/441263/?format=api",
            "id": 441263,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/facf40eb-851b-4e24-8efe-2dd6e2141fc1/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/078a981f-c816-4c6c-a584-2c94f6831164/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T004953Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3e61cfc0d3aa8eb4bff288df0bb96b9ce65cb6d0d552127b14a5475d9680ddf9"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/078a981f-c816-4c6c-a584-2c94f6831164/results/441264/?format=api",
            "id": 441264,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/e1849011-fad9-4947-a320-ea13ffd4e0ea/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/078a981f-c816-4c6c-a584-2c94f6831164/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T004953Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=643a29bfa18ccee6bbd8a5200492bd7dbd268a242d39a9cb391133d7a7571f24"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/078a981f-c816-4c6c-a584-2c94f6831164/results/441265/?format=api",
            "id": 441265,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/236c0ef7-9289-4046-b2cf-3836ecff49db/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/078a981f-c816-4c6c-a584-2c94f6831164/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T004953Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d9be2879dda80bf472c0973dfc681f66c6c6311541fd0955f156ab5cbf715a0f"
        }
    ]
}