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/ef9aa069-ff2f-41cb-996e-e03bf8602dd0/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/ef9aa069-ff2f-41cb-996e-e03bf8602dd0/results/440814/?format=api",
            "id": 440814,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/f229cc50-6c42-47df-9a7e-e3bbb93d150f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ef9aa069-ff2f-41cb-996e-e03bf8602dd0/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T041210Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1f03442c327420a22a6b7e94483e396e6b9bb1714b0c6dc57dcd1d22466fce08"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ef9aa069-ff2f-41cb-996e-e03bf8602dd0/results/440815/?format=api",
            "id": 440815,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/08d0dd00-9d9d-4700-a1d3-a1037d210c6f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ef9aa069-ff2f-41cb-996e-e03bf8602dd0/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T041210Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=af6f93bfbba92510786f5b1b534ae8777ae6d5b2c29f8a78aed6ac7322f70fc6"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ef9aa069-ff2f-41cb-996e-e03bf8602dd0/results/440816/?format=api",
            "id": 440816,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/835e611f-8fde-4879-a93a-8de42171a341/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ef9aa069-ff2f-41cb-996e-e03bf8602dd0/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T041210Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=00f35c04b180bc0292350398223008d88017e8bbb6f24f9f5e559dd9f94bbb86"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ef9aa069-ff2f-41cb-996e-e03bf8602dd0/results/440817/?format=api",
            "id": 440817,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/39e023ff-890c-4bc7-9204-04b713c2f6c9/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ef9aa069-ff2f-41cb-996e-e03bf8602dd0/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T041210Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ccf5841037fdbb8308fb0615cecdf864a7db228c862bbad0c89e22f9e1c2df1b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ef9aa069-ff2f-41cb-996e-e03bf8602dd0/results/440818/?format=api",
            "id": 440818,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/9437a283-c971-4be0-b8fc-92b7ff8c2422/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ef9aa069-ff2f-41cb-996e-e03bf8602dd0/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T041210Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b9777477c4a7795c9e5f158b229941e23e3be739aee675f3947f3c5f3744a9d7"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ef9aa069-ff2f-41cb-996e-e03bf8602dd0/results/440819/?format=api",
            "id": 440819,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2ab00daa-c43d-4b62-b349-5443ae52b5f1/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ef9aa069-ff2f-41cb-996e-e03bf8602dd0/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T041210Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b5d14b860f10635a9783d8d365b7d219cd7226bfb526a5cfdf176bdc072d29f0"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ef9aa069-ff2f-41cb-996e-e03bf8602dd0/results/440820/?format=api",
            "id": 440820,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/913c6806-b64a-4608-b36f-6fc0a42a1962/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ef9aa069-ff2f-41cb-996e-e03bf8602dd0/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T041210Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e79a9fd8decb2e6bbaaf548d5ec3251f0496f8cae8717902dc586a42128f1005"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ef9aa069-ff2f-41cb-996e-e03bf8602dd0/results/440821/?format=api",
            "id": 440821,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c3339476-b3eb-4ba4-8d18-859880b55526/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ef9aa069-ff2f-41cb-996e-e03bf8602dd0/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T041210Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=be7ae50cb3ec831290e5af82e490e16bcb6e09652197857bea1239c126ffa25d"
        }
    ]
}