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/4f5a4919-4a90-45ef-afc0-3d58061966ed/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/4f5a4919-4a90-45ef-afc0-3d58061966ed/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4f5a4919-4a90-45ef-afc0-3d58061966ed/results/263047/?format=api",
            "id": 263047,
            "name": "grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263047/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4f5a4919-4a90-45ef-afc0-3d58061966ed/results/263048/?format=api",
            "id": 263048,
            "name": "raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263048/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4f5a4919-4a90-45ef-afc0-3d58061966ed/results/263049/?format=api",
            "id": 263049,
            "name": "calculation core logging",
            "code": "logfiles",
            "description": "",
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263049/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4f5a4919-4a90-45ef-afc0-3d58061966ed/results/263050/?format=api",
            "id": 263050,
            "name": "aggregated 3Di output",
            "code": "aggregate-results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263050/aggregate_results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4f5a4919-4a90-45ef-afc0-3d58061966ed/results/263051/?format=api",
            "id": 263051,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": "Water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/cd943fb7-24e3-4f67-9ed1-640bc1e2b6d4/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4f5a4919-4a90-45ef-afc0-3d58061966ed/depth-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=91206eb2e48b89e2f59703e02e3327e6a3f707aac32c0076b8dce391bbc8b7a7"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4f5a4919-4a90-45ef-afc0-3d58061966ed/results/263052/?format=api",
            "id": 263052,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": "Max water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/eebccc6d-c624-4c3a-918c-09a7f30d2018/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4f5a4919-4a90-45ef-afc0-3d58061966ed/depth-max-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=15517971338a6391c216e534b214eba17ddcf3dbcb1c97ffda688872aec9f27f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4f5a4919-4a90-45ef-afc0-3d58061966ed/results/263053/?format=api",
            "id": 263053,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": "Flood hazard rating",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c531429f-e54b-493b-b4b7-e2c6d6260603/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4f5a4919-4a90-45ef-afc0-3d58061966ed/flood-hazard-rating-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=140f5f3a2fb1b78be2f16cfc0474c5840c4197fdda2aa36b554b3a79efe21810"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4f5a4919-4a90-45ef-afc0-3d58061966ed/results/263054/?format=api",
            "id": 263054,
            "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/56fc9029-775c-4631-b8cf-ce0474b906c8/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4f5a4919-4a90-45ef-afc0-3d58061966ed/rise-velocity-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=6a57da2c91bb4d4d1d93238bb9f103061ca9264f16ea0975ba865caf8b65e2b0"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4f5a4919-4a90-45ef-afc0-3d58061966ed/results/263055/?format=api",
            "id": 263055,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": "Water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d28e28e8-462e-4c2a-bd1f-723df750b171/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4f5a4919-4a90-45ef-afc0-3d58061966ed/s1-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=ec13a66fa6ae85b108fd84ad591a911c65e1e57b129be4a85bd0a724298f3dfa"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4f5a4919-4a90-45ef-afc0-3d58061966ed/results/263056/?format=api",
            "id": 263056,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": "Max water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/95fac84c-ab6d-4e50-990f-247f38b956c7/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4f5a4919-4a90-45ef-afc0-3d58061966ed/s1-max-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=edcafa8a1c0f43f420997e0a7f797e97c23718f5c5ee7bd37cad888ead5b81f0"
        }
    ]
}