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/c95b08f5-4c8b-4638-aafe-5b134aaf9e77/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/c95b08f5-4c8b-4638-aafe-5b134aaf9e77/results/498996/?format=api",
            "id": 498996,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/bf7fd55c-539d-49b6-9009-63b3cf318774/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c95b08f5-4c8b-4638-aafe-5b134aaf9e77/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250428%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250428T172415Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=92a4e304e08eddd02d5f17cb8c4c598d02e8e5de7747b8ac316ca2ccd20b2373"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c95b08f5-4c8b-4638-aafe-5b134aaf9e77/results/498997/?format=api",
            "id": 498997,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b4fee35f-7204-416f-a452-9fd5cc4f4740/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c95b08f5-4c8b-4638-aafe-5b134aaf9e77/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250428%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250428T172415Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=20e49855f126ad5289893ef01e734b49063902db43c95748413713dedb0cee8d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c95b08f5-4c8b-4638-aafe-5b134aaf9e77/results/498998/?format=api",
            "id": 498998,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a7ce97b0-aa45-4cd5-b59e-aa0d436699a6/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c95b08f5-4c8b-4638-aafe-5b134aaf9e77/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250428%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250428T172415Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a943d7640f3d2a536000c13751cc1c2caa62ec21bd57c50048e61160b02cd9ee"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c95b08f5-4c8b-4638-aafe-5b134aaf9e77/results/498999/?format=api",
            "id": 498999,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/e3a67479-945a-41c1-ac73-8c2d4cf219e4/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c95b08f5-4c8b-4638-aafe-5b134aaf9e77/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250428%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250428T172415Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=05b90658d92c866ca6a2810c3ea4ac2326fd6f9443e46136ff4bdaceca787e4b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c95b08f5-4c8b-4638-aafe-5b134aaf9e77/results/499000/?format=api",
            "id": 499000,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/f25c2ab6-14ea-49b5-bb50-a673c642cdcf/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c95b08f5-4c8b-4638-aafe-5b134aaf9e77/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250428%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250428T172415Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f2aab6f00374593529fbed4ea59507955690fb55606e8088879de5d39c5bea70"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c95b08f5-4c8b-4638-aafe-5b134aaf9e77/results/499001/?format=api",
            "id": 499001,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/40e3f8ba-5f44-4037-a998-09e8395e7769/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c95b08f5-4c8b-4638-aafe-5b134aaf9e77/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250428%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250428T172415Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=302c79af9ec693c9f1965df4c0c3c5596e2c436fb5933ee183375a21b152acf9"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c95b08f5-4c8b-4638-aafe-5b134aaf9e77/results/499002/?format=api",
            "id": 499002,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/5125f134-b03a-4453-9334-2104fe8db4ad/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c95b08f5-4c8b-4638-aafe-5b134aaf9e77/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250428%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250428T172415Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f02e7102894c3fdbd9d4d94e87781ba4fe1eff7311610f6dbd87991f7232119c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c95b08f5-4c8b-4638-aafe-5b134aaf9e77/results/499003/?format=api",
            "id": 499003,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/25d965aa-87ea-462e-a398-4818df1072c9/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c95b08f5-4c8b-4638-aafe-5b134aaf9e77/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250428%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250428T172415Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ea2d95547f9cbebe3621bc1dc92ca3412720b78c4e4db1ec8a67dfca3d011024"
        }
    ]
}