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/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/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/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/results/452382/?format=api",
            "id": 452382,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/fa40ed23-b166-4ca5-bd5f-3037f42957e9/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T103444Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=dc5733cd2e5a38677bd99ddb07c4fd808339c679c3a0a25d08d128b8309b34a3"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/results/452383/?format=api",
            "id": 452383,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/7dda30a5-2faa-4e18-9753-f42f754a916b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T103444Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c17297d02cb9c71efc2c54e2bc4cbc4b9b4a2b3c534a1ed3ea24a6fc010700bc"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/results/452384/?format=api",
            "id": 452384,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2b0718f2-bed6-4576-a1ac-aa1323c71096/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T103444Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=dc5b5d1034b2f141ad93f005e6821d36ae81e7659913e0edb5446d1856953d7b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/results/452385/?format=api",
            "id": 452385,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/8d330445-901c-4c1a-afbe-638ae04b418d/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T103444Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=faec446c0ff9d83f7269db6f6159c42142194b93e39114301c953f381a52c6ba"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/results/452386/?format=api",
            "id": 452386,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/9144be7a-550e-45c3-8571-fd3f30aeeb48/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T103444Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=43b822915a8335ebcd1b81280c82b94a47cd788db774ae833aa617b9e722d1ed"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/results/452387/?format=api",
            "id": 452387,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/db295b00-7b85-4ac5-be2b-b1fd32166592/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T103444Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=461cafce97666fe332cee1ba7e6bab758aa2075c6ddf7c02812456cebcdfa2a0"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/results/452388/?format=api",
            "id": 452388,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/277f7b76-a3b7-453b-8a03-c355870b4585/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T103444Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ea4b8f63ee94b84b688abec953961767457161f7df099b1773000a97a151324b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/results/452389/?format=api",
            "id": 452389,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/ecd54a5f-0daf-4769-9670-484a0c397582/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T103444Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b0e13f25042fccc9db47efbbfefd489b03c678d04c374d154541c61c65ec8e16"
        }
    ]
}