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/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/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/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/results/448023/?format=api",
            "id": 448023,
            "name": "Grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/448023/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/results/448024/?format=api",
            "id": 448024,
            "name": "Raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/448024/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/results/448025/?format=api",
            "id": 448025,
            "name": "Calculation core logging",
            "code": "logfiles",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/448025/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/results/448026/?format=api",
            "id": 448026,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/719f529f-9e81-49eb-8e5f-0a5fe4b8ad03/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191820Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=cfdbc3f3e36b0624e53d17c46cd542ef0e65b6ba47ee676f3da682fc093ba142"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/results/448027/?format=api",
            "id": 448027,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/5f07c6c3-fe8b-4c40-9fd0-72c41fd867e4/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191820Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=53dc01d170fb0553569cb0395e98c0e14669bdeaa124e3468856463972eca5c8"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/results/448028/?format=api",
            "id": 448028,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/057080bc-843d-4305-93fb-0aee1e1beb95/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191820Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=21d3a99f2a5990c2a235dca77f6495859f3103c2788a6d03b184d87ebc87a103"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/results/448029/?format=api",
            "id": 448029,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/32d3f06d-1f1b-4d8e-a4ed-d9550f709676/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191820Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a57cc19a49003137532313cbf86c9188a27966dd183a7392f151ef9275c15ab3"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/results/448030/?format=api",
            "id": 448030,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/bf4e2b7e-733e-4e28-9697-fd6d7d2e80ad/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191820Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4c290111057f74b7135cc93cb856bf750f945118c8d42195adb0960d505bec57"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/results/448031/?format=api",
            "id": 448031,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c91c2d4e-cc71-4c7a-9dd2-067142e25937/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191820Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=abed260adb0f763572b30d46ac2637b7cb9c7889f8a0a550cd9d7ddff132e89d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/results/448032/?format=api",
            "id": 448032,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c0b4d732-9a96-49a5-95a9-b1546cebc6d0/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T191820Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4a6caade4b13e0e6715963c8761101b725cfe4818bc0d9d24f33bb2d4fcdb29a"
        }
    ]
}