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/b7c17c81-5854-4496-abd6-45fb75566f23/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/b7c17c81-5854-4496-abd6-45fb75566f23/results/?format=api",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b7c17c81-5854-4496-abd6-45fb75566f23/results/449323/?format=api",
            "id": 449323,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2824bace-952f-4ee3-94c8-9874961e58db/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b7c17c81-5854-4496-abd6-45fb75566f23/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T161511Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4a386e442584e42efe2c3fc5e02d0ac417f615479546721aef9184b5e825d485"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b7c17c81-5854-4496-abd6-45fb75566f23/results/449354/?format=api",
            "id": 449354,
            "name": "Arrival time",
            "code": "depth-first-dtri",
            "description": null,
            "family": "Arrival",
            "raster": "https://demo.lizard.net/api/v4/rasters/2839df70-b013-4618-958f-11e1c14d5e11/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b7c17c81-5854-4496-abd6-45fb75566f23/depth-first-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T161511Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c109a0fd2862c4d8aa18b897284c7ba15058ff9411e683ee347a339e4b0a9654"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b7c17c81-5854-4496-abd6-45fb75566f23/results/449357/?format=api",
            "id": 449357,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/449357/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b7c17c81-5854-4496-abd6-45fb75566f23/results/449366/?format=api",
            "id": 449366,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/825064f0-fe7f-44c1-8cae-1165ad446716/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b7c17c81-5854-4496-abd6-45fb75566f23/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T161511Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=659671f0b54867b5738cf55b3b26fb609cb20051db3fa92694c78272dd70e3c6"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b7c17c81-5854-4496-abd6-45fb75566f23/results/449367/?format=api",
            "id": 449367,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/eb603703-72ed-42a2-ab71-9bffb0b6b52c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b7c17c81-5854-4496-abd6-45fb75566f23/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T161511Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b48193765bf4c50982c6489719695362bdaa9968464b1593bbc09630daa27af0"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b7c17c81-5854-4496-abd6-45fb75566f23/results/449368/?format=api",
            "id": 449368,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/a9dbb270-f835-4c3c-b12d-f7867a4b2e36/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b7c17c81-5854-4496-abd6-45fb75566f23/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T161511Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f6d01328fb17634ad8513cdd9bf48ac694cf1b4e428efc67f5449a856923984f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b7c17c81-5854-4496-abd6-45fb75566f23/results/449369/?format=api",
            "id": 449369,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/138b0e5c-74ea-493f-b7f9-90cb75842e5f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b7c17c81-5854-4496-abd6-45fb75566f23/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T161511Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=fc0f6bac2c2f1e74c4b9d73fa3563d247b3fd605cc4f6004b85132af60544f8e"
        }
    ]
}