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/2bcdf88d-1426-414e-a8d3-242a476cc2ab/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/2bcdf88d-1426-414e-a8d3-242a476cc2ab/results/440798/?format=api",
            "id": 440798,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4cd80902-6a0f-452f-8e49-574798e060f8/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2bcdf88d-1426-414e-a8d3-242a476cc2ab/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T002037Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0808172ab5b74be130d620dc53f29b1171eec642dfbdc299cf644051c93e51aa"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2bcdf88d-1426-414e-a8d3-242a476cc2ab/results/440799/?format=api",
            "id": 440799,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/1986ab00-b7df-4c86-a4ea-cea254fa4a83/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2bcdf88d-1426-414e-a8d3-242a476cc2ab/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T002037Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=26514a84890d61ea35178dbb95a5ec91f9b70f55e66b0e7d8a3414c74fc98e76"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2bcdf88d-1426-414e-a8d3-242a476cc2ab/results/440800/?format=api",
            "id": 440800,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/f4227789-c5ca-4097-8021-0cbc6d14f10d/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2bcdf88d-1426-414e-a8d3-242a476cc2ab/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T002037Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9c46e70d51afbbd7a7a969cb16c2f2c774ceb485b5b2253c5b4255ced03793ed"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2bcdf88d-1426-414e-a8d3-242a476cc2ab/results/440801/?format=api",
            "id": 440801,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a210c49a-2ed1-47c1-bbf2-cbf8535219f7/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2bcdf88d-1426-414e-a8d3-242a476cc2ab/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T002037Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ee3602f4ed4bea2f77bcb9427c01c067787f16aae365406a25f6041a1da6c8ff"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2bcdf88d-1426-414e-a8d3-242a476cc2ab/results/440802/?format=api",
            "id": 440802,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/8bb5eb47-c909-4f09-beaa-a8a2bc82fc51/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2bcdf88d-1426-414e-a8d3-242a476cc2ab/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T002037Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=eff5de439cb8687ea94abc2b2abe791350aacaae59007d2a5d4bc1dfbe518653"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2bcdf88d-1426-414e-a8d3-242a476cc2ab/results/440803/?format=api",
            "id": 440803,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a531bb44-5391-40b6-a30f-15c2378ff7bd/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2bcdf88d-1426-414e-a8d3-242a476cc2ab/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T002037Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=37ac784d3ad70ad00f04705c4b14895f11a7893429eb444311c4e86ed041aa9b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2bcdf88d-1426-414e-a8d3-242a476cc2ab/results/440804/?format=api",
            "id": 440804,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c8456543-9050-4513-ad63-3856d407be23/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2bcdf88d-1426-414e-a8d3-242a476cc2ab/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T002037Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4d1c059073af07205d220d6ba00bc13c03a6daaeb9be541374178fc2d89c6a0c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2bcdf88d-1426-414e-a8d3-242a476cc2ab/results/440805/?format=api",
            "id": 440805,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/8381ea54-9bad-4bcc-844f-35d2a02d61ab/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2bcdf88d-1426-414e-a8d3-242a476cc2ab/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T002037Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a3b91b43f771fa94cfca1a39f408870fa1abf0032cb7e863023f137ba9711543"
        }
    ]
}