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/94b50294-3a0f-4d0b-a642-f8ca4b029b44/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/94b50294-3a0f-4d0b-a642-f8ca4b029b44/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/94b50294-3a0f-4d0b-a642-f8ca4b029b44/results/263379/?format=api",
            "id": 263379,
            "name": "grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263379/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/94b50294-3a0f-4d0b-a642-f8ca4b029b44/results/263380/?format=api",
            "id": 263380,
            "name": "raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263380/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/94b50294-3a0f-4d0b-a642-f8ca4b029b44/results/263381/?format=api",
            "id": 263381,
            "name": "calculation core logging",
            "code": "logfiles",
            "description": "",
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263381/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/94b50294-3a0f-4d0b-a642-f8ca4b029b44/results/263382/?format=api",
            "id": 263382,
            "name": "aggregated 3Di output",
            "code": "aggregate-results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263382/aggregate_results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/94b50294-3a0f-4d0b-a642-f8ca4b029b44/results/263391/?format=api",
            "id": 263391,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": "Water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/82efb462-2c95-46e4-98c1-ec02f8debaa3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/94b50294-3a0f-4d0b-a642-f8ca4b029b44/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T190455Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=336d684a1905d704602007448c42324a04f36049fe9b879de035bb0dd5cd2c8d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/94b50294-3a0f-4d0b-a642-f8ca4b029b44/results/263392/?format=api",
            "id": 263392,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": "Max water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/ff432930-0708-499d-a150-4986ff412495/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/94b50294-3a0f-4d0b-a642-f8ca4b029b44/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T190455Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=49a2fb77e67026d9b7e2d2674a2a54bb7c05a24cc9457627e2d2448adf6561ba"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/94b50294-3a0f-4d0b-a642-f8ca4b029b44/results/263393/?format=api",
            "id": 263393,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": "Flood hazard rating",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/af2185fa-9e31-4652-884a-19864924af15/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/94b50294-3a0f-4d0b-a642-f8ca4b029b44/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T190455Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=fbb309c7a4990149ae884b7ddd9320efb57b4e369b36858f6d580858e8219990"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/94b50294-3a0f-4d0b-a642-f8ca4b029b44/results/263394/?format=api",
            "id": 263394,
            "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/0678d6f0-4b44-400e-b73f-0bb3dd7cf8dd/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/94b50294-3a0f-4d0b-a642-f8ca4b029b44/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T190455Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=26208ff415eb872338d0659b37d83722def80de718c75b78e0dfb4fadbd953c9"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/94b50294-3a0f-4d0b-a642-f8ca4b029b44/results/263395/?format=api",
            "id": 263395,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": "Water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/404a639a-9205-46be-a311-d8efaba0830c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/94b50294-3a0f-4d0b-a642-f8ca4b029b44/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T190455Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=537eca63a82f73bdbd040c377834d65f035800aae9a80e4d0f4714bb432e419d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/94b50294-3a0f-4d0b-a642-f8ca4b029b44/results/263396/?format=api",
            "id": 263396,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": "Max water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/cf85bc76-c15c-41b6-92e4-74863109d40b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/94b50294-3a0f-4d0b-a642-f8ca4b029b44/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T190455Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=90cc28c7f2883b1ddf0137dddeccdcc7bdeccfe34e05f31249c07798225f263f"
        }
    ]
}