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/6f9ec418-ad43-4df1-85dd-8c0f2370f201/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/6f9ec418-ad43-4df1-85dd-8c0f2370f201/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/results/441577/?format=api",
            "id": 441577,
            "name": "Grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/441577/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/results/441578/?format=api",
            "id": 441578,
            "name": "Raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/441578/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/results/441579/?format=api",
            "id": 441579,
            "name": "Calculation core logging",
            "code": "logfiles",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/441579/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/results/441580/?format=api",
            "id": 441580,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/06778946-1f91-4c34-998f-90bfb7c745b2/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T190237Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=aa33128c6257748f226811f79916b9f3f848712f407d28793b5c2a51fa08c118"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/results/441581/?format=api",
            "id": 441581,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/85869d80-07fd-48fa-a7f9-182c67a62575/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T190237Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ac484eeee0c946881512353f8e7986d9c1b49cd9863d175cf94360c80b6b0b5a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/results/441582/?format=api",
            "id": 441582,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/79edaf43-3632-44a1-8dcb-d2af0dcf5b05/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T190237Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=090e38878cb2c466d210b6337b0ee89b5d3eb9e9687fa3c4710a4f5d508e25aa"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/results/441583/?format=api",
            "id": 441583,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/814f57d2-183e-406c-a153-fe646ff05ce6/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T190237Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=94bae7541159b4d7df6b3449db32e76ca58d36a5b4f50be85ae3936c0fc16a52"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/results/441584/?format=api",
            "id": 441584,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/49b792ed-9aee-4d7b-b0c7-332bf8c7d8a8/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T190237Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d8e34769c3b3dce6f1802221095b6d81a1dd80c8489bb540bdae759d1aa27493"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/results/441585/?format=api",
            "id": 441585,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/e44143ca-87ea-4c18-9455-998d10e534a5/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T190237Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0948a8f0895101b7d99af13ae0258620a026b2f431b9adc1b5136a173c318868"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/results/441586/?format=api",
            "id": 441586,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/3f3bfc41-0475-419b-98b5-d7711a5a7db0/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T190237Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e4f35493f86b8ba83bcab3989bded8d25d123d5ba6387c9d664580873e3eec3d"
        }
    ]
}