Basic – 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/7c734008-4109-43b3-865d-67e7882499b4/results/basic/?format=api

HTTP 200 OK
Allow: GET, DELETE, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "count": 8,
    "next": null,
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/7c734008-4109-43b3-865d-67e7882499b4/results/263111/?format=api",
            "id": 263111,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": "Water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/acb7c072-42ef-4cd3-8176-5c7451e2d8e2/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/7c734008-4109-43b3-865d-67e7882499b4/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T162158Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6636858133aad80cfc7b473dea387698caa61b70e02b40884075401efc669abf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/7c734008-4109-43b3-865d-67e7882499b4/results/263112/?format=api",
            "id": 263112,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": "Max water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/eb6cf49c-5621-4601-b8cc-34aa565c7bf7/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/7c734008-4109-43b3-865d-67e7882499b4/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T162158Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=fd91415443fabb29893d4cce84bca7c2b90b75bf1397a35337469ed38b9c65d1"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/7c734008-4109-43b3-865d-67e7882499b4/results/263113/?format=api",
            "id": 263113,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": "Flood hazard rating",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2291f71e-aac7-4916-ab36-9b88666fa0f1/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/7c734008-4109-43b3-865d-67e7882499b4/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T162158Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=cf39fe06fc5d279cd34982e72589d3194a6c13cee27c76c7ee586fd850784dba"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/7c734008-4109-43b3-865d-67e7882499b4/results/263114/?format=api",
            "id": 263114,
            "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/89a57d2f-5759-40b2-aceb-001c037092e0/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/7c734008-4109-43b3-865d-67e7882499b4/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T162158Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e3c9f706c402d80af34c8ce8ad16e9bd4005e9f4e9454a5d3cff41bc2598b065"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/7c734008-4109-43b3-865d-67e7882499b4/results/263115/?format=api",
            "id": 263115,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": "Water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d0aa1322-c0b1-43a6-a966-8aab2fff5e1f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/7c734008-4109-43b3-865d-67e7882499b4/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T162158Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e476305d17bf20ce1f8990b77cd8087550caf032a5a095475352e7b4fefa980c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/7c734008-4109-43b3-865d-67e7882499b4/results/263116/?format=api",
            "id": 263116,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": "Max water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a6103c45-a548-4aa6-9b11-4ca891b185f1/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/7c734008-4109-43b3-865d-67e7882499b4/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T162158Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=78707bebfcd0e95ca8ec90d9b31883bcab74241ca0f9936fee8a382296f7d202"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/7c734008-4109-43b3-865d-67e7882499b4/results/263117/?format=api",
            "id": 263117,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": "Max flow velocity",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/f48b7e3f-ccaf-4b06-81ba-9e72cc72b456/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/7c734008-4109-43b3-865d-67e7882499b4/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T162158Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=13e6be82aa23016e95766ffa94db0ce9b15d1960b9711c1e8d4be9c423c871b8"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/7c734008-4109-43b3-865d-67e7882499b4/results/263118/?format=api",
            "id": 263118,
            "name": "Rain",
            "code": "rain-quad",
            "description": "Rain",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/ab6dcd74-efb2-4f03-861b-1af161c2d258/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/7c734008-4109-43b3-865d-67e7882499b4/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T162158Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b7633d2f56d8b758eff84103835e6b85b4916c75427bdcf566fdf2b58111e5f5"
        }
    ]
}