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/5e5c3525-7575-4561-853a-604be8f57ae1/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/5e5c3525-7575-4561-853a-604be8f57ae1/results/?format=api",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5e5c3525-7575-4561-853a-604be8f57ae1/results/453710/?format=api",
            "id": 453710,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d5183d7f-efe4-4f1f-a6ef-3d2e6394091b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5e5c3525-7575-4561-853a-604be8f57ae1/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062133Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9bb66f787123bf1d1f7450bd10822b230a66d261ae18a2fe0aa761443b8f4a4c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5e5c3525-7575-4561-853a-604be8f57ae1/results/453711/?format=api",
            "id": 453711,
            "name": "Arrival time",
            "code": "depth-first-dtri",
            "description": null,
            "family": "Arrival",
            "raster": "https://demo.lizard.net/api/v4/rasters/dc3f61cc-7010-4437-9143-9287e1013c83/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5e5c3525-7575-4561-853a-604be8f57ae1/depth-first-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062133Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0daf2c4d9c432ff0108779becd0f2aba8cc5b212268e732567fbeeb82775394b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5e5c3525-7575-4561-853a-604be8f57ae1/results/453733/?format=api",
            "id": 453733,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/453733/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5e5c3525-7575-4561-853a-604be8f57ae1/results/453734/?format=api",
            "id": 453734,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/02c7c45d-2ba2-4816-9783-ace799fb624a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5e5c3525-7575-4561-853a-604be8f57ae1/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062133Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d3ba418607d95ed3f8bf639ace082cd2c33e93838cffa5f1c200da8caba9faa2"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5e5c3525-7575-4561-853a-604be8f57ae1/results/453735/?format=api",
            "id": 453735,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/d6d1ae04-210d-431c-a8a6-a45d04f8dcdb/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5e5c3525-7575-4561-853a-604be8f57ae1/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062133Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ea7b13562a44502a611aae8c7258cbe0b37022bb18bf262a5649f59afe8946e7"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5e5c3525-7575-4561-853a-604be8f57ae1/results/453736/?format=api",
            "id": 453736,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/13ef0bb4-3c89-4739-b4da-07ba3e84f709/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5e5c3525-7575-4561-853a-604be8f57ae1/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062133Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=90b575b0da3667e424e9b95bd180b0c4bc42e01060d0f5075a220d91e105c379"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5e5c3525-7575-4561-853a-604be8f57ae1/results/453737/?format=api",
            "id": 453737,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/9a82643a-1022-4530-84e9-bb18a3e5a494/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5e5c3525-7575-4561-853a-604be8f57ae1/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062133Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=cbfd3487cea52ef1256eed534c13acac41943376f80295169f3235208ad7ddbc"
        }
    ]
}