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/773499fa-69c4-4687-b166-c0c4ed2e6c27/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/773499fa-69c4-4687-b166-c0c4ed2e6c27/results/263147/?format=api",
            "id": 263147,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": "Water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/23e9a3b7-48ad-4c0c-8910-904c93cfd20a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/773499fa-69c4-4687-b166-c0c4ed2e6c27/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T223242Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8f8a85e0d20b69902ba158c8dc0b6171f9fe6ef1bf8b4a4abed6653e86585303"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/773499fa-69c4-4687-b166-c0c4ed2e6c27/results/263148/?format=api",
            "id": 263148,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": "Max water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/316413af-2ea3-4b8b-808e-e7a6a3a8fa7a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/773499fa-69c4-4687-b166-c0c4ed2e6c27/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T223242Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9c1fc629cb7c55051d07872127215d824c903aa29c8eda84b5a7cc58820617e6"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/773499fa-69c4-4687-b166-c0c4ed2e6c27/results/263149/?format=api",
            "id": 263149,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": "Flood hazard rating",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/55fe4781-3481-41ca-b421-f8a11f9f341f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/773499fa-69c4-4687-b166-c0c4ed2e6c27/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T223242Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a9b5a903bb436a80e969d4c3e034794a696821bce9ef0fe857434a2749daae6c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/773499fa-69c4-4687-b166-c0c4ed2e6c27/results/263150/?format=api",
            "id": 263150,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": "Rate of rise of the water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/8bba26b9-f70a-4a14-8ca2-7c4ddf93f911/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/773499fa-69c4-4687-b166-c0c4ed2e6c27/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T223242Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ca10d892787ba3047d32c5d3e1ac97306ae8d2c945a41ca92bca1e1b6a18b8a3"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/773499fa-69c4-4687-b166-c0c4ed2e6c27/results/263151/?format=api",
            "id": 263151,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": "Water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c69defc8-807c-430d-b8f7-807a589c2679/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/773499fa-69c4-4687-b166-c0c4ed2e6c27/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T223242Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a49a37f81b63ae2440a76ffba62783b843f64aa611cff2d6222eea2e56f9c1b8"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/773499fa-69c4-4687-b166-c0c4ed2e6c27/results/263152/?format=api",
            "id": 263152,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": "Max water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/70e18459-5511-4360-a5b1-b40022fefe06/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/773499fa-69c4-4687-b166-c0c4ed2e6c27/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T223242Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=dd93d964954ca4baa067b3f62efedf091bf7542cb88659633f208b033e284eac"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/773499fa-69c4-4687-b166-c0c4ed2e6c27/results/263153/?format=api",
            "id": 263153,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": "Max flow velocity",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/9464853e-de79-4f69-9604-e9a4cb7402b2/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/773499fa-69c4-4687-b166-c0c4ed2e6c27/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T223242Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=10f6f85ce5a99d7bcf273b6285d72a4432c1dba0d885d6e1e128ab9bd8699315"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/773499fa-69c4-4687-b166-c0c4ed2e6c27/results/263154/?format=api",
            "id": 263154,
            "name": "Rain",
            "code": "rain-quad",
            "description": "Rain",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/35f67809-0ef9-40fe-b740-945696fb79b3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/773499fa-69c4-4687-b166-c0c4ed2e6c27/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T223242Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=86a0d3913fff613719e47df5e645acf76c7ba2a351c44a97c66d7117057cff01"
        }
    ]
}