Result Instance – 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/5cf352bb-a6ae-4425-b276-a20fbfff45f7/results/436532/?format=api

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

{
    "url": "https://demo.lizard.net/api/v4/scenarios/5cf352bb-a6ae-4425-b276-a20fbfff45f7/results/436532/?format=api",
    "id": 436532,
    "name": "Water depth (timeseries)",
    "code": "depth-dtri",
    "description": null,
    "family": "Basic",
    "raster": "https://demo.lizard.net/api/v4/rasters/4c75e2b2-1a87-438d-a217-f9373f9d5399/?format=api",
    "attachment_url": null,
    "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5cf352bb-a6ae-4425-b276-a20fbfff45f7/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T123501Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c34493104ddc14870fe9238815ec571cb9ed7af21ce35e15553572fd563ed9cb"
}