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/d303173d-9622-40f0-a1d2-fdc121f43aea/results/?format=api
HTTP 200 OK
Allow: GET, POST, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "count": 17,
    "next": "https://demo.lizard.net/api/v4/scenarios/d303173d-9622-40f0-a1d2-fdc121f43aea/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d303173d-9622-40f0-a1d2-fdc121f43aea/results/449629/?format=api",
            "id": 449629,
            "name": "Grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/449629/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d303173d-9622-40f0-a1d2-fdc121f43aea/results/449630/?format=api",
            "id": 449630,
            "name": "Raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/449630/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d303173d-9622-40f0-a1d2-fdc121f43aea/results/449631/?format=api",
            "id": 449631,
            "name": "Calculation core logging",
            "code": "logfiles",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/449631/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d303173d-9622-40f0-a1d2-fdc121f43aea/results/449632/?format=api",
            "id": 449632,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/787bf3e1-c820-4154-bee9-f50d7c1075d9/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d303173d-9622-40f0-a1d2-fdc121f43aea/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T073630Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9cbecda35ac248c22b4dcd2acb39ea6160dc44eb821946622bc88a533a6f7d24"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d303173d-9622-40f0-a1d2-fdc121f43aea/results/449633/?format=api",
            "id": 449633,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/8c4a9a13-015f-4f28-8bef-dfdaab0b5346/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d303173d-9622-40f0-a1d2-fdc121f43aea/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T073630Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2cf0eb1f9e7cc2c7c02729a67ffe93c56ad0c69c2b84210074996cbe23c2c475"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d303173d-9622-40f0-a1d2-fdc121f43aea/results/449634/?format=api",
            "id": 449634,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/17f4de54-9de6-4abc-a1ca-9ff22be2ef1f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d303173d-9622-40f0-a1d2-fdc121f43aea/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T073630Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=bb16ba35441b9ef65bd115e5572b65d643fd17c80d7659cc696c2fa32e44eef0"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d303173d-9622-40f0-a1d2-fdc121f43aea/results/449635/?format=api",
            "id": 449635,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/f7f8fd7c-098a-47cb-ba85-59ce8b962802/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d303173d-9622-40f0-a1d2-fdc121f43aea/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T073630Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c43b215200641971f80fb127c1c8a4d89e9a659ce7183697d9334e97da7723e1"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d303173d-9622-40f0-a1d2-fdc121f43aea/results/449636/?format=api",
            "id": 449636,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d3f75887-6e89-4c2f-804c-f37f20789739/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d303173d-9622-40f0-a1d2-fdc121f43aea/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T073630Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=418f4e1147d2be809cb7b2595a09245e73289217dab53e17f6ee70c5ab4311da"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d303173d-9622-40f0-a1d2-fdc121f43aea/results/449637/?format=api",
            "id": 449637,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/8e3c0dcd-e37e-4fd5-8f29-ded342acc869/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d303173d-9622-40f0-a1d2-fdc121f43aea/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T073630Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ccca5a526add590a97c9d3e7544606265b838299128004bd07f3cffae9d09b77"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d303173d-9622-40f0-a1d2-fdc121f43aea/results/449638/?format=api",
            "id": 449638,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c62a382f-8b77-4837-9c28-2294bcfb40b3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d303173d-9622-40f0-a1d2-fdc121f43aea/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T073630Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=838176c1156c1d93cc4d27b357701d6eec610434590de4be548be9ac3f5c2180"
        }
    ]
}