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/aa58854a-6486-403b-a000-5ba185a52625/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/aa58854a-6486-403b-a000-5ba185a52625/results/452271/?format=api",
            "id": 452271,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2dbde28e-2d0f-478a-8c31-571f5c5becce/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/aa58854a-6486-403b-a000-5ba185a52625/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250317%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250317T030100Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=279acef61f695319927d19dd46a1e2cc947e129f7c4799415782bb902a5942ed"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/aa58854a-6486-403b-a000-5ba185a52625/results/452272/?format=api",
            "id": 452272,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/5d4fb03a-11fd-4695-838b-0a97585ea472/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/aa58854a-6486-403b-a000-5ba185a52625/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250317%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250317T030100Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a93e0282df2fd3c26ee254641745c76ff5ec30520782a6d25e814a29ca2d998f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/aa58854a-6486-403b-a000-5ba185a52625/results/452273/?format=api",
            "id": 452273,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c14cf089-8490-42b1-a89a-873f627e7e4e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/aa58854a-6486-403b-a000-5ba185a52625/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250317%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250317T030100Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ed14e698b37404ca6aba20f5278e4a9e31ef7d67d4f43659998c5e34525e003f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/aa58854a-6486-403b-a000-5ba185a52625/results/452274/?format=api",
            "id": 452274,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c4ef5a84-7837-4f1f-8f5a-44514e0da4df/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/aa58854a-6486-403b-a000-5ba185a52625/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250317%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250317T030100Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d046567bc59a3eb226b743e114038e94a22dd8d93aa9fe4a304fc5cdeee1614d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/aa58854a-6486-403b-a000-5ba185a52625/results/452275/?format=api",
            "id": 452275,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/0cb99313-8fd2-40dd-839e-f36f34c66322/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/aa58854a-6486-403b-a000-5ba185a52625/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250317%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250317T030100Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ce7f418c8345756c3903d5c57467584af10836067c0336c6cf58acb0aa4d2156"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/aa58854a-6486-403b-a000-5ba185a52625/results/452276/?format=api",
            "id": 452276,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/8f2c6f17-fe11-4d32-8662-1a6f909468ef/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/aa58854a-6486-403b-a000-5ba185a52625/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250317%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250317T030100Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=071117a58690c3332398960d22257845f31483a59bfd7658fef4629de81a1945"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/aa58854a-6486-403b-a000-5ba185a52625/results/452277/?format=api",
            "id": 452277,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a2e7a1b0-35bf-4965-ba99-f0ce0ec3e604/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/aa58854a-6486-403b-a000-5ba185a52625/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250317%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250317T030100Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=458bcf9f4506f34aa9c9d397987620416e5b80f8bdda3194aa574b6d912ef462"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/aa58854a-6486-403b-a000-5ba185a52625/results/452278/?format=api",
            "id": 452278,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a144ccb2-3421-448b-8c14-1733b9b527df/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/aa58854a-6486-403b-a000-5ba185a52625/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250317%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250317T030100Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e12c2eea04bb0fd338b84fd1ceab68b6d6e05b36f89a8d441093eb0b58decc86"
        }
    ]
}