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/b8009661-9f11-4d1b-ba94-a835888e5abf/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/b8009661-9f11-4d1b-ba94-a835888e5abf/results/455434/?format=api",
            "id": 455434,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/baf3485b-47bb-4978-9183-7b6eec4b0a45/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b8009661-9f11-4d1b-ba94-a835888e5abf/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T120957Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9306d444f61a6ed08357091d7285a71467563c3e8a3e7678519aedafa4d2f02b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b8009661-9f11-4d1b-ba94-a835888e5abf/results/455435/?format=api",
            "id": 455435,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b5dc58f0-2e62-473e-8cde-5a82a9eee0c6/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b8009661-9f11-4d1b-ba94-a835888e5abf/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T120957Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=18ea7e475a2dfe3b984ebdc207d7d1c8c560db8ff15460df29a1351074c706be"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b8009661-9f11-4d1b-ba94-a835888e5abf/results/455436/?format=api",
            "id": 455436,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/1d975aed-222d-46ea-84c1-a098ca10323b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b8009661-9f11-4d1b-ba94-a835888e5abf/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T120957Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=546c7cd4f461cee41432922a47904f030cdfda62a25a50e689047a79519654ac"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b8009661-9f11-4d1b-ba94-a835888e5abf/results/455437/?format=api",
            "id": 455437,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/f714e04f-759c-4438-9a9b-963eb5bbc785/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b8009661-9f11-4d1b-ba94-a835888e5abf/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T120957Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=640d763c13f17b512e8e2aa7f3ac5376d39fe5ed92734bb9724b13d3c790b943"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b8009661-9f11-4d1b-ba94-a835888e5abf/results/455438/?format=api",
            "id": 455438,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a4d7bbaf-de4e-4d74-b865-547eb1d029d6/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b8009661-9f11-4d1b-ba94-a835888e5abf/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T120957Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0e824d807103d494bfba0fdab58d0630858a12152a4e8fef5f4b61c31d34dd9a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b8009661-9f11-4d1b-ba94-a835888e5abf/results/455439/?format=api",
            "id": 455439,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/efbcf59e-1d79-4116-9266-4a3278df0bd6/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b8009661-9f11-4d1b-ba94-a835888e5abf/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T120957Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f1c7277224a4c0d19736318ce4a6f9ff0905070afa9fd4673a2c3113f57c3cda"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b8009661-9f11-4d1b-ba94-a835888e5abf/results/455440/?format=api",
            "id": 455440,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/5a5faa70-124b-4754-b9ce-cb29665c8901/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b8009661-9f11-4d1b-ba94-a835888e5abf/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T120957Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e20cc1e8d42e6b276caaf22a173c02261f1cefeeb8038b6b2c9d7470b8c2c1b0"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b8009661-9f11-4d1b-ba94-a835888e5abf/results/455441/?format=api",
            "id": 455441,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/605e7cfb-7177-469e-b1c8-2a58dae56329/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b8009661-9f11-4d1b-ba94-a835888e5abf/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T120957Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1af1912e5d74d8de25ada34cba74bbb02e5ddc01797862f478971fe383ba58a4"
        }
    ]
}