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/1a0c8d43-fb44-4583-852d-324d7b62e2e0/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/1a0c8d43-fb44-4583-852d-324d7b62e2e0/results/449401/?format=api",
            "id": 449401,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/9924f3ac-bee8-44b5-9194-f2d80917c7c6/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1a0c8d43-fb44-4583-852d-324d7b62e2e0/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T195019Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=57623f1fe963b61daddd4c603b79b9da129b67f3084b79a3573953196b680306"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1a0c8d43-fb44-4583-852d-324d7b62e2e0/results/449402/?format=api",
            "id": 449402,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d7651768-5a2f-41fd-8cc6-b2b15a40c499/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1a0c8d43-fb44-4583-852d-324d7b62e2e0/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T195019Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b61ff08cce95089f008e48088e6c03e11c3b7b2468c17940d540f1b7cd3aad9c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1a0c8d43-fb44-4583-852d-324d7b62e2e0/results/449403/?format=api",
            "id": 449403,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/386b215f-89b2-4574-b6fb-2d3d911cdbac/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1a0c8d43-fb44-4583-852d-324d7b62e2e0/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T195019Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0ea7cb208a5e6bf8bc436adddce02aa07f14e27b1e1aa0f3d06af7dcef33320d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1a0c8d43-fb44-4583-852d-324d7b62e2e0/results/449404/?format=api",
            "id": 449404,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a44d67dd-643e-43ae-9cb6-3b848fb41429/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1a0c8d43-fb44-4583-852d-324d7b62e2e0/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T195019Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f1080b8158f78691ce969483db9b2cf45e895c820e3ca36e0f98370d5384828c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1a0c8d43-fb44-4583-852d-324d7b62e2e0/results/449405/?format=api",
            "id": 449405,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/8d78fa52-1977-423e-a85b-857b07ddc950/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1a0c8d43-fb44-4583-852d-324d7b62e2e0/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T195019Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=821bef4686e3f5e1a0c9cb3aa11cf619bb8e5dcd57429ca0744a63c51f557a86"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1a0c8d43-fb44-4583-852d-324d7b62e2e0/results/449406/?format=api",
            "id": 449406,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/ce3ebd07-2802-43aa-acb2-98fa081f7837/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1a0c8d43-fb44-4583-852d-324d7b62e2e0/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T195019Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6f5f765d73b4c3d737dcfee5aa1e3bfbfc72c0e4184239cc5409afd40336ca63"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1a0c8d43-fb44-4583-852d-324d7b62e2e0/results/449407/?format=api",
            "id": 449407,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a93bb9a3-8309-4e21-8b34-481c043d6556/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1a0c8d43-fb44-4583-852d-324d7b62e2e0/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T195019Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c3517bb24b3951da1ee7f7bd91c80997d7e29438372eda65baea4b38fa03216d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1a0c8d43-fb44-4583-852d-324d7b62e2e0/results/449408/?format=api",
            "id": 449408,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/6c2c7a16-50a0-4d94-a5aa-1f07083c8ae5/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1a0c8d43-fb44-4583-852d-324d7b62e2e0/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T195019Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6919cd7be64ab0c6dcf47e26beb6c63a45c54388a583abe7bdc170fbd99a5899"
        }
    ]
}