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/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/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/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/results/440165/?format=api",
            "id": 440165,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d5804a39-3cc8-49ee-8a7d-0cf0526b78ea/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T000538Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=acfc1e256bf4018a69ae4c9480317fe0d90a2710e79c7fcc29cb0cb8b28879ed"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/results/440166/?format=api",
            "id": 440166,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2751e54e-ef5c-4299-8f48-34f06dd50b62/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T000538Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d2912ea80f7557994c02808b17d29d64b2f9fd84167ec97d69296a1c20c68a54"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/results/440167/?format=api",
            "id": 440167,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/46ca8f39-3a7c-4cc9-b94e-e2e7c97bd544/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T000538Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ecbbae41e9572cf09c808dcc13584e8ea3b2f6f4b7756e13e49d5d75730d543c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/results/440168/?format=api",
            "id": 440168,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/88d94d69-3072-4811-96f9-aa0f65a9050b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T000538Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6e392a53a7dc3a83f1a9964daf089f85ab54d32366dd029eb6694387ffe15d22"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/results/440169/?format=api",
            "id": 440169,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/bd09e45e-9cd0-4f62-a4d4-6ce3d677ccbb/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T000538Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f6620836b225186c7c36a9a148d7c5678a35f5fc4a8d17a0fc68b8ebe5ab2542"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/results/440170/?format=api",
            "id": 440170,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/611a3acb-fcd3-43e6-b940-71a36d01ad5f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T000538Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2101a584c0ef1360dff221bc39ee69661cf8c39af0c948ae8ab8dc4056fb0f8a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/results/440171/?format=api",
            "id": 440171,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c8594997-6dce-4453-b833-2a0b763e4dcd/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T000538Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1db3ff8988189a9ad502ea62023b57063b6dabb0b37dfae702a1ef896ec899e8"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/results/440172/?format=api",
            "id": 440172,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/836b9b72-3f5f-4f66-9596-80b35bdf1c00/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T000538Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a7fd86d34017ef6bb4e1a4241a84f6880ccfbd0216544acaaa97c0bd0dd3f6fe"
        }
    ]
}