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/a01d8369-5288-4e5e-aa14-1934671bfe9c/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/a01d8369-5288-4e5e-aa14-1934671bfe9c/results/498384/?format=api",
            "id": 498384,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/fc44372e-0943-4320-acc2-d3f05adc3ca6/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a01d8369-5288-4e5e-aa14-1934671bfe9c/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250428%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250428T201610Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=378d1b46b82851f7884fb8e3daf64c83914436879ed7985d92f90cba053015f7"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a01d8369-5288-4e5e-aa14-1934671bfe9c/results/498385/?format=api",
            "id": 498385,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/542f1439-c04b-44e6-919c-88db64fa3a31/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a01d8369-5288-4e5e-aa14-1934671bfe9c/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250428%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250428T201610Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4d3e18ca45b6a74e9461b17f9de68b0389fdbf01745fc2ea65b3eb8e6843dac1"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a01d8369-5288-4e5e-aa14-1934671bfe9c/results/498386/?format=api",
            "id": 498386,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a663a15e-656f-48a5-ac6b-43c33982d62c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a01d8369-5288-4e5e-aa14-1934671bfe9c/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250428%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250428T201610Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=cc09871c3dbf907707a0d39cf65d6676ce0383b4081b7fb9d947226c065abf3e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a01d8369-5288-4e5e-aa14-1934671bfe9c/results/498387/?format=api",
            "id": 498387,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c27d2c43-de85-4f4a-908c-961909d5d08d/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a01d8369-5288-4e5e-aa14-1934671bfe9c/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250428%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250428T201610Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=da3a24b64e535553fed1d1401632f4af16c32224e674b5832f111fe25ccbb968"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a01d8369-5288-4e5e-aa14-1934671bfe9c/results/498388/?format=api",
            "id": 498388,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/0629d569-276d-425d-9376-ea9bccdbde3f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a01d8369-5288-4e5e-aa14-1934671bfe9c/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250428%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250428T201610Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b1b3f59c1211f0c98e3e4b1b62a2a61c580ecd16caf30440a3b2173c523f01a3"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a01d8369-5288-4e5e-aa14-1934671bfe9c/results/498389/?format=api",
            "id": 498389,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/cb945859-0638-4113-a278-f1115985c935/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a01d8369-5288-4e5e-aa14-1934671bfe9c/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250428%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250428T201610Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6821f82cc892793657e4f41dd26d5d7a5fc2c6bcbad8311ce1f09328cf71ef1a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a01d8369-5288-4e5e-aa14-1934671bfe9c/results/498390/?format=api",
            "id": 498390,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/5b6ced8e-0cec-403b-b96b-47a4155e0537/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a01d8369-5288-4e5e-aa14-1934671bfe9c/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250428%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250428T201610Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d6ebb23486fa1e9312a26bfa0664b0dad2a0ea487076669ac1c5fab5a48337df"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a01d8369-5288-4e5e-aa14-1934671bfe9c/results/498391/?format=api",
            "id": 498391,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/303832b5-753d-4114-a18f-bcdd0fa302c9/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a01d8369-5288-4e5e-aa14-1934671bfe9c/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250428%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250428T201610Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4d013ad7cefcd5d423eca862123409e1f87a027f84dda17aa6e4069f9afb5612"
        }
    ]
}