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/f7791ba4-9acf-4bc9-aef3-516343150df7/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/f7791ba4-9acf-4bc9-aef3-516343150df7/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f7791ba4-9acf-4bc9-aef3-516343150df7/results/263071/?format=api",
            "id": 263071,
            "name": "grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263071/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f7791ba4-9acf-4bc9-aef3-516343150df7/results/263072/?format=api",
            "id": 263072,
            "name": "raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263072/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f7791ba4-9acf-4bc9-aef3-516343150df7/results/263073/?format=api",
            "id": 263073,
            "name": "calculation core logging",
            "code": "logfiles",
            "description": "",
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263073/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f7791ba4-9acf-4bc9-aef3-516343150df7/results/263074/?format=api",
            "id": 263074,
            "name": "aggregated 3Di output",
            "code": "aggregate-results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263074/aggregate_results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f7791ba4-9acf-4bc9-aef3-516343150df7/results/263099/?format=api",
            "id": 263099,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": "Water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/9821a9e9-a5f8-401f-9f67-b782e824edc2/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f7791ba4-9acf-4bc9-aef3-516343150df7/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T101914Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=83cfffa5664b4b7766a7276dec44031fa3d17cc9a8213fbd39dffd33946c1575"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f7791ba4-9acf-4bc9-aef3-516343150df7/results/263100/?format=api",
            "id": 263100,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": "Max water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/713d6004-5ecc-4920-9477-123b45476f2b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f7791ba4-9acf-4bc9-aef3-516343150df7/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T101914Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=50dd547cfaedfae219e48fe6cddb793bfdb34612802ef9e6f4973df6179a61a9"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f7791ba4-9acf-4bc9-aef3-516343150df7/results/263101/?format=api",
            "id": 263101,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": "Flood hazard rating",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/44231634-cc4d-42f1-88a5-823d657b8cfa/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f7791ba4-9acf-4bc9-aef3-516343150df7/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T101914Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=006233ed968019ba7ead48ac42bc4428cf0e03872b3a0fec339255bf3a7b5a8a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f7791ba4-9acf-4bc9-aef3-516343150df7/results/263102/?format=api",
            "id": 263102,
            "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/65f67dde-8195-4c12-9177-e047d2af7631/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f7791ba4-9acf-4bc9-aef3-516343150df7/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T101914Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f0e6a7cc080136e9725d461a679689ab1eda7cd44f28557c5bccedb7b5be3dae"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f7791ba4-9acf-4bc9-aef3-516343150df7/results/263103/?format=api",
            "id": 263103,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": "Water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/16529f86-9a23-400f-8910-65513a51aefd/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f7791ba4-9acf-4bc9-aef3-516343150df7/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T101914Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=77016b3481148b25ea4ffa2d439cd9444fe68298b608e5c166e759942bd58b20"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f7791ba4-9acf-4bc9-aef3-516343150df7/results/263104/?format=api",
            "id": 263104,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": "Max water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/61e6ac14-4955-4ab9-8dce-7eab1ba84413/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f7791ba4-9acf-4bc9-aef3-516343150df7/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T101914Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=282c9a8c422d2053a84c93bae90eeacc0b705d1a7ab5cf739147ccdab034cf17"
        }
    ]
}