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/5cf352bb-a6ae-4425-b276-a20fbfff45f7/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/5cf352bb-a6ae-4425-b276-a20fbfff45f7/results/436532/?format=api",
            "id": 436532,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4c75e2b2-1a87-438d-a217-f9373f9d5399/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5cf352bb-a6ae-4425-b276-a20fbfff45f7/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T121917Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3a211515bc34c816771721e6bcc14268b520bdcef2b638ea291677d90d7ca751"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5cf352bb-a6ae-4425-b276-a20fbfff45f7/results/436533/?format=api",
            "id": 436533,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c4072c9e-c55c-4489-9920-43903d2f4afd/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5cf352bb-a6ae-4425-b276-a20fbfff45f7/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T121917Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1d59a2058038c02015cfdb5800e6c5e501578abf1a69eaa3f1c3d851560c1b84"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5cf352bb-a6ae-4425-b276-a20fbfff45f7/results/436534/?format=api",
            "id": 436534,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/84fbc2b7-366d-4348-91fb-2f0306ea4319/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5cf352bb-a6ae-4425-b276-a20fbfff45f7/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T121917Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9a8e0dc700934f56b77ec2fd364fcd877b7a109053c9283df561d36a121191d9"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5cf352bb-a6ae-4425-b276-a20fbfff45f7/results/436535/?format=api",
            "id": 436535,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4a2033e4-2f0a-4568-8193-2896e357483f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5cf352bb-a6ae-4425-b276-a20fbfff45f7/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T121917Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=10bd4681bd0b9fff4f8de2fc5bde5ed7556edca2827758d6e662af9f7307ab66"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5cf352bb-a6ae-4425-b276-a20fbfff45f7/results/436536/?format=api",
            "id": 436536,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/42e76233-c82c-495b-b169-cbd816ef6191/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5cf352bb-a6ae-4425-b276-a20fbfff45f7/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T121917Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=27bfe4d986417b6dff3e54634dbd327226f5855ae36d7776a6b2f9de317a096b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5cf352bb-a6ae-4425-b276-a20fbfff45f7/results/436537/?format=api",
            "id": 436537,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d5c93d06-c1e2-4e05-81c6-12859cfe758c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5cf352bb-a6ae-4425-b276-a20fbfff45f7/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T121917Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d3192acc5b002afe95bf4025e2322c53fc3a38b9cc51d653058f9d028e0545c5"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5cf352bb-a6ae-4425-b276-a20fbfff45f7/results/436538/?format=api",
            "id": 436538,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/9a9120d9-05b4-42af-b3f6-6958d08f8ab9/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5cf352bb-a6ae-4425-b276-a20fbfff45f7/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T121917Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4a56633472626346d38a301f0713ea5c9b6376b74876b2e83d57f71beb9cf56e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5cf352bb-a6ae-4425-b276-a20fbfff45f7/results/436539/?format=api",
            "id": 436539,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/1301d1e3-5a64-4c87-807f-c3d5e93d2490/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5cf352bb-a6ae-4425-b276-a20fbfff45f7/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T121917Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3bb33aab820df89df5c12ceda5d8ec9211c2104bacf35d64438463a54f8bc0d0"
        }
    ]
}