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/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/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/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/results/448882/?format=api",
            "id": 448882,
            "name": "Grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/448882/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/results/448883/?format=api",
            "id": 448883,
            "name": "Raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/448883/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/results/448884/?format=api",
            "id": 448884,
            "name": "Calculation core logging",
            "code": "logfiles",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/448884/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/results/448885/?format=api",
            "id": 448885,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a51d6555-5342-4d1b-a257-dcf18319acd8/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T125510Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c52652c4fb54cc27f77f4ba73aba6e7a6afcfc840ace4fa4ce338c1f5bc27250"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/results/448886/?format=api",
            "id": 448886,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/35e9112e-ae66-4963-afa1-20f9a304f4a8/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T125510Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2d3495f57dd78a17cf1f5eb9af011f2c8868292bc33563749fffdb928d149144"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/results/448887/?format=api",
            "id": 448887,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/287af6d7-25db-45b7-bb99-d1238cb8bca2/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T125510Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=435fba7b809bd4734e267ca0babbcdbd011604ad587d07321759b9ff3d1b4579"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/results/448888/?format=api",
            "id": 448888,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/f0f09c68-f26a-452f-9bd9-b3be530f5576/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T125510Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b66ab81fd54ad5dfd81c09df5cda3ce89ce4fbfd1d1b364b9106ba493be5c638"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/results/448889/?format=api",
            "id": 448889,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4cbb9c80-65b9-4f62-ba32-ead20d56b592/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T125510Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3fe94ce5e36f728388da0899f45eecb25f13a260c269e164ee6f37d2f4c19509"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/results/448890/?format=api",
            "id": 448890,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/6933c74a-6ec4-4062-ac74-bba7556ca377/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T125510Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8180934af8cf3c56b68f06e4a36e0c369a2d46bdf0d8f9cd1971db0d197b86c8"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/results/448891/?format=api",
            "id": 448891,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/9d761f0e-9cc0-4fa1-8080-f0031ed26b32/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T125510Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=53c72e56cbe492f096913d6513458e2fe28eece16a4469c61a16e37599f833c8"
        }
    ]
}