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/e4f63032-4d58-44ef-9fc5-697c6e5ee21f/results/?format=api
HTTP 200 OK
Allow: GET, POST, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "count": 12,
    "next": "https://demo.lizard.net/api/v4/scenarios/e4f63032-4d58-44ef-9fc5-697c6e5ee21f/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e4f63032-4d58-44ef-9fc5-697c6e5ee21f/results/263063/?format=api",
            "id": 263063,
            "name": "grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263063/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e4f63032-4d58-44ef-9fc5-697c6e5ee21f/results/263064/?format=api",
            "id": 263064,
            "name": "raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263064/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e4f63032-4d58-44ef-9fc5-697c6e5ee21f/results/263065/?format=api",
            "id": 263065,
            "name": "calculation core logging",
            "code": "logfiles",
            "description": "",
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263065/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e4f63032-4d58-44ef-9fc5-697c6e5ee21f/results/263066/?format=api",
            "id": 263066,
            "name": "aggregated 3Di output",
            "code": "aggregate-results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263066/aggregate_results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e4f63032-4d58-44ef-9fc5-697c6e5ee21f/results/263083/?format=api",
            "id": 263083,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": "Water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/bae0e594-46af-4d85-904e-c923a39c8fe0/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e4f63032-4d58-44ef-9fc5-697c6e5ee21f/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T102857Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2190fdbb3b7016ea5a8e3902fcb10f258fd1b4a548f408d83ffa69f77eb11912"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e4f63032-4d58-44ef-9fc5-697c6e5ee21f/results/263084/?format=api",
            "id": 263084,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": "Max water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/29ce63a0-f8c4-4ad6-a855-11306121a1f6/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e4f63032-4d58-44ef-9fc5-697c6e5ee21f/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T102857Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7ef11c36ecd7630716ff680d634e08f99b4a78cee201d4a2c20ac14f6186c952"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e4f63032-4d58-44ef-9fc5-697c6e5ee21f/results/263085/?format=api",
            "id": 263085,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": "Flood hazard rating",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/819aa9fb-96b7-4ab2-a8ec-dcd9794d996a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e4f63032-4d58-44ef-9fc5-697c6e5ee21f/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T102857Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=cebd871d828dd1b07d8ffb686a9088726341509b90c7af3fd6277b44790452bd"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e4f63032-4d58-44ef-9fc5-697c6e5ee21f/results/263086/?format=api",
            "id": 263086,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": "Rate of rise of the water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4f06d7af-3fa8-4ddf-9a03-5a6f35514078/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e4f63032-4d58-44ef-9fc5-697c6e5ee21f/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T102857Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1d83e9b442e51bc547bce6ecc6c539b9103cf82ad74e46472bf63a71be4f0410"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e4f63032-4d58-44ef-9fc5-697c6e5ee21f/results/263087/?format=api",
            "id": 263087,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": "Water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c346a63b-1eaa-4013-b746-53af43a13b7b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e4f63032-4d58-44ef-9fc5-697c6e5ee21f/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T102857Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=bd360372a7f0aa5ba15198dd4a7bf1aba01191519c2dd10113920bed2106308f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e4f63032-4d58-44ef-9fc5-697c6e5ee21f/results/263088/?format=api",
            "id": 263088,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": "Max water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/5be124eb-1a0a-4fa2-a44a-3487120beab7/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e4f63032-4d58-44ef-9fc5-697c6e5ee21f/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T102857Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e69b150bbdf2992f680774df1b3c32433bc62ecfef61519d07c0a286be8b98f6"
        }
    ]
}