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/ce52f6b0-cdfe-4612-9edc-8c1f91e349d6/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/ce52f6b0-cdfe-4612-9edc-8c1f91e349d6/results/?format=api",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ce52f6b0-cdfe-4612-9edc-8c1f91e349d6/results/441156/?format=api",
            "id": 441156,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a0359917-aaad-468d-9892-2768dc11c41a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ce52f6b0-cdfe-4612-9edc-8c1f91e349d6/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T214436Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6da6c65d44765eb569931758f9d402390e6a09b7e7f6cad4fb313e0d27f38d73"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ce52f6b0-cdfe-4612-9edc-8c1f91e349d6/results/441157/?format=api",
            "id": 441157,
            "name": "Arrival time",
            "code": "depth-first-dtri",
            "description": null,
            "family": "Arrival",
            "raster": "https://demo.lizard.net/api/v4/rasters/3f2b1b05-52b3-4130-b006-3073a7ed670a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ce52f6b0-cdfe-4612-9edc-8c1f91e349d6/depth-first-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T214436Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=396c96e9aacb7eda42394382322d2d16d86c3b886bddf529ee02d5cd6de4a207"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ce52f6b0-cdfe-4612-9edc-8c1f91e349d6/results/441183/?format=api",
            "id": 441183,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/441183/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ce52f6b0-cdfe-4612-9edc-8c1f91e349d6/results/441184/?format=api",
            "id": 441184,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/4b226e7e-77b7-45c2-ac2b-5bf1d849d6fd/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ce52f6b0-cdfe-4612-9edc-8c1f91e349d6/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T214436Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9af1a74f38aeff41b16c47dafbb70c6d727938e605d0e82775d4486137f4e6e8"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ce52f6b0-cdfe-4612-9edc-8c1f91e349d6/results/441185/?format=api",
            "id": 441185,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/647d7ebd-2f9b-4215-87da-b73a9d337070/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ce52f6b0-cdfe-4612-9edc-8c1f91e349d6/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T214436Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2d308d0635c7955866e8f5785626a7ae676a6c836ed48e802ac48083537b1c1c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ce52f6b0-cdfe-4612-9edc-8c1f91e349d6/results/441186/?format=api",
            "id": 441186,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/ee036431-2f3d-4689-8038-8e6eb5e8b324/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ce52f6b0-cdfe-4612-9edc-8c1f91e349d6/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T214436Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4cc598097130d4045ca08fb4200574884ddcd4b8dc6c730ab8974f4fedeb26f9"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ce52f6b0-cdfe-4612-9edc-8c1f91e349d6/results/441187/?format=api",
            "id": 441187,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/0ca4c65f-db1e-418e-8fff-53609d72d44b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ce52f6b0-cdfe-4612-9edc-8c1f91e349d6/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T214436Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b40ccc7608fbd98c31deff5e10687e8ed54dd4f31de040fbc8c884c61c6e22c9"
        }
    ]
}