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/334c23ae-0f74-4176-b2bd-e5a75a224b62/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/334c23ae-0f74-4176-b2bd-e5a75a224b62/results/441215/?format=api",
            "id": 441215,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/9eff9271-ae86-4d77-99f3-08df0632c8f0/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/334c23ae-0f74-4176-b2bd-e5a75a224b62/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T045558Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e08f4f7022bfcf48a9975c737dc2ad14df50213c3cd7ecada97047e058dbd753"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/334c23ae-0f74-4176-b2bd-e5a75a224b62/results/441216/?format=api",
            "id": 441216,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/56da5a77-74c6-4523-988f-b8ff196261e5/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/334c23ae-0f74-4176-b2bd-e5a75a224b62/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T045558Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=32e76bbcab66746920b75ffb0dc0303a09b60447ce7492e76c6fe55f7fecac69"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/334c23ae-0f74-4176-b2bd-e5a75a224b62/results/441217/?format=api",
            "id": 441217,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/0581e54f-0062-4192-9334-d6249ccfd1be/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/334c23ae-0f74-4176-b2bd-e5a75a224b62/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T045558Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f7477d55094f07f21f695010a28adb20c3e37afa4d4da7df93021ec1558d2271"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/334c23ae-0f74-4176-b2bd-e5a75a224b62/results/441218/?format=api",
            "id": 441218,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b960a798-2877-4c99-9d7c-a65b65ba8a4f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/334c23ae-0f74-4176-b2bd-e5a75a224b62/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T045558Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a3f3624d9b245923e5f34776bdbd0c35de7489f9260a7588965b2aa641d08f70"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/334c23ae-0f74-4176-b2bd-e5a75a224b62/results/441219/?format=api",
            "id": 441219,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/f10cdac8-a7c6-4281-b7bc-1537cb87fb6c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/334c23ae-0f74-4176-b2bd-e5a75a224b62/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T045558Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b30e1303c163e27fd0529f2992dee782753805e03826954170e20d2704fcaded"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/334c23ae-0f74-4176-b2bd-e5a75a224b62/results/441220/?format=api",
            "id": 441220,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c39f616f-63de-46fb-a409-1ab67fbaafe4/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/334c23ae-0f74-4176-b2bd-e5a75a224b62/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T045558Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=cb79e9f6fb1db53b11b5b491be9695f3c3bd6ab44a08b73413aa2fc51980be3a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/334c23ae-0f74-4176-b2bd-e5a75a224b62/results/441221/?format=api",
            "id": 441221,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/8bd8c8d5-8fdb-463e-975a-4260f445db3c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/334c23ae-0f74-4176-b2bd-e5a75a224b62/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T045558Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5a0c59a9a93a01a8d7aeb480a3cb0a0eb7cd3fea8c302f34c6c67310089ba52c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/334c23ae-0f74-4176-b2bd-e5a75a224b62/results/441222/?format=api",
            "id": 441222,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/e19172ed-d646-4f75-861d-495daec0e05b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/334c23ae-0f74-4176-b2bd-e5a75a224b62/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T045558Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2794e9c428ffe77ecb3e01c4409cee045ebbdd60065dc9f221b1be6e12264cc9"
        }
    ]
}