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/b7c17c81-5854-4496-abd6-45fb75566f23/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/b7c17c81-5854-4496-abd6-45fb75566f23/results/449316/?format=api",
            "id": 449316,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b21a1605-45fe-41e5-9177-24f46ca82572/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b7c17c81-5854-4496-abd6-45fb75566f23/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T161511Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2d1c75912a10df1499075de91255d27d72d17588e56163ff34a72584861c4409"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b7c17c81-5854-4496-abd6-45fb75566f23/results/449317/?format=api",
            "id": 449317,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a9fe4e1b-c3f0-4321-ac16-38cc3f8ff2cf/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b7c17c81-5854-4496-abd6-45fb75566f23/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T161511Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=83b06544c649cd2d476fa39f96d0cda763ed7ffc4195cefcc9259c2ef7f9c634"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b7c17c81-5854-4496-abd6-45fb75566f23/results/449318/?format=api",
            "id": 449318,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/1162e108-7549-4c48-9c9d-0949b7b0d39d/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b7c17c81-5854-4496-abd6-45fb75566f23/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T161511Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e2f2f3c3f2db7b57c5fa9d598401632dad9debf9688a4ea870fdc6df5aeefa7a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b7c17c81-5854-4496-abd6-45fb75566f23/results/449319/?format=api",
            "id": 449319,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/de0712b9-3721-4b59-a580-66e42b08a0cc/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b7c17c81-5854-4496-abd6-45fb75566f23/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T161511Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3972b89ea6f46823d66c227405a980a6b640cbbfa7fa317154c7c91c134c2dc7"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b7c17c81-5854-4496-abd6-45fb75566f23/results/449320/?format=api",
            "id": 449320,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/aa13060c-286e-4078-b948-74b424c475f5/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b7c17c81-5854-4496-abd6-45fb75566f23/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T161511Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=62d548a2e14f319f05f1255a353241928a047e03ad3d597410d9a0b0b9eaa83e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b7c17c81-5854-4496-abd6-45fb75566f23/results/449321/?format=api",
            "id": 449321,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/de40b984-3033-4387-9286-9aaab35eddb2/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b7c17c81-5854-4496-abd6-45fb75566f23/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T161511Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8e407234b7b28b6676b797b6993a7da59fa81fa98fb024f9e11caeed90af428c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b7c17c81-5854-4496-abd6-45fb75566f23/results/449322/?format=api",
            "id": 449322,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/eae3649b-f576-4c1e-8ef6-1b601939b4f6/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b7c17c81-5854-4496-abd6-45fb75566f23/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T161511Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=924cbfebae5cd974e8709540aae2f5236777472eb778bc5e776ca5489a5252ea"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b7c17c81-5854-4496-abd6-45fb75566f23/results/449323/?format=api",
            "id": 449323,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2824bace-952f-4ee3-94c8-9874961e58db/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b7c17c81-5854-4496-abd6-45fb75566f23/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T161511Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4a386e442584e42efe2c3fc5e02d0ac417f615479546721aef9184b5e825d485"
        }
    ]
}