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/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/results/?format=api&page=2

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

{
    "count": 16,
    "next": null,
    "previous": "https://demo.lizard.net/api/v4/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/results/?format=api",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/results/440172/?format=api",
            "id": 440172,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/836b9b72-3f5f-4f66-9596-80b35bdf1c00/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T001558Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4329da219ce2687ec2534a8df599fa69adcd775fd7def9e4e99c54ce1f6c40d6"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/results/440173/?format=api",
            "id": 440173,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/440173/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/results/440182/?format=api",
            "id": 440182,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/01c728fd-5ab9-4f2b-a2e2-1fce042c0161/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T001558Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=bcb1dc6aaf34356fe6a54fb389f60d196a272a190da4c11e21d2fb71809ba0b3"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/results/440183/?format=api",
            "id": 440183,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/87b6f876-0e67-49cd-b4b3-590b533a6bd3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T001558Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=08f9aa7a25797d9557170a60b12d879f5d024bac103ea94776e427c6fe93d251"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/results/440184/?format=api",
            "id": 440184,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/ddf0960e-bbad-4127-af48-0d809adc64f2/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T001558Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a28bee5552eb3bada3fd1177ea1311ed79c3fd2e6b7f1e31ead17eb2805bb299"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/results/440185/?format=api",
            "id": 440185,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/d5440e50-2237-47e8-832c-c2f239c6a956/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T001558Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b6ca6a30c4f79cab60119ee0bf993559099612c9df4afb58f09ab1bbe21eb931"
        }
    ]
}