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/2bcdf88d-1426-414e-a8d3-242a476cc2ab/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/2bcdf88d-1426-414e-a8d3-242a476cc2ab/results/?format=api",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2bcdf88d-1426-414e-a8d3-242a476cc2ab/results/440805/?format=api",
            "id": 440805,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/8381ea54-9bad-4bcc-844f-35d2a02d61ab/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2bcdf88d-1426-414e-a8d3-242a476cc2ab/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T002849Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9c8c195029df8b485936b4b06cdcea5a16966c9a17ab909b6509db129f80d1c3"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2bcdf88d-1426-414e-a8d3-242a476cc2ab/results/440833/?format=api",
            "id": 440833,
            "name": "Arrival time",
            "code": "depth-first-dtri",
            "description": null,
            "family": "Arrival",
            "raster": "https://demo.lizard.net/api/v4/rasters/d6388837-944e-45b2-b9bf-a64fe21787b8/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2bcdf88d-1426-414e-a8d3-242a476cc2ab/depth-first-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T002849Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0f2fbf25a68a6e3f588384578fb809f4433d4fed79e54a971a2cba97a32dbf1e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2bcdf88d-1426-414e-a8d3-242a476cc2ab/results/440851/?format=api",
            "id": 440851,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/440851/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2bcdf88d-1426-414e-a8d3-242a476cc2ab/results/440864/?format=api",
            "id": 440864,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/70e439ad-712b-4ed4-8659-2d8050b460cc/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2bcdf88d-1426-414e-a8d3-242a476cc2ab/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T002849Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6ab70aed7a761bfc796d4d41eb010959bec9959a93140f498fa7c2012622519b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2bcdf88d-1426-414e-a8d3-242a476cc2ab/results/440865/?format=api",
            "id": 440865,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/2a735e4f-78a1-40db-8ae9-0e9f0f224a2a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2bcdf88d-1426-414e-a8d3-242a476cc2ab/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T002849Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=bdc44754d445fd5236405de4fec0655b4fa82dc090f20622edfa3f9f1b8cb8a2"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2bcdf88d-1426-414e-a8d3-242a476cc2ab/results/440866/?format=api",
            "id": 440866,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/5cc71505-0ff5-4435-8299-6913cf433ecc/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2bcdf88d-1426-414e-a8d3-242a476cc2ab/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T002849Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9a239d227c4428ce4da0c69c635d5c7f786fa703f211d7361a2c5967c65d3309"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2bcdf88d-1426-414e-a8d3-242a476cc2ab/results/440867/?format=api",
            "id": 440867,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/254dd193-764f-4ea1-bbf7-37075835fbee/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2bcdf88d-1426-414e-a8d3-242a476cc2ab/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T002849Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=826a37fbcb40546762a935d7a26987afe1d8669424874e8f34d57e74d337aee7"
        }
    ]
}