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/dfb1b3ad-942e-4e6e-977c-ab2977a4901d/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/dfb1b3ad-942e-4e6e-977c-ab2977a4901d/results/263367/?format=api",
            "id": 263367,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": "Water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2f6f2580-ef2f-44fa-baa4-9a282d81643d/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/dfb1b3ad-942e-4e6e-977c-ab2977a4901d/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T182505Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=956b47dd94e2594d4a59c3f81975e84f42d269f90a0c0aa9d17e849797a5e1e9"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/dfb1b3ad-942e-4e6e-977c-ab2977a4901d/results/263368/?format=api",
            "id": 263368,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": "Max water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/06c28d6a-3bde-413f-9bf1-c44681a3335e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/dfb1b3ad-942e-4e6e-977c-ab2977a4901d/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T182505Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=607bb4bd1c227b5d0bf1918241063b30eeac4d06dca22d7103422b7f6ee4fef8"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/dfb1b3ad-942e-4e6e-977c-ab2977a4901d/results/263369/?format=api",
            "id": 263369,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": "Flood hazard rating",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/5375eb85-f625-4f96-8d19-85daeb2bf261/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/dfb1b3ad-942e-4e6e-977c-ab2977a4901d/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T182505Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=804f10915f9a1c2f69f692394d7eb3adb83d020b0d7b5b981e779b494c56442c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/dfb1b3ad-942e-4e6e-977c-ab2977a4901d/results/263370/?format=api",
            "id": 263370,
            "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/4ae67baf-69dd-4122-9a50-c6497e17b24c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/dfb1b3ad-942e-4e6e-977c-ab2977a4901d/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T182505Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=55f31a3cf639642468ef8798c821e2369d2f7697e34bfe61f5cd0421cd9b2d34"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/dfb1b3ad-942e-4e6e-977c-ab2977a4901d/results/263371/?format=api",
            "id": 263371,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": "Water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/551ed36f-9ea9-4efa-83e6-683582e4aee2/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/dfb1b3ad-942e-4e6e-977c-ab2977a4901d/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T182505Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=433ee698562816e38f5fea126284bd85561e9ce8308ddf717c6e8674e47a688d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/dfb1b3ad-942e-4e6e-977c-ab2977a4901d/results/263372/?format=api",
            "id": 263372,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": "Max water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/f1804727-6a80-4007-89bb-eef37d0a1b0f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/dfb1b3ad-942e-4e6e-977c-ab2977a4901d/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T182505Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=81991088620136f85255457b7d957dfb6cfeb299aeec8a74be0037e23ef2949a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/dfb1b3ad-942e-4e6e-977c-ab2977a4901d/results/263373/?format=api",
            "id": 263373,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": "Max flow velocity",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/5c035461-605c-40dc-94ff-0bca50f7c01c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/dfb1b3ad-942e-4e6e-977c-ab2977a4901d/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T182505Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4f269351c292f962805976dea962f00a26ea0ee6a7ee5c9c900e4a97fe5743ad"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/dfb1b3ad-942e-4e6e-977c-ab2977a4901d/results/263374/?format=api",
            "id": 263374,
            "name": "Rain",
            "code": "rain-quad",
            "description": "Rain",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/809d9fe8-8e22-4bbe-a804-4c9ef7c11671/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/dfb1b3ad-942e-4e6e-977c-ab2977a4901d/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T182505Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2e29db79af0b7af928f943758da5fc9f8480c9c4e70ec6f0f496ed21c2442315"
        }
    ]
}