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/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/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/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/results/449650/?format=api",
            "id": 449650,
            "name": "Grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/449650/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/results/449651/?format=api",
            "id": 449651,
            "name": "Raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/449651/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/results/449652/?format=api",
            "id": 449652,
            "name": "Calculation core logging",
            "code": "logfiles",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/449652/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/results/449678/?format=api",
            "id": 449678,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/881a6b61-1913-4521-b0ce-bf815b0656b9/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T021913Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b288560efd7302d0b46d00a0842f6acd99f55d74e3b7d73f542fe2a12a7db59b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/results/449679/?format=api",
            "id": 449679,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/ee328513-d6bd-44bc-8fc9-bbf7b79a5f73/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T021913Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7831baad43ef2cfc59d4f8a9279a5226347f25254822e177c2be3757eb1447ef"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/results/449680/?format=api",
            "id": 449680,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/ba06e5a7-50dc-4652-968a-37594904c69c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T021913Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b4aa2ac3b1748990febb183138499ea5d33b5b6f69ed36436a8694ca60cf49fa"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/results/449681/?format=api",
            "id": 449681,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/7049593e-8228-4cfa-a782-809c8c5351d7/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T021913Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d825bad3eba3fa374ba4123db45f0a2c8038ee103147539a0b416f1a4872a696"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/results/449682/?format=api",
            "id": 449682,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a1af030c-6278-4848-9338-ba508ee5fa7a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T021913Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e5e809caa7e4481bad17415d0a27363651eb5a941f07b8cbf02eaed874c9b65b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/results/449683/?format=api",
            "id": 449683,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/6e497628-186e-49b3-a95e-2da7f458b070/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T021913Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8f72b25a6093b8cc07109aa8c29e11662aa4167012eba56f553e2c5180e6b389"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/results/449684/?format=api",
            "id": 449684,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/405dee29-bf3b-4c76-8e85-11bdf30fdabc/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T021913Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7dd1cace7a4350478d0334071b9d2da84718cf08421f6bf8f5e13de058d7c8aa"
        }
    ]
}