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/3cd9267f-a58a-4c6e-8875-9dabf36841f1/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/3cd9267f-a58a-4c6e-8875-9dabf36841f1/results/447928/?format=api",
            "id": 447928,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/8e6b50ed-6411-42d8-9c93-b3cb5e580c2d/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/3cd9267f-a58a-4c6e-8875-9dabf36841f1/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T004720Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=59edcb09b5e4028360ccbe6dc9191323e4ff83ec590d878462e7664d5d0c2a30"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3cd9267f-a58a-4c6e-8875-9dabf36841f1/results/447929/?format=api",
            "id": 447929,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/49226ac2-91df-4eb7-9e8a-e6f933d1564b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/3cd9267f-a58a-4c6e-8875-9dabf36841f1/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T004720Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1f74fe9ea39c63fe44fe0e4b5094503aba236b18283dccd4eef4f9eee178c837"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3cd9267f-a58a-4c6e-8875-9dabf36841f1/results/447930/?format=api",
            "id": 447930,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/0e9f0bb3-27c9-4697-973d-6a997a462064/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/3cd9267f-a58a-4c6e-8875-9dabf36841f1/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T004720Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=23a39dfaa1e24e114bb8bb60bafb02a4d0fa673a13c98adfd68a79ec2d4f45ec"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3cd9267f-a58a-4c6e-8875-9dabf36841f1/results/447931/?format=api",
            "id": 447931,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/3b1dfa94-e377-47cc-bf14-96cf120f0d5d/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/3cd9267f-a58a-4c6e-8875-9dabf36841f1/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T004720Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b0d59a7611eb9ebb5f6725883cdde8cf4147545162988630e837bda62a38e962"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3cd9267f-a58a-4c6e-8875-9dabf36841f1/results/447932/?format=api",
            "id": 447932,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/01f7a998-1695-4d66-9e7b-9c2c4165b9c6/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/3cd9267f-a58a-4c6e-8875-9dabf36841f1/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T004720Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=df5f0489349bea0f1df74bf403760598163a7f34ab9a3eca9ccddba8f081e968"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3cd9267f-a58a-4c6e-8875-9dabf36841f1/results/447933/?format=api",
            "id": 447933,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b74a5c08-dfaf-47b1-b043-2785aded9928/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/3cd9267f-a58a-4c6e-8875-9dabf36841f1/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T004720Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a8f094a2cce9f4006f5a6d1d424966cde11141be3491a58181f426416becc103"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3cd9267f-a58a-4c6e-8875-9dabf36841f1/results/447934/?format=api",
            "id": 447934,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/847a7e8e-d20a-46be-9e30-10615123ff03/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/3cd9267f-a58a-4c6e-8875-9dabf36841f1/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T004720Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5d2c25aaf7c1b407eb008ff2b5ee765f2ba061d5b33feef0830aa82f6b061a7a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3cd9267f-a58a-4c6e-8875-9dabf36841f1/results/447935/?format=api",
            "id": 447935,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b73fb050-a984-46c7-8598-30a82834e181/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/3cd9267f-a58a-4c6e-8875-9dabf36841f1/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T004720Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9dafe5536b15c9aef9938648fcedd5152c63721bd21d43da63fb210557c96272"
        }
    ]
}