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/9aa6fe72-f10a-4d31-88b4-4129a877644e/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/9aa6fe72-f10a-4d31-88b4-4129a877644e/results/447961/?format=api",
            "id": 447961,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/8a8e8ce7-0f8a-429e-b052-6fc3886c6bb2/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T013119Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=aab8065bc4dab1f43c78ab30cee9818485c03d3189afbf2a88a71638e6b6343b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/results/447962/?format=api",
            "id": 447962,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/815ea297-af58-4ef5-b783-6204e4881159/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T013119Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=422821ae9890f2b7f030a96c41f5d4ca39bcb16407bda293aa9e9539636d68d1"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/results/447963/?format=api",
            "id": 447963,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/30c068b5-96c6-4299-bcf6-9955399865b3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T013119Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d460b5a0aaa9106b598af9de6e42bdf0fadc13f738c9c2bcb13007d03e0be5c1"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/results/447964/?format=api",
            "id": 447964,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/58a83d94-e50b-4ca4-b669-7293bcc6c1fb/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T013119Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=bf5d3e9cfc25e9f72d6d5a3d05ec0a5c9a8aae1eec52df540596437a1d764971"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/results/447965/?format=api",
            "id": 447965,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/18069119-6521-483c-a7e5-036468ebb263/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T013119Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6182dba4c384c0d00d7c89153df7b0a90f811672d5ff7899e5819ac4b26d62db"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/results/447966/?format=api",
            "id": 447966,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a6fe26cf-5450-4ce5-87fb-b76abc45d38a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T013119Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=bc4c1e5803c8b98c896c2659d8e41fb3bb7665e9c59b67e877d881e921457dd3"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/results/447967/?format=api",
            "id": 447967,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/64483dee-df37-4361-8ea6-0c5dccfab820/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T013119Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7a17e5c65c95d774467a9c5695361b1ec1872e75e5c1ea6fabda7bc7e9c8da72"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/results/447968/?format=api",
            "id": 447968,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4ef92431-c8be-44d3-b2cb-8023f40ed000/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T013119Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1ca7efc7a09007d6a72c7b4ea678c1ecbe381e869db3b1d79737e4cc75700494"
        }
    ]
}