Result List – 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/fa2ecba3-7f32-4d27-9eaa-0f6f6c1f694b/results/?format=api&page=2

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

{
    "count": 13,
    "next": null,
    "previous": "https://demo.lizard.net/api/v4/scenarios/fa2ecba3-7f32-4d27-9eaa-0f6f6c1f694b/results/?format=api",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/fa2ecba3-7f32-4d27-9eaa-0f6f6c1f694b/results/439833/?format=api",
            "id": 439833,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/354e8059-3c85-47d0-badc-24cd5685ea52/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/fa2ecba3-7f32-4d27-9eaa-0f6f6c1f694b/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T075348Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=df960437e007994e823da51912c28112fbc637d97d4873d9f2e8c26ab265815d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/fa2ecba3-7f32-4d27-9eaa-0f6f6c1f694b/results/439858/?format=api",
            "id": 439858,
            "name": "Arrival time",
            "code": "depth-first-dtri",
            "description": null,
            "family": "Arrival",
            "raster": "https://demo.lizard.net/api/v4/rasters/4fbd36bb-b255-4b56-8d0c-a8d72188f31b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/fa2ecba3-7f32-4d27-9eaa-0f6f6c1f694b/depth-first-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T075348Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4e00e1d9908bc659d4ee0eb30364ab258de784044027b89c76cb9f99ed22c5b5"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/fa2ecba3-7f32-4d27-9eaa-0f6f6c1f694b/results/439867/?format=api",
            "id": 439867,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/439867/damage-summary.csv?format=api",
            "upload_url": null
        }
    ]
}