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/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/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/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/results/452227/?format=api",
            "id": 452227,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/f7d0629f-b013-4986-8224-ba46a623010e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T065730Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=08b3ab0e51b4d91793542ded231e86cf260505a48baed08e02f75d75937a79fa"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/results/452228/?format=api",
            "id": 452228,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/63acce25-90e5-418b-b070-99ee944cbdb1/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T065730Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8c706fa88a4ed7ecc8fdda45805c37ada2b5263d6f2a755a094dce970e64b55e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/results/452229/?format=api",
            "id": 452229,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/0ddb10ea-0f0e-4351-8909-d74decf33993/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T065730Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e22964348ff43c1ab30999030d2dd3a7063521d6c505c97619b4a09121b59712"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/results/452230/?format=api",
            "id": 452230,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/27c86190-3447-439d-a76f-cffd53a7181e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T065730Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8dbef4484e042d791746a103fceecea95f97e517f2f86abf4e30652496867900"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/results/452231/?format=api",
            "id": 452231,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/268f00e7-187f-49db-b76f-d5d3fe61334b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T065730Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1747ed763dae9dd098a685ab2b8f691d2d41cf0ab74d8fbc06e194c6c07398a5"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/results/452232/?format=api",
            "id": 452232,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/047e0814-53ac-4029-a499-d98aff0385f9/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T065730Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0ad07e9601d6caf52528d8ac27a43eba91a577e29155ffa626a50c5f16370256"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/results/452233/?format=api",
            "id": 452233,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/026373d4-034c-44bc-81e7-53f4689ba478/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T065730Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=eaf0b9fea5f998a08bbd9283aaafcd3743469c6db636c21a08c0201eaa6c0900"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/results/452234/?format=api",
            "id": 452234,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/86ef5106-2b61-47a9-9851-76baea9c54db/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T065730Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c9170012d0810a30f9426921e3b2237dfc33ae232fe4bd5e15261a273ffb80e7"
        }
    ]
}