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/67f113c7-bfad-4129-a26b-62a600da4a7e/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/67f113c7-bfad-4129-a26b-62a600da4a7e/results/440806/?format=api",
            "id": 440806,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d253c937-7b59-4acf-9bf0-216c393f317a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/67f113c7-bfad-4129-a26b-62a600da4a7e/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T082801Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8ad1a44029734e6eff98c0672d1e2d825f34a1e968270b359803f189798c1315"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/67f113c7-bfad-4129-a26b-62a600da4a7e/results/440807/?format=api",
            "id": 440807,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/6b6d98f8-b584-4980-9914-68d9b674bfa8/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/67f113c7-bfad-4129-a26b-62a600da4a7e/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T082801Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f26bab596dc25cc6fe9df30989756a100a8278ede8aba546defba05643e062e3"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/67f113c7-bfad-4129-a26b-62a600da4a7e/results/440808/?format=api",
            "id": 440808,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/1d92cb3a-9571-43b5-850c-f58511b7a8f3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/67f113c7-bfad-4129-a26b-62a600da4a7e/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T082801Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=70edd010e1e9c9fd6f977ed44a6b029dfa422a9f4cdbec68c91b2cfadec95389"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/67f113c7-bfad-4129-a26b-62a600da4a7e/results/440809/?format=api",
            "id": 440809,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/33854ade-56e6-4221-a57b-19b8acaf09c1/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/67f113c7-bfad-4129-a26b-62a600da4a7e/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T082801Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4c26753eac686538b76780fff4a56290b8dabb4a11d2540481f309af14ec5418"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/67f113c7-bfad-4129-a26b-62a600da4a7e/results/440810/?format=api",
            "id": 440810,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c22a4b14-ad7e-4cc2-a6c8-cbe1af57f260/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/67f113c7-bfad-4129-a26b-62a600da4a7e/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T082801Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5114e383d7a3a538156b4e5662e8234bb638dac424d0385c03937c731a5b45cd"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/67f113c7-bfad-4129-a26b-62a600da4a7e/results/440811/?format=api",
            "id": 440811,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c36fca20-b54c-45a8-b1e1-357a30a95adf/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/67f113c7-bfad-4129-a26b-62a600da4a7e/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T082801Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e63c677eda227e0120da01a4f1e15f7a9d627e720b33ca08d1a26d31cc5e36f5"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/67f113c7-bfad-4129-a26b-62a600da4a7e/results/440812/?format=api",
            "id": 440812,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/9560d004-8752-40f6-8d54-674bf8c44390/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/67f113c7-bfad-4129-a26b-62a600da4a7e/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T082801Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7ccd14c2a5d4ba11a22126f38750bef29c84e4ee3b7242622a87d7d750b388ab"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/67f113c7-bfad-4129-a26b-62a600da4a7e/results/440813/?format=api",
            "id": 440813,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/243bb0c5-8532-4dcd-a558-d32737068e97/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/67f113c7-bfad-4129-a26b-62a600da4a7e/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T082801Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=338395c33722d07c245cd5efb1f577bff7930f48c2c7db99b65ed95256fc98d4"
        }
    ]
}