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/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/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/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/results/?format=api",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/results/448033/?format=api",
            "id": 448033,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/350d9e86-0d56-4b27-b630-1bf125a16546/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011907Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=873a1cc64baf7a9ad039be4cf5c86c9d616cdc891f43d27d31342a947cbfd8fb"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/results/448034/?format=api",
            "id": 448034,
            "name": "Arrival time",
            "code": "depth-first-dtri",
            "description": null,
            "family": "Arrival",
            "raster": "https://demo.lizard.net/api/v4/rasters/6c9f42b5-a038-4964-8cce-c134221a8cc1/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/depth-first-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011907Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9d911a05af08845746b86f4597028f504a7d9613e28f1bf248efe41711b8a361"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/results/448035/?format=api",
            "id": 448035,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/448035/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/results/448036/?format=api",
            "id": 448036,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/37eb2531-eb73-4f03-b45e-8c7479d42ec6/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011907Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=edc8aae315d743725d492636938dc815829b226e3461f94d1f088ffe6cbbb883"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/results/448037/?format=api",
            "id": 448037,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/fb1153b6-5725-4720-8a51-6044eed8e6df/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011907Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8553f63672fc40615735fab776649c712fe642fffdac5a649c4473ee7206ca0f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/results/448038/?format=api",
            "id": 448038,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/7e896fc5-dce6-4f0b-98e5-14286794d337/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011907Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1f09fbd7dd9f144e72e5cd23a8a539feee03a53251b0f6bd8a4fa56fca01e481"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/results/448039/?format=api",
            "id": 448039,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/f6ce5c49-a36e-45cf-b1e9-69ee2c619f99/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011907Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e7faae3889fbf7e26fcbb158ac4879b2ea1aaa00176ef36d1688b587190ed87b"
        }
    ]
}