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/c2c68ff5-f6eb-4766-ad90-709f7020f9c4/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/c2c68ff5-f6eb-4766-ad90-709f7020f9c4/results/448975/?format=api",
            "id": 448975,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/6cf9ede1-bcb6-4253-8355-546826fbc709/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c2c68ff5-f6eb-4766-ad90-709f7020f9c4/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T132919Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d70c0117b87a6464f4af4d7df75467157a0a46f6619ee4aaed601f04985d8365"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c2c68ff5-f6eb-4766-ad90-709f7020f9c4/results/448976/?format=api",
            "id": 448976,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/19dca1b8-2f16-432d-bd1c-e0da35134ca6/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c2c68ff5-f6eb-4766-ad90-709f7020f9c4/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T132919Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2ad3e6a09d1bb38081d6f274b93029793dbd0a85dfe0c124e2368279e41ad087"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c2c68ff5-f6eb-4766-ad90-709f7020f9c4/results/448977/?format=api",
            "id": 448977,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/dd0e30bd-0569-41dc-aff9-804ef010580c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c2c68ff5-f6eb-4766-ad90-709f7020f9c4/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T132919Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=32cbfe827f8431c8129d6982e35b0d1552ed2e3335c3e4f4cd132fed274cab69"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c2c68ff5-f6eb-4766-ad90-709f7020f9c4/results/448978/?format=api",
            "id": 448978,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/ddb77310-09cc-47b2-8164-ee8a39cc61bd/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c2c68ff5-f6eb-4766-ad90-709f7020f9c4/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T132919Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c50c53c07270cd069c40955e65a20b64ec763269f676f19820ea0fd2fe73c3ba"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c2c68ff5-f6eb-4766-ad90-709f7020f9c4/results/448979/?format=api",
            "id": 448979,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/0c6dc211-640b-4782-b0c5-5a075ce4813d/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c2c68ff5-f6eb-4766-ad90-709f7020f9c4/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T132919Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d30863eed8fc8e6e44935a0b83da30761e6970b4c5efb3970b567e088016a9da"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c2c68ff5-f6eb-4766-ad90-709f7020f9c4/results/448980/?format=api",
            "id": 448980,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/807c7e4f-4fe2-4d15-937e-33c4ab5bdac5/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c2c68ff5-f6eb-4766-ad90-709f7020f9c4/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T132919Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=06373e1bb299398aa8937e05c6b1de92f7fa02f8fb818edc4fa29320e2d20bef"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c2c68ff5-f6eb-4766-ad90-709f7020f9c4/results/448981/?format=api",
            "id": 448981,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/578a8b55-033f-4abf-bfc3-ef0860695a1a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c2c68ff5-f6eb-4766-ad90-709f7020f9c4/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T132919Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=762cf0cd8e16c98093f25b2f36dc43b4a1c454751fcd62aed5752b839d4378c9"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c2c68ff5-f6eb-4766-ad90-709f7020f9c4/results/448982/?format=api",
            "id": 448982,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/928a772a-1954-40ac-93a5-8844720e325b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c2c68ff5-f6eb-4766-ad90-709f7020f9c4/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T132919Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=436964ae0d03135d8c3b9533976d9d0060a3a085e3ed8ae494a921ef5261e029"
        }
    ]
}