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/220d2115-4b4d-43ba-8872-7101b2e9a0b7/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/220d2115-4b4d-43ba-8872-7101b2e9a0b7/results/?format=api",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/220d2115-4b4d-43ba-8872-7101b2e9a0b7/results/385169/?format=api",
            "id": 385169,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/edfc2961-45e2-4c1e-a5d7-d71e399d5f5a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/220d2115-4b4d-43ba-8872-7101b2e9a0b7/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T120712Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c32b741f2bf03215205e6dd7c7c5a99b8b2316a7a6f8cd40f47ec3e25c3680e2"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/220d2115-4b4d-43ba-8872-7101b2e9a0b7/results/385170/?format=api",
            "id": 385170,
            "name": "Arrival time",
            "code": "depth-first-dtri",
            "description": null,
            "family": "Arrival",
            "raster": "https://demo.lizard.net/api/v4/rasters/5b8d642f-2487-48db-bdcf-463b44200715/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/220d2115-4b4d-43ba-8872-7101b2e9a0b7/depth-first-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T120712Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8818d292b8dcc4a754dbd974e7ef385569fc7c6229624845d125ae7ecd283d66"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/220d2115-4b4d-43ba-8872-7101b2e9a0b7/results/385175/?format=api",
            "id": 385175,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/385175/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/220d2115-4b4d-43ba-8872-7101b2e9a0b7/results/385176/?format=api",
            "id": 385176,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/ac1c90b6-8d07-43ee-af95-2a5b4be6ba24/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/220d2115-4b4d-43ba-8872-7101b2e9a0b7/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T120712Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0c53cbc9aa10a95106531c5e8ff32dbe53b04fd6ae77292cbb3c7b3b0af871a3"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/220d2115-4b4d-43ba-8872-7101b2e9a0b7/results/385177/?format=api",
            "id": 385177,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/4854a342-0ee1-442c-9f1f-8a3d7256af75/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/220d2115-4b4d-43ba-8872-7101b2e9a0b7/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T120712Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=75f2555feba99a12c74a18d8d59eeb7aea041b3933ef3ed5c4b1753c8038b168"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/220d2115-4b4d-43ba-8872-7101b2e9a0b7/results/385178/?format=api",
            "id": 385178,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/993b50ea-dd7b-4a50-b903-0df241b3024c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/220d2115-4b4d-43ba-8872-7101b2e9a0b7/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T120712Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1ce3f3c7a0b35fe6bfd82c6989c1e4f6b93d30d246f964ceae70c7290592180d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/220d2115-4b4d-43ba-8872-7101b2e9a0b7/results/385179/?format=api",
            "id": 385179,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/e88942d6-3715-4abc-8bd7-2513e0a8862a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/220d2115-4b4d-43ba-8872-7101b2e9a0b7/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T120712Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b5a3005f96cdc2bea5535d10ef4a29adc25d5a20e53dd45303071290e8acb543"
        }
    ]
}