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/4452e49a-f37d-4d7f-8f18-fce463172051/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/4452e49a-f37d-4d7f-8f18-fce463172051/results/494582/?format=api",
            "id": 494582,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/74dbba5d-225b-4228-96b3-b6b920820133/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4452e49a-f37d-4d7f-8f18-fce463172051/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T142438Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=664c6aa91ecd06bd625da8cb86e7a29c4d84dc93d1395ecc4b3435192ce08c51"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4452e49a-f37d-4d7f-8f18-fce463172051/results/494583/?format=api",
            "id": 494583,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/976e4870-de97-43ac-b72d-9d4db3176b30/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4452e49a-f37d-4d7f-8f18-fce463172051/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T142438Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e62480f160f6f58e075b2a423eab98f181d8d6cb6bfc74c7e14778b18183f139"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4452e49a-f37d-4d7f-8f18-fce463172051/results/494584/?format=api",
            "id": 494584,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/68e44d66-04d2-480b-a772-997ae0365137/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4452e49a-f37d-4d7f-8f18-fce463172051/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T142438Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e1ca080bf1432d087197904770fa915cf7b76c8ab90308194e1adca63858b8a5"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4452e49a-f37d-4d7f-8f18-fce463172051/results/494585/?format=api",
            "id": 494585,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/3af319f7-5b2d-4065-9ea4-701522892f22/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4452e49a-f37d-4d7f-8f18-fce463172051/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T142438Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=31d16532183246ca61203e09b9a1520e9a09e55a448ec3ba34eb90313e41a3d7"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4452e49a-f37d-4d7f-8f18-fce463172051/results/494586/?format=api",
            "id": 494586,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/341d6b1e-1572-4ead-93f4-575d5fec5e51/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4452e49a-f37d-4d7f-8f18-fce463172051/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T142438Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1096b268440242a8f5e48aa3c4712a9b31b7735a36bb82f66cf2b1f07518e5cd"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4452e49a-f37d-4d7f-8f18-fce463172051/results/494587/?format=api",
            "id": 494587,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/5838a244-bda5-41ce-8f0d-0105b820be2b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4452e49a-f37d-4d7f-8f18-fce463172051/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T142438Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=81ffb19eb255c8b65c1695c9ad6eac4fd549343f9d3e305f08e2b1e21223969f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4452e49a-f37d-4d7f-8f18-fce463172051/results/494588/?format=api",
            "id": 494588,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/f2e6fbe0-4a1f-4bcb-b75a-d057f3c88631/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4452e49a-f37d-4d7f-8f18-fce463172051/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T142438Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=039c6abf6f9f537075974bea8342d034584394599b2bddaef1a00cbd81b81b24"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4452e49a-f37d-4d7f-8f18-fce463172051/results/494589/?format=api",
            "id": 494589,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/17cde525-ee9b-43b0-9129-560ecb24a0b8/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4452e49a-f37d-4d7f-8f18-fce463172051/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T142438Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d66727853aafe6c73ed3451651bbb4e22b2e4c842bdcf4a06329fedff126e189"
        }
    ]
}