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/773499fa-69c4-4687-b166-c0c4ed2e6c27/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/773499fa-69c4-4687-b166-c0c4ed2e6c27/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/773499fa-69c4-4687-b166-c0c4ed2e6c27/results/263135/?format=api",
            "id": 263135,
            "name": "grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263135/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/773499fa-69c4-4687-b166-c0c4ed2e6c27/results/263136/?format=api",
            "id": 263136,
            "name": "raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263136/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/773499fa-69c4-4687-b166-c0c4ed2e6c27/results/263137/?format=api",
            "id": 263137,
            "name": "calculation core logging",
            "code": "logfiles",
            "description": "",
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263137/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/773499fa-69c4-4687-b166-c0c4ed2e6c27/results/263138/?format=api",
            "id": 263138,
            "name": "aggregated 3Di output",
            "code": "aggregate-results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263138/aggregate_results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/773499fa-69c4-4687-b166-c0c4ed2e6c27/results/263147/?format=api",
            "id": 263147,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": "Water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/23e9a3b7-48ad-4c0c-8910-904c93cfd20a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/773499fa-69c4-4687-b166-c0c4ed2e6c27/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T161511Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2ab800e49f07c8c668bb1d46c6f0c0bd9b4b755d9a0f12a713db561690620303"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/773499fa-69c4-4687-b166-c0c4ed2e6c27/results/263148/?format=api",
            "id": 263148,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": "Max water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/316413af-2ea3-4b8b-808e-e7a6a3a8fa7a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/773499fa-69c4-4687-b166-c0c4ed2e6c27/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T161511Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a2037b23ac405167cdee8f4f82674c4a983d4bec31129f05af39803bd6cb0456"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/773499fa-69c4-4687-b166-c0c4ed2e6c27/results/263149/?format=api",
            "id": 263149,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": "Flood hazard rating",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/55fe4781-3481-41ca-b421-f8a11f9f341f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/773499fa-69c4-4687-b166-c0c4ed2e6c27/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T161511Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5da5421e750ce0159c31784987ea95992244dcaaccdf74d5224bb78acbd4ba01"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/773499fa-69c4-4687-b166-c0c4ed2e6c27/results/263150/?format=api",
            "id": 263150,
            "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/8bba26b9-f70a-4a14-8ca2-7c4ddf93f911/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/773499fa-69c4-4687-b166-c0c4ed2e6c27/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T161511Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=77801620f593474a33b809bc2c0208ce703030ca5c23f985822c7c377140b2d6"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/773499fa-69c4-4687-b166-c0c4ed2e6c27/results/263151/?format=api",
            "id": 263151,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": "Water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c69defc8-807c-430d-b8f7-807a589c2679/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/773499fa-69c4-4687-b166-c0c4ed2e6c27/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T161511Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3fb973658d804689e557bde308126decbbdcd864dde01257cea709a3938ea6c5"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/773499fa-69c4-4687-b166-c0c4ed2e6c27/results/263152/?format=api",
            "id": 263152,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": "Max water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/70e18459-5511-4360-a5b1-b40022fefe06/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/773499fa-69c4-4687-b166-c0c4ed2e6c27/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T161511Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=92f03510ad23efdf1534f7be40d56ac1d40e93a772feb159f151047cb3ef59e3"
        }
    ]
}