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/ab0784f7-ef67-41b4-b565-373bfa8db2a6/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/ab0784f7-ef67-41b4-b565-373bfa8db2a6/results/?format=api",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/results/449497/?format=api",
            "id": 449497,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/15bcb44d-3997-4ab4-ae6d-d9c1aae73244/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T110618Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f3d5ffc265ecf316853d166b26ae9edd568a2e3e5922a37f1ffafaf8226bf054"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/results/449498/?format=api",
            "id": 449498,
            "name": "Arrival time",
            "code": "depth-first-dtri",
            "description": null,
            "family": "Arrival",
            "raster": "https://demo.lizard.net/api/v4/rasters/d56973dc-0cfa-43d4-87d0-1bd74a8d7551/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/depth-first-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T110618Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a2892a467ad6bdfff6f9dd118d85fd261a91db375a79d25b76e18e2e7ff519e0"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/results/449501/?format=api",
            "id": 449501,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/449501/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/results/449510/?format=api",
            "id": 449510,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/39f6308b-013a-4572-945e-f13c052104c9/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T110618Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=63d4c42398842c5d110e958e5b3609543cadaa4eff557138d1250d31be064711"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/results/449511/?format=api",
            "id": 449511,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/3edb1427-fe65-4e3c-a6e7-b809a7a68632/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T110618Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7f85a5a15c05d2e3da13a54dcda5da64ca3cdbfdeb13b828a19be2e9cb36d849"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/results/449512/?format=api",
            "id": 449512,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/7d6aaba4-6727-48ad-a3c2-3984b96ecfbf/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T110618Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=dfa5e9b2dc8779f32b6d90af32e078d796d0e26559ad2a22eb4515478311a045"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/results/449513/?format=api",
            "id": 449513,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/424ac232-99ef-48b4-85cf-d85c226e1dd4/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T110618Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6864f23d44f2c209469ad7a0ff8fbd1645fff564103dddbc8fe2695d1039c4eb"
        }
    ]
}