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/3eff5477-2e19-49a0-9a8d-402a2b5821e3/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/3eff5477-2e19-49a0-9a8d-402a2b5821e3/results/263159/?format=api",
            "id": 263159,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": "Water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/03af2c13-7174-4544-8554-bdb16990aebe/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/3eff5477-2e19-49a0-9a8d-402a2b5821e3/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191927Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4084b3ab4bb9d4bc476867f0d3765a77c2488fa0c66cf796c5b25b85dc87924a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3eff5477-2e19-49a0-9a8d-402a2b5821e3/results/263160/?format=api",
            "id": 263160,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": "Max water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/42307f96-722e-4c5d-ae95-8b0d2718d486/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/3eff5477-2e19-49a0-9a8d-402a2b5821e3/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191927Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1cf52161d6517e4d180ce364b49366ee26f00e36339b84e0713fad59276079b5"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3eff5477-2e19-49a0-9a8d-402a2b5821e3/results/263161/?format=api",
            "id": 263161,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": "Flood hazard rating",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/69dfb373-6fd6-4a26-a092-376a54aa1d0c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/3eff5477-2e19-49a0-9a8d-402a2b5821e3/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191927Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3b83817f349e10d05333c16dabaf553907506710d140d4e54501570009105eda"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3eff5477-2e19-49a0-9a8d-402a2b5821e3/results/263162/?format=api",
            "id": 263162,
            "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/5e8c801c-c459-464a-b05e-0c958c0de46e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/3eff5477-2e19-49a0-9a8d-402a2b5821e3/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191927Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ec0583aab23f5ab9b386a1d39588f473d2ea206d299c6c7da82178e54357d74b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3eff5477-2e19-49a0-9a8d-402a2b5821e3/results/263163/?format=api",
            "id": 263163,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": "Water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d1cc06d6-815f-4999-b455-db6803318a56/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/3eff5477-2e19-49a0-9a8d-402a2b5821e3/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191927Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b6a6d0fdc4b13d99dd930cef91ba88f171643694d1c18b1c8ad431180b3d2f68"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3eff5477-2e19-49a0-9a8d-402a2b5821e3/results/263164/?format=api",
            "id": 263164,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": "Max water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c2568dc1-4ebb-421d-91cf-31e4e56f2a51/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/3eff5477-2e19-49a0-9a8d-402a2b5821e3/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191927Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d0db3a02ae2a68a0be41700e3c3bdf23b1c1ea4996bbcd2ac8b109e5b08e8b69"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3eff5477-2e19-49a0-9a8d-402a2b5821e3/results/263165/?format=api",
            "id": 263165,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": "Max flow velocity",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/bec7aae1-8c1f-47bb-98a7-b122dc9ca81b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/3eff5477-2e19-49a0-9a8d-402a2b5821e3/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191927Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1c07a6cc944db6afbd2498adbd0b50ffeb2a732ed0babd32321a2d6c04b38518"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3eff5477-2e19-49a0-9a8d-402a2b5821e3/results/263166/?format=api",
            "id": 263166,
            "name": "Rain",
            "code": "rain-quad",
            "description": "Rain",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/81254415-dd96-4937-8827-bfc7af757f41/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/3eff5477-2e19-49a0-9a8d-402a2b5821e3/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191927Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=abc300476a090742064d27e9c16b4a553e286658d5a0d1d493c67d8902f29eea"
        }
    ]
}