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/b7b9155e-5df1-4c47-aa6a-f51a54bbfc81/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/b7b9155e-5df1-4c47-aa6a-f51a54bbfc81/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b7b9155e-5df1-4c47-aa6a-f51a54bbfc81/results/263191/?format=api",
            "id": 263191,
            "name": "grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263191/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b7b9155e-5df1-4c47-aa6a-f51a54bbfc81/results/263192/?format=api",
            "id": 263192,
            "name": "raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263192/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b7b9155e-5df1-4c47-aa6a-f51a54bbfc81/results/263193/?format=api",
            "id": 263193,
            "name": "calculation core logging",
            "code": "logfiles",
            "description": "",
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263193/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b7b9155e-5df1-4c47-aa6a-f51a54bbfc81/results/263194/?format=api",
            "id": 263194,
            "name": "aggregated 3Di output",
            "code": "aggregate-results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263194/aggregate_results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b7b9155e-5df1-4c47-aa6a-f51a54bbfc81/results/263195/?format=api",
            "id": 263195,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": "Water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/e7028d3d-cd47-4dc2-836f-ef6f13a1e975/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b7b9155e-5df1-4c47-aa6a-f51a54bbfc81/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T121518Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=19916554ab8be2553304958d6aee18efc47430ada79f9c4d812bc7a503672da1"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b7b9155e-5df1-4c47-aa6a-f51a54bbfc81/results/263196/?format=api",
            "id": 263196,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": "Max water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/89268516-4f97-4f9d-b298-0c98ec60ea96/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b7b9155e-5df1-4c47-aa6a-f51a54bbfc81/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T121518Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5edf625789e43c2bbf8196860a25eaae6007b9a4de3868f64a553b573d3d9751"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b7b9155e-5df1-4c47-aa6a-f51a54bbfc81/results/263197/?format=api",
            "id": 263197,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": "Flood hazard rating",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/98d2cb86-7482-44da-8379-8e5e8886328d/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b7b9155e-5df1-4c47-aa6a-f51a54bbfc81/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T121518Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=38ecdb54faf11bc7b64954c6eaf4bb660e858608e28f0f77620b95c81e4b786d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b7b9155e-5df1-4c47-aa6a-f51a54bbfc81/results/263198/?format=api",
            "id": 263198,
            "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/0809be86-0bde-4c21-a19b-5a4c23ad9fd3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b7b9155e-5df1-4c47-aa6a-f51a54bbfc81/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T121518Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7a5ba5c7b0cd079f13b5b627dc14c1835ab099124bdcf27b69b2908a30b8b6d5"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b7b9155e-5df1-4c47-aa6a-f51a54bbfc81/results/263199/?format=api",
            "id": 263199,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": "Water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b2c79f1b-c054-4c51-9579-fcdb1f23a492/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b7b9155e-5df1-4c47-aa6a-f51a54bbfc81/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T121518Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=30fec25052bb2e09803b038b31f3bc95702a2e3bf99236969457136cd64ca4b7"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b7b9155e-5df1-4c47-aa6a-f51a54bbfc81/results/263200/?format=api",
            "id": 263200,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": "Max water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/cd02f47e-d17d-4dda-9b4a-8763a9c41313/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b7b9155e-5df1-4c47-aa6a-f51a54bbfc81/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T121518Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6027fec226e0bb8006071e5c3810601ddb6b462bc7d474bce1fdee84830c8d60"
        }
    ]
}