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/ce52f6b0-cdfe-4612-9edc-8c1f91e349d6/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/ce52f6b0-cdfe-4612-9edc-8c1f91e349d6/results/441149/?format=api",
            "id": 441149,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/df9b261b-b94a-47a3-bfdb-864d8dcd3880/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ce52f6b0-cdfe-4612-9edc-8c1f91e349d6/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T213331Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b737063be70718dce59e23416dbbb1a8f7c58ad1f8b90fac7e58bf04aa7180a5"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ce52f6b0-cdfe-4612-9edc-8c1f91e349d6/results/441150/?format=api",
            "id": 441150,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d85c620d-1cec-4413-8f47-a569cb4484cc/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ce52f6b0-cdfe-4612-9edc-8c1f91e349d6/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T213331Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e598c3a8a915bf877c55da6651eb8840f11b96d8f403bc65cd481f85a27c3e0d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ce52f6b0-cdfe-4612-9edc-8c1f91e349d6/results/441151/?format=api",
            "id": 441151,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/676fde53-e751-4c4a-af6e-421fa73f8da1/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ce52f6b0-cdfe-4612-9edc-8c1f91e349d6/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T213331Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3ef8b3f6e65d8a68da2e34d0ecf6e7c9e3eb16d9ce826cc19ed27d0f0ff927b2"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ce52f6b0-cdfe-4612-9edc-8c1f91e349d6/results/441152/?format=api",
            "id": 441152,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/05177dfc-1340-4c92-91bc-e883e9ff096a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ce52f6b0-cdfe-4612-9edc-8c1f91e349d6/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T213331Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c069bf3bd49301d4d3e12635127faf47d2fb79dbe31b02c068f20a1b5b82d04d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ce52f6b0-cdfe-4612-9edc-8c1f91e349d6/results/441153/?format=api",
            "id": 441153,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/0cf8cb4b-2cfc-4ea3-9503-31834755b5ca/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ce52f6b0-cdfe-4612-9edc-8c1f91e349d6/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T213331Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9548bfec1c270a04c63edc951eb3ce73f62b4635d185ab3c47eb2ff8089e50a5"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ce52f6b0-cdfe-4612-9edc-8c1f91e349d6/results/441154/?format=api",
            "id": 441154,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/06e09b01-be95-4612-bfb2-cf8da311c89a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ce52f6b0-cdfe-4612-9edc-8c1f91e349d6/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T213331Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c3bc8300a392bef13f674d37ef08c75d51fa1346ecc0ca95d62311f58017776e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ce52f6b0-cdfe-4612-9edc-8c1f91e349d6/results/441155/?format=api",
            "id": 441155,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/037aa03f-e599-4d3c-88f5-30b85cd2cb79/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ce52f6b0-cdfe-4612-9edc-8c1f91e349d6/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T213331Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ee3ba073d3445d32fb70465ea839165af911dd30ac84adda5b43f3e9de906701"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ce52f6b0-cdfe-4612-9edc-8c1f91e349d6/results/441156/?format=api",
            "id": 441156,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a0359917-aaad-468d-9892-2768dc11c41a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ce52f6b0-cdfe-4612-9edc-8c1f91e349d6/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T213331Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=620f4345acf4e2f97c433506826ac21b6fee28c0ce5d309e2491e44231a55a6e"
        }
    ]
}