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/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/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/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/results/454712/?format=api",
            "id": 454712,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/42c120b9-c432-4747-bafa-fcc2f2cee250/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T061949Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=860dd600c1e8fa11126b049e823d99a61c946066ef05905a3824e5e587ff09fc"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/results/454713/?format=api",
            "id": 454713,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/1c3cf016-e141-4ac1-a348-bbf6de584e73/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T061949Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f32c11ce06c4dc9c5d454cbf0d6b854eaff5773a9d292528f268145b85635007"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/results/454714/?format=api",
            "id": 454714,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/f62fec87-94d7-4f4a-96c1-53287e7f083b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T061949Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=868ac5c0b9b4da5e27cb2277d3a950c97b47a3e7035156e60d834ccf0d302ad3"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/results/454715/?format=api",
            "id": 454715,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c4470f2f-b351-48a4-bec0-19d6e20a2938/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T061949Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=81a1a13e9f59a2c6ed8ee3b129b7919eae284f167837d4b557f56f62a22d7d06"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/results/454716/?format=api",
            "id": 454716,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/f0fd3254-37d2-481c-883e-e680c0945793/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T061949Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=dd6f69ef5d991585661c6d13bedccfd1ba27de34d3d5363a85b00a8944c0822a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/results/454717/?format=api",
            "id": 454717,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/309a4600-0a5b-42d3-b103-9b155792a59d/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T061949Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7705b694f5358e234c8282d5c700fdadd1ae425f96a8c22030f3d40bd17bc66a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/results/454718/?format=api",
            "id": 454718,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/e54db3bc-af65-490c-93e2-9aaa6374c5cc/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T061949Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4df2a4e2141f20eae308b9be97c90722297c2ef9a65f6e63cc4d1fec6e16f45c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/results/454719/?format=api",
            "id": 454719,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/99843594-210e-4bf4-8aa6-2ed4753e9fb5/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d64991e3-ca59-4a93-916c-83d7e6f1d5c0/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T061949Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=96d3a04a2a02b0b552e85b6be7540f665097f03985add014db129c621678ad44"
        }
    ]
}