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/d076586f-fdbb-4cc0-be13-8987f7d28b96/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/d076586f-fdbb-4cc0-be13-8987f7d28b96/results/441124/?format=api",
            "id": 441124,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/5125b783-a532-4464-b4dd-7aab10a03c1f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d076586f-fdbb-4cc0-be13-8987f7d28b96/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T214802Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5928330aa13edfb5ecd8e761426751997cb0afe91e5e4bc520fec239f004219a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d076586f-fdbb-4cc0-be13-8987f7d28b96/results/441125/?format=api",
            "id": 441125,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/94e23ed7-b7ea-40b0-88e2-a08be2dff7c0/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d076586f-fdbb-4cc0-be13-8987f7d28b96/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T214802Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=be6440f044870d05fb5c894dc2b97f054307e96e45ea662a886b4e6c4435640f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d076586f-fdbb-4cc0-be13-8987f7d28b96/results/441126/?format=api",
            "id": 441126,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/00cc0069-a591-46ca-8bc6-d20db956672f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d076586f-fdbb-4cc0-be13-8987f7d28b96/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T214802Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=cd4523b812939aa0d49e9f61432e6f9a47939eb7052098ce55d44eaaa45ac39f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d076586f-fdbb-4cc0-be13-8987f7d28b96/results/441127/?format=api",
            "id": 441127,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/199f8dde-888c-4523-8d32-0f86f299f1b7/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d076586f-fdbb-4cc0-be13-8987f7d28b96/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T214802Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=30968ad28aed7777bfb35bbb6e4bf8070f1ebf7f9c335c404b9765784a3c67c5"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d076586f-fdbb-4cc0-be13-8987f7d28b96/results/441128/?format=api",
            "id": 441128,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/46b5f534-7d7a-4f5c-866d-af38df0126e2/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d076586f-fdbb-4cc0-be13-8987f7d28b96/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T214802Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=677f65219c59f4f14c3a54ab9ee651e626d69675e83798f347150368fa22c535"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d076586f-fdbb-4cc0-be13-8987f7d28b96/results/441129/?format=api",
            "id": 441129,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2d971b76-937c-401a-8c08-3f5847ff646b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d076586f-fdbb-4cc0-be13-8987f7d28b96/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T214802Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1c1cca6f7e8a115dca063da4be4a4e17a71db3ac64a147d090fef1cb0ea599ed"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d076586f-fdbb-4cc0-be13-8987f7d28b96/results/441130/?format=api",
            "id": 441130,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/65bf8a58-646f-4687-bb58-1856e03d8e26/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d076586f-fdbb-4cc0-be13-8987f7d28b96/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T214802Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=83ad5bcf2cf76fc7b5602fe2f606593d48c7560d5b3165b49fdc7f56a0399b6d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d076586f-fdbb-4cc0-be13-8987f7d28b96/results/441131/?format=api",
            "id": 441131,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/8a3c5126-8868-49ef-a876-c5af971626e3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d076586f-fdbb-4cc0-be13-8987f7d28b96/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T214802Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=efde6e0be56b9692b5814bcd1c207cc0fa2d1e31d101c9852520d0d45bd4052f"
        }
    ]
}