Arrival – 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/aa58854a-6486-403b-a000-5ba185a52625/results/arrival/?format=api

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

{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/aa58854a-6486-403b-a000-5ba185a52625/results/452303/?format=api",
            "id": 452303,
            "name": "Arrival time",
            "code": "depth-first-dtri",
            "description": null,
            "family": "Arrival",
            "raster": "https://demo.lizard.net/api/v4/rasters/3361ae37-12c0-434c-a6c5-8c9096efa5e7/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/aa58854a-6486-403b-a000-5ba185a52625/depth-first-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062926Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9c80b41cec698e32810c762e975236640f1c2e67697c9368af6ba4790a53a21a"
        }
    ]
}