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/c31ee575-0408-4261-8c67-82b50e11f118/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/c31ee575-0408-4261-8c67-82b50e11f118/results/296891/?format=api",
            "id": 296891,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c00bb2a2-4fcc-4181-83af-99e7b56029b8/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c31ee575-0408-4261-8c67-82b50e11f118/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T042058Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=399053c9d77d79b68fe9335781e5552391e8c811542cec5649adad5eb474015d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c31ee575-0408-4261-8c67-82b50e11f118/results/296892/?format=api",
            "id": 296892,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/7b4b50be-8201-4936-9c40-413dee2b4136/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c31ee575-0408-4261-8c67-82b50e11f118/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T042058Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=19f3d7a2332395c2941620bb1179a5c44f3240e83f57c359543f6f1265c72371"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c31ee575-0408-4261-8c67-82b50e11f118/results/296893/?format=api",
            "id": 296893,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/586324df-ad19-41af-b9a8-954dd0a119bd/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c31ee575-0408-4261-8c67-82b50e11f118/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T042058Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c8caaaf428deba6abf4df5e5a7f23c9eb8e1adb6ba90477a7b6998a2162b740b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c31ee575-0408-4261-8c67-82b50e11f118/results/296894/?format=api",
            "id": 296894,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/015960a6-b6b6-4ea6-bed5-fb6e3c5ffdfa/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c31ee575-0408-4261-8c67-82b50e11f118/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T042058Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c3392ae99e7f3d5224645233e3e59e67e3f859b4083ce53de3b45ef5d78196e4"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c31ee575-0408-4261-8c67-82b50e11f118/results/296895/?format=api",
            "id": 296895,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/ab67fd7d-5ae8-4bc8-aee6-d8cc86ed1c68/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c31ee575-0408-4261-8c67-82b50e11f118/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T042058Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9b57010d4c380d2b5d706d177fb69411a15d00bb213d752b31cd27b4707573ec"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c31ee575-0408-4261-8c67-82b50e11f118/results/296896/?format=api",
            "id": 296896,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a6f444c1-76be-413a-baa8-f7d02a18a94c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c31ee575-0408-4261-8c67-82b50e11f118/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T042058Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b732937a8f1698ae1b92e1f8a1ddfe6f26801493e9be8da5666fde0cbaa08713"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c31ee575-0408-4261-8c67-82b50e11f118/results/296897/?format=api",
            "id": 296897,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c4b85d9b-06af-4290-8a1f-9e13dfe5ef4c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c31ee575-0408-4261-8c67-82b50e11f118/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T042058Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c957de2878710e9b4e816293e1007a459555cabd1407bc6c5e0bb41e78a10eaa"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c31ee575-0408-4261-8c67-82b50e11f118/results/296898/?format=api",
            "id": 296898,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/3d226d61-e9f5-4a23-9c47-376edd3df8bc/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c31ee575-0408-4261-8c67-82b50e11f118/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T042058Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9bc667aa4f2ed85164f44c6c1db282558c39bf26b80a700d65bdf2fa0501a40a"
        }
    ]
}