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/74c64fb6-a8e2-4f3a-96fe-6e480459de67/results/basic/?format=api

HTTP 200 OK
Allow: GET, DELETE, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "count": 2,
    "next": null,
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/74c64fb6-a8e2-4f3a-96fe-6e480459de67/results/301570/?format=api",
            "id": 301570,
            "name": "Waterdepth",
            "code": "Waterdepth_tuflow_hvfms",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/6e714832-6962-4199-bf13-697925573899/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/74c64fb6-a8e2-4f3a-96fe-6e480459de67/Waterdepth_tuflow_hvfms-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T004455Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a81a185df4d5425f476d57ce63931500f97a0e6fcef9b3af1a46105ab0edb65d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/74c64fb6-a8e2-4f3a-96fe-6e480459de67/results/301571/?format=api",
            "id": 301571,
            "name": "rainfall",
            "code": "rainfall_tuflow_hvfms",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/612bab2d-9454-4d1f-b14f-bd7d25d574b4/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/74c64fb6-a8e2-4f3a-96fe-6e480459de67/rainfall_tuflow_hvfms-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T004455Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b3f2ba23f275676dc95a84477b5f2c9ac489a62c5685beaaf232d4fda771cbc9"
        }
    ]
}