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/eb1f4d68-688e-4dbd-a339-3dac67df1aa9/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/eb1f4d68-688e-4dbd-a339-3dac67df1aa9/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/eb1f4d68-688e-4dbd-a339-3dac67df1aa9/results/454873/?format=api",
            "id": 454873,
            "name": "Grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/454873/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/eb1f4d68-688e-4dbd-a339-3dac67df1aa9/results/454874/?format=api",
            "id": 454874,
            "name": "Raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/454874/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/eb1f4d68-688e-4dbd-a339-3dac67df1aa9/results/454875/?format=api",
            "id": 454875,
            "name": "Calculation core logging",
            "code": "logfiles",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/454875/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/eb1f4d68-688e-4dbd-a339-3dac67df1aa9/results/454876/?format=api",
            "id": 454876,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/bb7f42f5-985a-411e-8501-d4499871de53/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/eb1f4d68-688e-4dbd-a339-3dac67df1aa9/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T021448Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=675f198650aa2a6020d533fa3a0237c143cafa86559554678a919b585ce8b918"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/eb1f4d68-688e-4dbd-a339-3dac67df1aa9/results/454877/?format=api",
            "id": 454877,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/e04f9703-29d3-415a-909a-d55a46003f68/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/eb1f4d68-688e-4dbd-a339-3dac67df1aa9/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T021448Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a829e061d961f49f083b70639bb6eeb773fe8985ab25f53a7ea844faf1e85eeb"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/eb1f4d68-688e-4dbd-a339-3dac67df1aa9/results/454878/?format=api",
            "id": 454878,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/ae4c0597-6a99-4448-893d-f9b2368b5b09/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/eb1f4d68-688e-4dbd-a339-3dac67df1aa9/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T021448Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=79f69dc723af48d3c3e1262a414450175469d8ef1651aff2813c73e75c646d2b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/eb1f4d68-688e-4dbd-a339-3dac67df1aa9/results/454879/?format=api",
            "id": 454879,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/e58d46de-cf3f-41eb-a6ef-98ff084f122b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/eb1f4d68-688e-4dbd-a339-3dac67df1aa9/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T021448Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0ac87b0b081782437127af9bbce4ef69bf1a92c29b34cd5c51d8577a3d76d824"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/eb1f4d68-688e-4dbd-a339-3dac67df1aa9/results/454880/?format=api",
            "id": 454880,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4ae6c31c-cc0c-48e1-93d3-aab4b8ce3d3a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/eb1f4d68-688e-4dbd-a339-3dac67df1aa9/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T021448Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b954d9a0fc7e0e216f0b0d63b36d7fd2219bdf22d7316ec874906dda7892c5f1"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/eb1f4d68-688e-4dbd-a339-3dac67df1aa9/results/454881/?format=api",
            "id": 454881,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a1544d4c-57c1-48c2-8292-4ebe8fd4f26b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/eb1f4d68-688e-4dbd-a339-3dac67df1aa9/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T021448Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=dcae4027c905b97b254bce3d2fba8b528fe1e9a0296f422482b2da3a76412b5e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/eb1f4d68-688e-4dbd-a339-3dac67df1aa9/results/454882/?format=api",
            "id": 454882,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/0634e821-82cb-4793-bffa-9ed1e739a8db/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/eb1f4d68-688e-4dbd-a339-3dac67df1aa9/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T021448Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d8bb5ab8c5b5a8f87f178acf1e0d0077b4ba5c3ca2b58a4db26822a22a7a4579"
        }
    ]
}