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/68b823da-f5ab-454b-8314-597b02caf6e4/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/68b823da-f5ab-454b-8314-597b02caf6e4/results/449659/?format=api",
            "id": 449659,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/82fc91e9-9ebb-4e01-a410-9965b92e80ee/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/68b823da-f5ab-454b-8314-597b02caf6e4/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250316%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250316T010632Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=cdfa10cf95e4de3fb9ce146b92b16be9627b50dc5e661d4e063c25b9c9757ca7"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/68b823da-f5ab-454b-8314-597b02caf6e4/results/449660/?format=api",
            "id": 449660,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b6c3a76b-76cc-41b5-90b6-daa1701a285a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/68b823da-f5ab-454b-8314-597b02caf6e4/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250316%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250316T010632Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=398578fcc1410d8abb24abbdb136ba9644dfc7044c429feb240da4d719861310"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/68b823da-f5ab-454b-8314-597b02caf6e4/results/449661/?format=api",
            "id": 449661,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/ef26274e-7c6a-4ef4-9888-c14d42a7a52f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/68b823da-f5ab-454b-8314-597b02caf6e4/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250316%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250316T010632Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=eb60cdf82ddad674d88f184cf9570160d94ceceb3e48365f6f153bef7e904abd"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/68b823da-f5ab-454b-8314-597b02caf6e4/results/449662/?format=api",
            "id": 449662,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/76f9c61c-960d-41a7-805f-1f808b4c4486/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/68b823da-f5ab-454b-8314-597b02caf6e4/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250316%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250316T010632Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a8b450d9734f3969a138b6f37ba6ed5d13e08675fde49b90ff4f4af10295a67f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/68b823da-f5ab-454b-8314-597b02caf6e4/results/449663/?format=api",
            "id": 449663,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/5b82b901-f136-4ed3-b42e-b67582e475c3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/68b823da-f5ab-454b-8314-597b02caf6e4/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250316%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250316T010632Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2a7d5e8565061aa0f430247a122b98ac73e1ad9ec2fdb0631ac3faadd4b843c1"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/68b823da-f5ab-454b-8314-597b02caf6e4/results/449664/?format=api",
            "id": 449664,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/1c4ce56f-9a9a-45c6-bc51-5ce1157b0515/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/68b823da-f5ab-454b-8314-597b02caf6e4/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250316%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250316T010632Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ff426276b663f175370bd32f952c6765cc4e79af5e133933e5902f22b5bb95f8"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/68b823da-f5ab-454b-8314-597b02caf6e4/results/449665/?format=api",
            "id": 449665,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/075c57c0-068c-4102-9ec5-c86601e01206/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/68b823da-f5ab-454b-8314-597b02caf6e4/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250316%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250316T010632Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=da1400a312ec9ff94b387f3b04c5b7b70076a036e083abdf525f0c995064ccba"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/68b823da-f5ab-454b-8314-597b02caf6e4/results/449666/?format=api",
            "id": 449666,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/17d63bed-3e9b-4887-bfe0-d8ed53018109/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/68b823da-f5ab-454b-8314-597b02caf6e4/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250316%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250316T010632Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9032afb97d2cb0b9a15fcedcf4dc7f5193c359c078e75b901874b1b22a6f7356"
        }
    ]
}