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/a99124a1-388c-4b2c-ae88-3a927ac7d7a1/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/a99124a1-388c-4b2c-ae88-3a927ac7d7a1/results/439887/?format=api",
            "id": 439887,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/e34cafff-91b7-4d3a-922a-e11e40f1dd56/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a99124a1-388c-4b2c-ae88-3a927ac7d7a1/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T114933Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3edd66fd0ddac5a720fd185f9d8ff4c53f188140c11ccfa0c4454b0fc6c80a6c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a99124a1-388c-4b2c-ae88-3a927ac7d7a1/results/439888/?format=api",
            "id": 439888,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4eaabdce-3557-47c1-9dc9-df302db48672/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a99124a1-388c-4b2c-ae88-3a927ac7d7a1/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T114933Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6e727d64f36ac6ff14be8cc91c7ba27b49c7d791cc108a4dc09cebbc998fe03a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a99124a1-388c-4b2c-ae88-3a927ac7d7a1/results/439889/?format=api",
            "id": 439889,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/3a4d7267-b942-46ab-b130-b29cf95e1b6b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a99124a1-388c-4b2c-ae88-3a927ac7d7a1/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T114933Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=636afb0a8348340fa7c44a4764510cdb85f112f9f7199c84a623d71311afa742"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a99124a1-388c-4b2c-ae88-3a927ac7d7a1/results/439890/?format=api",
            "id": 439890,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/3c0f69f6-2b30-4d41-86ad-bc39e583a308/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a99124a1-388c-4b2c-ae88-3a927ac7d7a1/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T114933Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a3269ca5faffae2ed834944846cb28d793db55388e3be300a97ef1a12b4843fc"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a99124a1-388c-4b2c-ae88-3a927ac7d7a1/results/439891/?format=api",
            "id": 439891,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/3cd3cc22-5519-45d2-ae02-1afde8d25628/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a99124a1-388c-4b2c-ae88-3a927ac7d7a1/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T114933Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9468a91c80c6c31cd122d8b0ada5c4000c6d278f6a309bfc888f638ea71e83ba"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a99124a1-388c-4b2c-ae88-3a927ac7d7a1/results/439892/?format=api",
            "id": 439892,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b3663192-bed9-461c-8160-8bd589eee231/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a99124a1-388c-4b2c-ae88-3a927ac7d7a1/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T114933Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0e7ca8ea85d0ece1706b8bc900911ecfa3965f057245e36c6cb71ad630d1c499"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a99124a1-388c-4b2c-ae88-3a927ac7d7a1/results/439893/?format=api",
            "id": 439893,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/bebadd6f-f280-4e2a-8a6c-c9ee11a2b5e3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a99124a1-388c-4b2c-ae88-3a927ac7d7a1/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T114933Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ba68a76d5ff2239f77e7ed573ea1d64395f4525aa270d0783b644c2de8fea4d0"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a99124a1-388c-4b2c-ae88-3a927ac7d7a1/results/439894/?format=api",
            "id": 439894,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/87e3ed70-ad96-41de-830e-e5b48f4c1e67/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a99124a1-388c-4b2c-ae88-3a927ac7d7a1/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T114933Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=163196ca2466d4f18ae9b48aa8f5a734bae2835182c9bc7a006eebecfd99d900"
        }
    ]
}