Result List – Django REST framework

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/5731c1ab-7577-4f33-8474-2b96f2f821fa/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/5731c1ab-7577-4f33-8474-2b96f2f821fa/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5731c1ab-7577-4f33-8474-2b96f2f821fa/results/263119/?format=api",
            "id": 263119,
            "name": "grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263119/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5731c1ab-7577-4f33-8474-2b96f2f821fa/results/263120/?format=api",
            "id": 263120,
            "name": "raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263120/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5731c1ab-7577-4f33-8474-2b96f2f821fa/results/263121/?format=api",
            "id": 263121,
            "name": "calculation core logging",
            "code": "logfiles",
            "description": "",
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263121/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5731c1ab-7577-4f33-8474-2b96f2f821fa/results/263122/?format=api",
            "id": 263122,
            "name": "aggregated 3Di output",
            "code": "aggregate-results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263122/aggregate_results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5731c1ab-7577-4f33-8474-2b96f2f821fa/results/263123/?format=api",
            "id": 263123,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": "Water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c4e6a287-3de8-41c5-b4d2-8338031672e0/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5731c1ab-7577-4f33-8474-2b96f2f821fa/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T164752Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8d706ab76a46923f68048e5250e2cc0207614ff99cf2ef1db7a8a3e52eb650c7"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5731c1ab-7577-4f33-8474-2b96f2f821fa/results/263124/?format=api",
            "id": 263124,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": "Max water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/fd893028-36e1-4292-8207-db1b38832a5b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5731c1ab-7577-4f33-8474-2b96f2f821fa/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T164752Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6269b941dbeab9e69285b682487f87b727d9541696dbdacaf5fc0f229fd2e557"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5731c1ab-7577-4f33-8474-2b96f2f821fa/results/263125/?format=api",
            "id": 263125,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": "Flood hazard rating",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2efb4c2a-2d86-4f89-85c5-dffe12c7b2f9/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5731c1ab-7577-4f33-8474-2b96f2f821fa/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T164752Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=375847341cf8ecbf1791a1647360909884924631702a8a6866c45b4f6b203fcc"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5731c1ab-7577-4f33-8474-2b96f2f821fa/results/263126/?format=api",
            "id": 263126,
            "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/9a527b03-828c-46c5-966a-8f84d95b212f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5731c1ab-7577-4f33-8474-2b96f2f821fa/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T164752Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=20bc5614ce0395f58309845369d65175efc241a300dc74648c1eef5eac2fab24"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5731c1ab-7577-4f33-8474-2b96f2f821fa/results/263127/?format=api",
            "id": 263127,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": "Water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/63a8cad4-7c78-4c1f-9e1d-1eb5ef751550/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5731c1ab-7577-4f33-8474-2b96f2f821fa/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T164752Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=72e68bcf4e3087727fca42207bc300e2abbfaf98ca47d097901e46753f3676e0"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5731c1ab-7577-4f33-8474-2b96f2f821fa/results/263128/?format=api",
            "id": 263128,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": "Max water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/0bad96bf-f95b-4b83-bf4c-4fb47fc0b360/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5731c1ab-7577-4f33-8474-2b96f2f821fa/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T164752Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=be0b8ffb583b8858a7358084340f5103c475c89ac86b57b41e84533d76ef07f0"
        }
    ]
}