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/6f9ec418-ad43-4df1-85dd-8c0f2370f201/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/6f9ec418-ad43-4df1-85dd-8c0f2370f201/results/?format=api",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/results/441587/?format=api",
            "id": 441587,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2a03e8eb-46eb-415c-becc-fe2e5bd19b70/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010507Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a19edf9c48333ea93c34d0dd8d499e6f0b063629b690b169ebda98b3a1a762f2"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/results/441588/?format=api",
            "id": 441588,
            "name": "Arrival time",
            "code": "depth-first-dtri",
            "description": null,
            "family": "Arrival",
            "raster": "https://demo.lizard.net/api/v4/rasters/13876e45-8044-4340-9389-84a44969a497/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/depth-first-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010507Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7899222d54bf89e8640268cf7a5b74033b08e775f6128e6384ff53c9e9332a5b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/results/441605/?format=api",
            "id": 441605,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/441605/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/results/441618/?format=api",
            "id": 441618,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/8430cbda-0f6b-42b1-89ed-5777dbe1298e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010507Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b4f02483a502d32f82c3d9efa50151f7401718c03044c8f356dfe3dc56c6e39f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/results/441619/?format=api",
            "id": 441619,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/a0e05bdc-7e4a-46c5-89ed-57e393634d39/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010507Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4ff089003b121e4054cf222ee4fbb24a3903bfa422231eafe31ec942043aaca2"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/results/441620/?format=api",
            "id": 441620,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/0250b414-650a-49a4-b828-c04676fda0ea/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010507Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=419158515cc9b49e7b5978744eaca358e3e254e198cfee4ee20ecc4447038e91"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/results/441621/?format=api",
            "id": 441621,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/b7bc940e-e65d-4e09-ae68-b48c3901bfde/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010507Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6c289afc8d0d2bbc0ae64cd3f595880bae288a299c66a50030bbb87d28fee8d7"
        }
    ]
}