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/7e2cb5f5-5c3b-4cc9-bad6-eac6ec63c563/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/7e2cb5f5-5c3b-4cc9-bad6-eac6ec63c563/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/7e2cb5f5-5c3b-4cc9-bad6-eac6ec63c563/results/436516/?format=api",
            "id": 436516,
            "name": "Grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/436516/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/7e2cb5f5-5c3b-4cc9-bad6-eac6ec63c563/results/436517/?format=api",
            "id": 436517,
            "name": "Raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/436517/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/7e2cb5f5-5c3b-4cc9-bad6-eac6ec63c563/results/436518/?format=api",
            "id": 436518,
            "name": "Calculation core logging",
            "code": "logfiles",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/436518/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/7e2cb5f5-5c3b-4cc9-bad6-eac6ec63c563/results/436519/?format=api",
            "id": 436519,
            "name": "Aggregated 3Di output",
            "code": "aggregate-results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/436519/aggregate_results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/7e2cb5f5-5c3b-4cc9-bad6-eac6ec63c563/results/436520/?format=api",
            "id": 436520,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/01bb28e6-8fad-4159-9d16-a89c3a472b15/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/7e2cb5f5-5c3b-4cc9-bad6-eac6ec63c563/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T042416Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=29a608502a8d2aabd0b97719d4b47ea5e81cb63bad844f25d28ad72e783ba82d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/7e2cb5f5-5c3b-4cc9-bad6-eac6ec63c563/results/436521/?format=api",
            "id": 436521,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/87fd8dd3-bf4e-4e26-a506-37f10262af1d/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/7e2cb5f5-5c3b-4cc9-bad6-eac6ec63c563/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T042416Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=68f531d96749ebc1ccc9aa8eeabe42927c1429d039fe056db757933110ccb146"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/7e2cb5f5-5c3b-4cc9-bad6-eac6ec63c563/results/436522/?format=api",
            "id": 436522,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/3e988175-b1c8-457a-9459-0ba24bf7850f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/7e2cb5f5-5c3b-4cc9-bad6-eac6ec63c563/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T042416Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8ef23f1d6af07385948e13cedccccb577e97117169abd71bc6b9564ade7b4c74"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/7e2cb5f5-5c3b-4cc9-bad6-eac6ec63c563/results/436523/?format=api",
            "id": 436523,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/9a8277e6-9175-402e-85e9-8468c6e81650/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/7e2cb5f5-5c3b-4cc9-bad6-eac6ec63c563/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T042416Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5ad7241dd0b44cfa8f7bd03f0d68c33bd74320744505002e38f672b719d07c96"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/7e2cb5f5-5c3b-4cc9-bad6-eac6ec63c563/results/436524/?format=api",
            "id": 436524,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/8eb76024-243e-4c1f-ba36-3a8174ed55b4/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/7e2cb5f5-5c3b-4cc9-bad6-eac6ec63c563/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T042416Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=74cf85a3c8e9486a4433fa07256493dce3de7e66ac3eadb34f85bd5862c49749"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/7e2cb5f5-5c3b-4cc9-bad6-eac6ec63c563/results/436525/?format=api",
            "id": 436525,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/0e08b75e-0ff0-4e7e-9c72-27d619f3b772/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/7e2cb5f5-5c3b-4cc9-bad6-eac6ec63c563/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T042416Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7d56ebbea541f228175d8941f1de638e2b7bf0b8872ba6dc4289b9d49848cc2b"
        }
    ]
}