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/3cd9267f-a58a-4c6e-8875-9dabf36841f1/results/?format=api&page=2

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

{
    "count": 17,
    "next": null,
    "previous": "https://demo.lizard.net/api/v4/scenarios/3cd9267f-a58a-4c6e-8875-9dabf36841f1/results/?format=api",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3cd9267f-a58a-4c6e-8875-9dabf36841f1/results/447935/?format=api",
            "id": 447935,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b73fb050-a984-46c7-8598-30a82834e181/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/3cd9267f-a58a-4c6e-8875-9dabf36841f1/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T004841Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=79431e833a820772014c60e6dd15dbe0b054bd043eabfbea0a120a22ce3b782b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3cd9267f-a58a-4c6e-8875-9dabf36841f1/results/447936/?format=api",
            "id": 447936,
            "name": "Arrival time",
            "code": "depth-first-dtri",
            "description": null,
            "family": "Arrival",
            "raster": "https://demo.lizard.net/api/v4/rasters/6ff0485d-77de-4e81-8003-88583c6f78e6/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/3cd9267f-a58a-4c6e-8875-9dabf36841f1/depth-first-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T004841Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2dd41d55d50f005eb06f92ddeeb00f2fe9dd9112a51f6846341c87fe07b9e0bc"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3cd9267f-a58a-4c6e-8875-9dabf36841f1/results/447953/?format=api",
            "id": 447953,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/447953/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3cd9267f-a58a-4c6e-8875-9dabf36841f1/results/447954/?format=api",
            "id": 447954,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/a95b55be-cec5-4c84-9b43-32c69c2c0ad3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/3cd9267f-a58a-4c6e-8875-9dabf36841f1/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T004841Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a5a94740195b89898b7d74d955e379364c2e79819f0b118c8f32734f5d80d8fa"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3cd9267f-a58a-4c6e-8875-9dabf36841f1/results/447955/?format=api",
            "id": 447955,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/80c01531-4899-46e7-acd0-c56cfb8685df/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/3cd9267f-a58a-4c6e-8875-9dabf36841f1/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T004841Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=40172512c8da947117f0a8d2100fd942734dda1b5ac2247ef1f91e0cee7ddc56"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3cd9267f-a58a-4c6e-8875-9dabf36841f1/results/447956/?format=api",
            "id": 447956,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/8b05e1aa-815d-4517-9fa6-c31eac23a89b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/3cd9267f-a58a-4c6e-8875-9dabf36841f1/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T004841Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6f322ae2d0ea2a2f3552720e81110907cde0dcb5fe5fb206aa1e34d82deb889e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3cd9267f-a58a-4c6e-8875-9dabf36841f1/results/447957/?format=api",
            "id": 447957,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/e02699bf-4499-44a2-ada7-2244f096a65a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/3cd9267f-a58a-4c6e-8875-9dabf36841f1/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T004841Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e9be469f23cb076f6443d0387d0028384d43da57989bb0d0f018d8b5e9bd6115"
        }
    ]
}