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/3eff5477-2e19-49a0-9a8d-402a2b5821e3/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/3eff5477-2e19-49a0-9a8d-402a2b5821e3/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3eff5477-2e19-49a0-9a8d-402a2b5821e3/results/263155/?format=api",
            "id": 263155,
            "name": "grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263155/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3eff5477-2e19-49a0-9a8d-402a2b5821e3/results/263156/?format=api",
            "id": 263156,
            "name": "raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263156/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3eff5477-2e19-49a0-9a8d-402a2b5821e3/results/263157/?format=api",
            "id": 263157,
            "name": "calculation core logging",
            "code": "logfiles",
            "description": "",
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263157/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3eff5477-2e19-49a0-9a8d-402a2b5821e3/results/263158/?format=api",
            "id": 263158,
            "name": "aggregated 3Di output",
            "code": "aggregate-results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263158/aggregate_results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3eff5477-2e19-49a0-9a8d-402a2b5821e3/results/263159/?format=api",
            "id": 263159,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": "Water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/03af2c13-7174-4544-8554-bdb16990aebe/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/3eff5477-2e19-49a0-9a8d-402a2b5821e3/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T133754Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8f65c88091ce7f13b6ec84572a826ed5fcd69e9c1a8c2667d218a6c9eba1e1e0"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3eff5477-2e19-49a0-9a8d-402a2b5821e3/results/263160/?format=api",
            "id": 263160,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": "Max water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/42307f96-722e-4c5d-ae95-8b0d2718d486/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/3eff5477-2e19-49a0-9a8d-402a2b5821e3/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T133754Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3c0c9e54717fe35f0b64ae3fb17251f940a88f0fc0dd780423caf4d2762a5f9a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3eff5477-2e19-49a0-9a8d-402a2b5821e3/results/263161/?format=api",
            "id": 263161,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": "Flood hazard rating",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/69dfb373-6fd6-4a26-a092-376a54aa1d0c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/3eff5477-2e19-49a0-9a8d-402a2b5821e3/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T133754Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=cffaf8509c686d98fa80e8abb2ba7d5f3fb66d8f2ffcb4a5c55eb9cc14a8033f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3eff5477-2e19-49a0-9a8d-402a2b5821e3/results/263162/?format=api",
            "id": 263162,
            "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/5e8c801c-c459-464a-b05e-0c958c0de46e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/3eff5477-2e19-49a0-9a8d-402a2b5821e3/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T133754Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=84c500be11258688b678356fbe9885c9616aa252b2f53b9e30e4e390f941ee26"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3eff5477-2e19-49a0-9a8d-402a2b5821e3/results/263163/?format=api",
            "id": 263163,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": "Water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d1cc06d6-815f-4999-b455-db6803318a56/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/3eff5477-2e19-49a0-9a8d-402a2b5821e3/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T133754Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=786857ae7c342e63ea7c4e3d46af63d632246d11415c44c0fb1ddd6e169b8840"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3eff5477-2e19-49a0-9a8d-402a2b5821e3/results/263164/?format=api",
            "id": 263164,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": "Max water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c2568dc1-4ebb-421d-91cf-31e4e56f2a51/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/3eff5477-2e19-49a0-9a8d-402a2b5821e3/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T133754Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e2525ddf03235e2c9acdcd1d9b092beeddb446cc606976b4eeae3d02668512a8"
        }
    ]
}