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/6f9ec418-ad43-4df1-85dd-8c0f2370f201/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/6f9ec418-ad43-4df1-85dd-8c0f2370f201/results/441580/?format=api",
            "id": 441580,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/06778946-1f91-4c34-998f-90bfb7c745b2/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010405Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=85541ef69290c22b9e79986b1cfd1ee2165708e237f0c370fd2306cc4e9c08a3"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/results/441581/?format=api",
            "id": 441581,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/85869d80-07fd-48fa-a7f9-182c67a62575/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010405Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=bd9dc12c967f8d1a80d1a8b492059551fafc2bcc8e11dd307d4b2159eab7da1e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/results/441582/?format=api",
            "id": 441582,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/79edaf43-3632-44a1-8dcb-d2af0dcf5b05/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010405Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e836d35aaffee23d809a2ec17e9b9c848b258b44c4d3517bd16f4b5be1165115"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/results/441583/?format=api",
            "id": 441583,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/814f57d2-183e-406c-a153-fe646ff05ce6/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010405Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3a622d431bbf07ffa519e3e643fc3d2861bf9cf909e4aed1f0207c7875da2325"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/results/441584/?format=api",
            "id": 441584,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/49b792ed-9aee-4d7b-b0c7-332bf8c7d8a8/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010405Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0d223ad6edbba60f402edfc32dbcca2302aaa7da1386da983c4caeee5649982d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/results/441585/?format=api",
            "id": 441585,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/e44143ca-87ea-4c18-9455-998d10e534a5/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010405Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e0c43bea1e0dcd35cab6ce4bc46edc495d2dba3b6f14d3fb6b95773d24b49054"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/results/441586/?format=api",
            "id": 441586,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/3f3bfc41-0475-419b-98b5-d7711a5a7db0/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010405Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=675e3ce4f708e92bc332224c611e3f3d0fe1507ad250c2abe8ac336c5cfa5380"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/results/441587/?format=api",
            "id": 441587,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2a03e8eb-46eb-415c-becc-fe2e5bd19b70/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010405Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8b06a4608482199eaf7df7ae0212f8d7f4c3361fffc29876f7ae093badba66c3"
        }
    ]
}