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/15681485-fd3d-4af9-a7ea-20dab0093311/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/15681485-fd3d-4af9-a7ea-20dab0093311/results/441045/?format=api",
            "id": 441045,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/0d0c4740-8bce-466f-bee9-fea5a2d96c6e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/15681485-fd3d-4af9-a7ea-20dab0093311/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T082802Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=41bc24e5ac0d7551c7b3d8e99b85e3c1c1a7705659bf6a90c7d67202ab6ed6fc"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/15681485-fd3d-4af9-a7ea-20dab0093311/results/441046/?format=api",
            "id": 441046,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b6446fee-f3ce-45b4-be84-6f5b1565035a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/15681485-fd3d-4af9-a7ea-20dab0093311/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T082802Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7807f45f20dcbb49c452acf0d048e62e92d06fec169a0ef41249b441d50e7978"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/15681485-fd3d-4af9-a7ea-20dab0093311/results/441047/?format=api",
            "id": 441047,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c3564451-cd24-485c-9e36-5a62baaebf29/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/15681485-fd3d-4af9-a7ea-20dab0093311/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T082802Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d321168f900d8d09cc5a82d3591d865b029a7231761273033a63037517d7344b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/15681485-fd3d-4af9-a7ea-20dab0093311/results/441048/?format=api",
            "id": 441048,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/29f80c13-eaf1-4030-8147-28a018b19d89/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/15681485-fd3d-4af9-a7ea-20dab0093311/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T082802Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8aacf616b21d19ba6155a88deaf915a8cc4b90be05893ab2790a1a47b147e530"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/15681485-fd3d-4af9-a7ea-20dab0093311/results/441049/?format=api",
            "id": 441049,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/726c54c4-ebff-43f7-847c-55249398d223/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/15681485-fd3d-4af9-a7ea-20dab0093311/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T082802Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b871172370cc801aff47a1ddc7425d128b99501a5e3a89ac3bcaaa5b5bd9ee73"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/15681485-fd3d-4af9-a7ea-20dab0093311/results/441050/?format=api",
            "id": 441050,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/e4b457df-e29c-4728-819c-05b89ed571b6/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/15681485-fd3d-4af9-a7ea-20dab0093311/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T082802Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=149e95486d7efa22b2907a19a29d069a80ae26b04099dda46286ef318acfce5e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/15681485-fd3d-4af9-a7ea-20dab0093311/results/441051/?format=api",
            "id": 441051,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b5b3c2a9-751c-4238-9b94-882c5ea1bc6c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/15681485-fd3d-4af9-a7ea-20dab0093311/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T082802Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=95b09e1f9ca7923dc63a122434cd129eb5ecdf4051b7f24c7caf63d23c69cd4a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/15681485-fd3d-4af9-a7ea-20dab0093311/results/441052/?format=api",
            "id": 441052,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/138e8ea1-5ad8-4fea-8815-ec4cd9fca2c2/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/15681485-fd3d-4af9-a7ea-20dab0093311/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T082802Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=678d893a7c1155a1ed6213d00376392f574767178d4a0f5653b114f2d9cfa880"
        }
    ]
}