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/9d3d401d-2c26-4e9c-983c-a13a6e9e3cf7/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/9d3d401d-2c26-4e9c-983c-a13a6e9e3cf7/results/425983/?format=api",
            "id": 425983,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/59700d66-6da5-4e16-956f-8a2ba3e9bf38/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9d3d401d-2c26-4e9c-983c-a13a6e9e3cf7/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T033032Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9dc819680406884c514575815712e0818ac31042852d56716019d79d56c5aa96"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9d3d401d-2c26-4e9c-983c-a13a6e9e3cf7/results/425984/?format=api",
            "id": 425984,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/19e5faf1-151b-49bc-8d2c-635e9479e562/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9d3d401d-2c26-4e9c-983c-a13a6e9e3cf7/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T033032Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=828e460996aef8730c351714d278a0e4a709c9d2eee7969b4f0460a2ed49affe"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9d3d401d-2c26-4e9c-983c-a13a6e9e3cf7/results/425985/?format=api",
            "id": 425985,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/6c75e804-4e1d-4129-b578-cb5ce9e4343a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9d3d401d-2c26-4e9c-983c-a13a6e9e3cf7/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T033032Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3ca0aaf3fd151a04027bdd39e42b2e021ef956e7229643225f343a27b6c52eed"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9d3d401d-2c26-4e9c-983c-a13a6e9e3cf7/results/425986/?format=api",
            "id": 425986,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/05360053-b74d-4b50-aba6-dea688b56eab/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9d3d401d-2c26-4e9c-983c-a13a6e9e3cf7/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T033032Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7be6c6bee7b3b0aacb946d3af3b8eb0f607e23ccb27eaaa96a4cfacf2bb0c4ea"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9d3d401d-2c26-4e9c-983c-a13a6e9e3cf7/results/425987/?format=api",
            "id": 425987,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b9ab06b2-c59e-4568-9c8a-052693db772d/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9d3d401d-2c26-4e9c-983c-a13a6e9e3cf7/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T033032Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f83d2ceaa88f072d01a76659ac788f4709b58005766d5e5d29b6f66979ff1652"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9d3d401d-2c26-4e9c-983c-a13a6e9e3cf7/results/425988/?format=api",
            "id": 425988,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a0124998-b5fd-4e74-9f43-95f89021fa75/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9d3d401d-2c26-4e9c-983c-a13a6e9e3cf7/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T033032Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4a06059473cb49101c5afb5082b1070ad054668dc28a226a74ffe1867e3ae7d4"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9d3d401d-2c26-4e9c-983c-a13a6e9e3cf7/results/425989/?format=api",
            "id": 425989,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4f647214-31e1-4f37-bd18-9ada0cdd2c14/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9d3d401d-2c26-4e9c-983c-a13a6e9e3cf7/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T033032Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5b729da352505800ba5cbb5471f589285b4c2b81d17a8ecedde2b38f411afdb6"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9d3d401d-2c26-4e9c-983c-a13a6e9e3cf7/results/425990/?format=api",
            "id": 425990,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/fece52d0-8677-4e04-b283-e11daa7b8c01/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9d3d401d-2c26-4e9c-983c-a13a6e9e3cf7/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T033032Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2c46d47db9b9d47249b2cc051dd5544081db96117e21a165018b122bfed2bfea"
        }
    ]
}