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/9843da10-6e95-43d9-b2b5-99d2cd5615c7/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/9843da10-6e95-43d9-b2b5-99d2cd5615c7/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9843da10-6e95-43d9-b2b5-99d2cd5615c7/results/263203/?format=api",
            "id": 263203,
            "name": "grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263203/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9843da10-6e95-43d9-b2b5-99d2cd5615c7/results/263204/?format=api",
            "id": 263204,
            "name": "raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263204/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9843da10-6e95-43d9-b2b5-99d2cd5615c7/results/263205/?format=api",
            "id": 263205,
            "name": "calculation core logging",
            "code": "logfiles",
            "description": "",
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263205/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9843da10-6e95-43d9-b2b5-99d2cd5615c7/results/263206/?format=api",
            "id": 263206,
            "name": "aggregated 3Di output",
            "code": "aggregate-results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263206/aggregate_results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9843da10-6e95-43d9-b2b5-99d2cd5615c7/results/263207/?format=api",
            "id": 263207,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": "Water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/28324d04-da88-4cc1-a52a-4cd7b05da8cf/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9843da10-6e95-43d9-b2b5-99d2cd5615c7/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T160158Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d0e3448298b990a45fc69c33f16a27baed0c710f5c2aa9eb3caa70556abead03"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9843da10-6e95-43d9-b2b5-99d2cd5615c7/results/263208/?format=api",
            "id": 263208,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": "Max water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c4874174-eedb-4e14-9b07-06cdd23c97f4/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9843da10-6e95-43d9-b2b5-99d2cd5615c7/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T160158Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=92a945eea4ad0d4c74eccd667e3ce8a0048758f542de0ab9793749e469bccf0e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9843da10-6e95-43d9-b2b5-99d2cd5615c7/results/263209/?format=api",
            "id": 263209,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": "Flood hazard rating",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/634939e5-36a4-4f6e-96f0-ed4074fccbce/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9843da10-6e95-43d9-b2b5-99d2cd5615c7/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T160158Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=efc2146b9d2af73416e833fe2b2cacc1de96ab8dbd87d7a0ba99771c0a234444"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9843da10-6e95-43d9-b2b5-99d2cd5615c7/results/263210/?format=api",
            "id": 263210,
            "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/58a4e51a-a392-4c9a-925a-ca454d2b6cf8/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9843da10-6e95-43d9-b2b5-99d2cd5615c7/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T160158Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b262ffed0426500bf5588ebc9e59153009a8885273e8201e7f2d23da84fbc2ac"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9843da10-6e95-43d9-b2b5-99d2cd5615c7/results/263211/?format=api",
            "id": 263211,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": "Water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/ab877d02-7551-4111-8f41-d80460df8754/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9843da10-6e95-43d9-b2b5-99d2cd5615c7/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T160158Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=03227817a579553674a9eafc8ae22b7833dc97105e1f7452344dab793aab7e64"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9843da10-6e95-43d9-b2b5-99d2cd5615c7/results/263212/?format=api",
            "id": 263212,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": "Max water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/17b5daaf-7c62-4795-a38e-b0d502bfe0df/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9843da10-6e95-43d9-b2b5-99d2cd5615c7/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T160158Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=198c6e8f104c6b5a8170570916cada1e3488a7c5f380cde6022f123ae30817d4"
        }
    ]
}