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/9843da10-6e95-43d9-b2b5-99d2cd5615c7/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/9843da10-6e95-43d9-b2b5-99d2cd5615c7/results/263207/?format=api",
            "id": 263207,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": "Water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/28324d04-da88-4cc1-a52a-4cd7b05da8cf/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9843da10-6e95-43d9-b2b5-99d2cd5615c7/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T221913Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=cd78563dc014280a79dd0980625982d5bdd68ab3d599a47383d20a5e29ba6a10"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9843da10-6e95-43d9-b2b5-99d2cd5615c7/results/263208/?format=api",
            "id": 263208,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": "Max water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c4874174-eedb-4e14-9b07-06cdd23c97f4/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9843da10-6e95-43d9-b2b5-99d2cd5615c7/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T221913Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1fac2f7c8bf8b8381c457a5bd204b94a0d56b97ebf954bdbea0ff1043218c840"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9843da10-6e95-43d9-b2b5-99d2cd5615c7/results/263209/?format=api",
            "id": 263209,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": "Flood hazard rating",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/634939e5-36a4-4f6e-96f0-ed4074fccbce/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9843da10-6e95-43d9-b2b5-99d2cd5615c7/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T221913Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9835715d80debadd7d8461639e5a1906b1331c1205b745ecd7d24e13d7ba9daf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9843da10-6e95-43d9-b2b5-99d2cd5615c7/results/263210/?format=api",
            "id": 263210,
            "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/58a4e51a-a392-4c9a-925a-ca454d2b6cf8/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9843da10-6e95-43d9-b2b5-99d2cd5615c7/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T221913Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5e12bfa6a598c9eb059f4adbe20a2e6e76f96118f68b54842f883d1f25e7ca33"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9843da10-6e95-43d9-b2b5-99d2cd5615c7/results/263211/?format=api",
            "id": 263211,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": "Water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/ab877d02-7551-4111-8f41-d80460df8754/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9843da10-6e95-43d9-b2b5-99d2cd5615c7/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T221913Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=74354f00712baac55e43080588d28b7a53cdfc5ddf4fd4bab5fddd07650306fa"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9843da10-6e95-43d9-b2b5-99d2cd5615c7/results/263212/?format=api",
            "id": 263212,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": "Max water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/17b5daaf-7c62-4795-a38e-b0d502bfe0df/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9843da10-6e95-43d9-b2b5-99d2cd5615c7/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T221913Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e37d484a0260b9e47f7a1403e8d1a286bee5f411acc93670299118b5f7a53fb7"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9843da10-6e95-43d9-b2b5-99d2cd5615c7/results/263213/?format=api",
            "id": 263213,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": "Max flow velocity",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/9ababd42-c04d-4fde-a802-7218de0a6e7a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9843da10-6e95-43d9-b2b5-99d2cd5615c7/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T221913Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=180d3204636a9551dfcc15e6287f8130c48f46b198639a9574ac2a2dd695cb63"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9843da10-6e95-43d9-b2b5-99d2cd5615c7/results/263214/?format=api",
            "id": 263214,
            "name": "Rain",
            "code": "rain-quad",
            "description": "Rain",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b6f27b2a-4312-480b-b58a-113b7abc3dfe/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9843da10-6e95-43d9-b2b5-99d2cd5615c7/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T221913Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1de5b1398c99b887d04611e64f5444e16a63f5540e6105e2a9b15f4f7d33bf05"
        }
    ]
}