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/e590d9ea-3c4d-4bd2-b679-6916275aa5bf/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/e590d9ea-3c4d-4bd2-b679-6916275aa5bf/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e590d9ea-3c4d-4bd2-b679-6916275aa5bf/results/263035/?format=api",
            "id": 263035,
            "name": "grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263035/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e590d9ea-3c4d-4bd2-b679-6916275aa5bf/results/263036/?format=api",
            "id": 263036,
            "name": "raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263036/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e590d9ea-3c4d-4bd2-b679-6916275aa5bf/results/263037/?format=api",
            "id": 263037,
            "name": "calculation core logging",
            "code": "logfiles",
            "description": "",
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263037/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e590d9ea-3c4d-4bd2-b679-6916275aa5bf/results/263038/?format=api",
            "id": 263038,
            "name": "aggregated 3Di output",
            "code": "aggregate-results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263038/aggregate_results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e590d9ea-3c4d-4bd2-b679-6916275aa5bf/results/263039/?format=api",
            "id": 263039,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": "Water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/7890c254-7c35-43e3-a0af-b3e638a4171c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e590d9ea-3c4d-4bd2-b679-6916275aa5bf/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T141548Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c38c26a61543324ed0a69d22ae5ca4ad712f02473fbb97aebc31856ad8fd1cbe"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e590d9ea-3c4d-4bd2-b679-6916275aa5bf/results/263040/?format=api",
            "id": 263040,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": "Max water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/856c8405-1809-4924-a6fe-e1469ed03712/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e590d9ea-3c4d-4bd2-b679-6916275aa5bf/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T141548Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6f8f2344094ce91160d25a041c9a449a131c673e784febe53d975f45e6bdd8b3"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e590d9ea-3c4d-4bd2-b679-6916275aa5bf/results/263041/?format=api",
            "id": 263041,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": "Flood hazard rating",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/58ab5f18-9647-40ed-855f-5409f90af137/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e590d9ea-3c4d-4bd2-b679-6916275aa5bf/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T141548Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4f51168623350214e7648ce52cfdcd22f49e89ba1a70578824f7d6e2ff73ca90"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e590d9ea-3c4d-4bd2-b679-6916275aa5bf/results/263042/?format=api",
            "id": 263042,
            "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/7ae2b528-f37d-46a9-8e2f-3d573a74f36d/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e590d9ea-3c4d-4bd2-b679-6916275aa5bf/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T141548Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=338c0d28a5222aa54f73d6404eeb0832a75c9ec9d8daafc05cf9ab3b5d6416e6"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e590d9ea-3c4d-4bd2-b679-6916275aa5bf/results/263043/?format=api",
            "id": 263043,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": "Water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/7aa64587-eea6-4aef-898b-422881f76360/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e590d9ea-3c4d-4bd2-b679-6916275aa5bf/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T141548Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8fb92620397b991f650a5199b908aefef84153346d9051492c413800fdbf764b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/e590d9ea-3c4d-4bd2-b679-6916275aa5bf/results/263044/?format=api",
            "id": 263044,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": "Max water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/cb563b61-2b88-44c6-9f5b-76ed26278fee/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/e590d9ea-3c4d-4bd2-b679-6916275aa5bf/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T141548Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=53f1fb4087b71140ee5a78938d5f771f7fa00da004c31f89abdc14e9645fc792"
        }
    ]
}