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/21fe7c29-6ef5-4bd1-866d-9b48ff1c2015/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/21fe7c29-6ef5-4bd1-866d-9b48ff1c2015/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/21fe7c29-6ef5-4bd1-866d-9b48ff1c2015/results/263059/?format=api",
            "id": 263059,
            "name": "grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263059/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/21fe7c29-6ef5-4bd1-866d-9b48ff1c2015/results/263060/?format=api",
            "id": 263060,
            "name": "raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263060/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/21fe7c29-6ef5-4bd1-866d-9b48ff1c2015/results/263061/?format=api",
            "id": 263061,
            "name": "calculation core logging",
            "code": "logfiles",
            "description": "",
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263061/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/21fe7c29-6ef5-4bd1-866d-9b48ff1c2015/results/263062/?format=api",
            "id": 263062,
            "name": "aggregated 3Di output",
            "code": "aggregate-results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263062/aggregate_results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/21fe7c29-6ef5-4bd1-866d-9b48ff1c2015/results/263075/?format=api",
            "id": 263075,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": "Water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/1771f285-437e-4161-80e5-5325866b1f0c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/21fe7c29-6ef5-4bd1-866d-9b48ff1c2015/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T103234Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=98361b37fa019733e9ef149ac31bae1fb81a20d3b534f759581996ff6ea06e14"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/21fe7c29-6ef5-4bd1-866d-9b48ff1c2015/results/263076/?format=api",
            "id": 263076,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": "Max water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4a5ac422-973b-41a5-b045-3a53ee7a5599/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/21fe7c29-6ef5-4bd1-866d-9b48ff1c2015/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T103234Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6bebea43b6c02f54d0514b5dff99c39aabadf819728ff5a126ab67b19130f049"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/21fe7c29-6ef5-4bd1-866d-9b48ff1c2015/results/263077/?format=api",
            "id": 263077,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": "Flood hazard rating",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/85917ce5-090f-4a69-9b22-0e957724ffa8/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/21fe7c29-6ef5-4bd1-866d-9b48ff1c2015/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T103234Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=36fd66811b3712f3c25ed961571f7ff46f306040af8177d3fa2de884118e88d0"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/21fe7c29-6ef5-4bd1-866d-9b48ff1c2015/results/263078/?format=api",
            "id": 263078,
            "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/5feed025-2650-4c86-ae14-243be696cbca/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/21fe7c29-6ef5-4bd1-866d-9b48ff1c2015/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T103234Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=16e5d54895c2c38ba5980b6938d1301aeb8a5cb80aaaaabdb1f67adc3cf7b1af"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/21fe7c29-6ef5-4bd1-866d-9b48ff1c2015/results/263079/?format=api",
            "id": 263079,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": "Water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/fe5ba0d5-f2ea-4834-861f-046f3e2ad66a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/21fe7c29-6ef5-4bd1-866d-9b48ff1c2015/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T103234Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=cb037b02e966b82c5c147a3ad792e85a66afef5c4b6d73bf6237e8f09f335277"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/21fe7c29-6ef5-4bd1-866d-9b48ff1c2015/results/263080/?format=api",
            "id": 263080,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": "Max water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a0c55819-58ca-4e63-a034-8422482d9977/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/21fe7c29-6ef5-4bd1-866d-9b48ff1c2015/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T103234Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=272b45d86ea536d65e275e2f0810007473d8336153ff9e4be363efaa4346a0d4"
        }
    ]
}