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/4f537e62-4489-4dc1-9d67-13eee1e0965a/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/4f537e62-4489-4dc1-9d67-13eee1e0965a/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4f537e62-4489-4dc1-9d67-13eee1e0965a/results/449595/?format=api",
            "id": 449595,
            "name": "Grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/449595/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4f537e62-4489-4dc1-9d67-13eee1e0965a/results/449596/?format=api",
            "id": 449596,
            "name": "Raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/449596/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4f537e62-4489-4dc1-9d67-13eee1e0965a/results/449597/?format=api",
            "id": 449597,
            "name": "Calculation core logging",
            "code": "logfiles",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/449597/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4f537e62-4489-4dc1-9d67-13eee1e0965a/results/449598/?format=api",
            "id": 449598,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2ecef7c8-3174-4e76-8f3a-83610b9a973b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4f537e62-4489-4dc1-9d67-13eee1e0965a/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T073223Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e2d5d6861b7cdb7118e6eaf3c93c91f78681eee1fb21697c632c9526ba24740e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4f537e62-4489-4dc1-9d67-13eee1e0965a/results/449599/?format=api",
            "id": 449599,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/dab6554f-23c6-46e8-9f43-bdfd32d900c3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4f537e62-4489-4dc1-9d67-13eee1e0965a/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T073223Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=50e3a7edcf5158a2a241de1c2ea0c91bc9b16c6e51a84eba728b3057f7765ab5"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4f537e62-4489-4dc1-9d67-13eee1e0965a/results/449600/?format=api",
            "id": 449600,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/6c8b39bd-fffa-4a0a-95fd-886f858f7368/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4f537e62-4489-4dc1-9d67-13eee1e0965a/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T073223Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=234ad91fe59bd98cdef44f11314d7023da2b934575f909dc767bfe042a00b186"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4f537e62-4489-4dc1-9d67-13eee1e0965a/results/449601/?format=api",
            "id": 449601,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/84af3b84-9f54-442f-9dce-10a7fdda8948/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4f537e62-4489-4dc1-9d67-13eee1e0965a/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T073223Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e0825732afb24752e7fb4de38a777f802eb662c8cfadc5513da654e834f37165"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4f537e62-4489-4dc1-9d67-13eee1e0965a/results/449602/?format=api",
            "id": 449602,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/e50b9a41-03d4-4f25-9b1d-e0685138873b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4f537e62-4489-4dc1-9d67-13eee1e0965a/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T073223Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=790b4fadfb6a9f20813cf76f5cf17089f77eb77915901886372ac1175240b2bc"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4f537e62-4489-4dc1-9d67-13eee1e0965a/results/449603/?format=api",
            "id": 449603,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/587a6f0d-b5d2-4b58-b299-78b5e470ccc0/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4f537e62-4489-4dc1-9d67-13eee1e0965a/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T073223Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=abe1000585031a608782a69bc58c23a76e8abfc461d76ea4b8752c59b6aeabd4"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4f537e62-4489-4dc1-9d67-13eee1e0965a/results/449604/?format=api",
            "id": 449604,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/18c5a755-f147-4c88-8acb-c433e7301f23/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4f537e62-4489-4dc1-9d67-13eee1e0965a/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T073223Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ac144be133ed7af6c8039ba088cee39e3f7faccdc3ebdc7be2e198f125411e68"
        }
    ]
}