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/a6d130ab-f561-41d1-b2d8-c1681d770999/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/a6d130ab-f561-41d1-b2d8-c1681d770999/results/448234/?format=api",
            "id": 448234,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4bf94f01-d291-497b-ba82-3ac307c80fbd/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a6d130ab-f561-41d1-b2d8-c1681d770999/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T222415Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6073738e4cea7c43743fbbed996ef4d7d1c2653ee01891f3fafff5df7005bb8c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a6d130ab-f561-41d1-b2d8-c1681d770999/results/448235/?format=api",
            "id": 448235,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/acaba83c-a12b-4604-a009-1abdeaafab22/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a6d130ab-f561-41d1-b2d8-c1681d770999/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T222415Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7be54c948a44ee6d988b22a7067b79f4449d2336987aa258ac40ae091233dad3"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a6d130ab-f561-41d1-b2d8-c1681d770999/results/448236/?format=api",
            "id": 448236,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/eab290aa-59d1-46a9-a469-f24a9591dec0/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a6d130ab-f561-41d1-b2d8-c1681d770999/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T222415Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c13c321f9905e932fe341995e037dd5af3192b1a458b67b1088796bec4d461ea"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a6d130ab-f561-41d1-b2d8-c1681d770999/results/448237/?format=api",
            "id": 448237,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/354deb6d-96cb-49ed-982f-f440fcf7127e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a6d130ab-f561-41d1-b2d8-c1681d770999/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T222415Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f0fe1973cb0663d7136048f1a83ee7861028291f0a6df7173159080d2ec85aac"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a6d130ab-f561-41d1-b2d8-c1681d770999/results/448238/?format=api",
            "id": 448238,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/85fb27b9-d52f-40e4-8c52-758c9439724e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a6d130ab-f561-41d1-b2d8-c1681d770999/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T222415Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=675ba52bf49de7ad55463e947678f68d5f8ea7f9d69a9e945402a85f22dbc280"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a6d130ab-f561-41d1-b2d8-c1681d770999/results/448239/?format=api",
            "id": 448239,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/29e759ba-4d2a-46eb-955d-e0bfe52ba366/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a6d130ab-f561-41d1-b2d8-c1681d770999/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T222415Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c4ebe33a328ee01a6cf6a02d5ee7d51a8bdee6826ca562ebbf124a2c089f0533"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a6d130ab-f561-41d1-b2d8-c1681d770999/results/448240/?format=api",
            "id": 448240,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/9846d39c-3592-4156-ae0e-dd5a5075f73d/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a6d130ab-f561-41d1-b2d8-c1681d770999/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T222415Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b214cdbea64179922e840dfdd5d8e37f487faea29060ee878b7ca7a0fa9ad55e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a6d130ab-f561-41d1-b2d8-c1681d770999/results/448241/?format=api",
            "id": 448241,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/3ac71c3d-48f0-4acb-beb0-9a8264855119/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a6d130ab-f561-41d1-b2d8-c1681d770999/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T222415Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f556cf1ddeb58af672bbcabfb6ac78aab6cf8b952aeb4b7fceb11f0631439554"
        }
    ]
}