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/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/results/?format=api
HTTP 200 OK
Allow: GET, POST, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "count": 16,
    "next": "https://demo.lizard.net/api/v4/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/results/440162/?format=api",
            "id": 440162,
            "name": "Grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/440162/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/results/440163/?format=api",
            "id": 440163,
            "name": "Raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/440163/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/results/440164/?format=api",
            "id": 440164,
            "name": "Calculation core logging",
            "code": "logfiles",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/440164/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/results/440165/?format=api",
            "id": 440165,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d5804a39-3cc8-49ee-8a7d-0cf0526b78ea/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T205558Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3c3ebd288a92680c2a52e2bd3ef39f0a79e419193057215e60adc8dd50b3387e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/results/440166/?format=api",
            "id": 440166,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2751e54e-ef5c-4299-8f48-34f06dd50b62/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T205558Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7940c8cb0a330981d5064cfa67335eebcd98747bcdbb656bbc8135f4fa45a654"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/results/440167/?format=api",
            "id": 440167,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/46ca8f39-3a7c-4cc9-b94e-e2e7c97bd544/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T205558Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8f9fe93d10051b8a29d11d4b32b871618ef4570c1c351a98761ec2b8181ec61c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/results/440168/?format=api",
            "id": 440168,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/88d94d69-3072-4811-96f9-aa0f65a9050b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T205558Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f0499ef64d1c05f715f02de42c8a5402965389fce808739a8cc7f69dfd4dc100"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/results/440169/?format=api",
            "id": 440169,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/bd09e45e-9cd0-4f62-a4d4-6ce3d677ccbb/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T205558Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8c73bf5fc190f9609a74b9d8b4c29cbe5389c6d8d6d89f4dd0bd5f4d17df9c91"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/results/440170/?format=api",
            "id": 440170,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/611a3acb-fcd3-43e6-b940-71a36d01ad5f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T205558Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=aea22b39e2dd60f2d8c4050ed5e5aed5915aee701e47a942f81b7ddd3cd26327"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/results/440171/?format=api",
            "id": 440171,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c8594997-6dce-4453-b833-2a0b763e4dcd/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T205558Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c6fa357bb947dee72d691f613b0b5a5c8eaac81f20822506aef1ea96f4c28aab"
        }
    ]
}