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/19e8535f-2945-4ce9-9fd0-203b74de3889/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/19e8535f-2945-4ce9-9fd0-203b74de3889/results/453741/?format=api",
            "id": 453741,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a8246890-7be0-4626-84c5-faed81e66900/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/19e8535f-2945-4ce9-9fd0-203b74de3889/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250317%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250317T030100Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e6362224037e2179b45635533d39d96dc01dc95c90f41f7a1f04a7854256793a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/19e8535f-2945-4ce9-9fd0-203b74de3889/results/453742/?format=api",
            "id": 453742,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/80adb603-49bb-4894-b680-c6868aea33e3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/19e8535f-2945-4ce9-9fd0-203b74de3889/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250317%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250317T030100Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7840732129fdeb27f942b6fe28c7efc50afcb46e7486ae9b13a9f17f31cae2eb"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/19e8535f-2945-4ce9-9fd0-203b74de3889/results/453743/?format=api",
            "id": 453743,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/523ff1f9-c952-44c1-b694-13890eb229ac/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/19e8535f-2945-4ce9-9fd0-203b74de3889/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250317%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250317T030100Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=44c1ce3a783328371cf5b25b3749728eb03392decb719ad5f5a050e5a0ec0b6d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/19e8535f-2945-4ce9-9fd0-203b74de3889/results/453744/?format=api",
            "id": 453744,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d9102db4-158c-4ecb-830a-83f65e46a860/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/19e8535f-2945-4ce9-9fd0-203b74de3889/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250317%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250317T030100Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ec2cd31de595716125146c475434b55ba50cf171d7d0a98d06bbe6f62a961866"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/19e8535f-2945-4ce9-9fd0-203b74de3889/results/453745/?format=api",
            "id": 453745,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/ecebcda8-7611-4946-87a4-91a932b4f281/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/19e8535f-2945-4ce9-9fd0-203b74de3889/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250317%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250317T030100Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1ef5f4467053c8834579fcf2c63a1d7f7eaa6ab141a6c16c127902374adb43da"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/19e8535f-2945-4ce9-9fd0-203b74de3889/results/453746/?format=api",
            "id": 453746,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/0e221da3-c729-4aa2-b34d-1f2b2630a215/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/19e8535f-2945-4ce9-9fd0-203b74de3889/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250317%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250317T030100Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7923c896afdbdc31badeacd6a13605591a9401ff02068b3e38a4aa44c0b598ae"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/19e8535f-2945-4ce9-9fd0-203b74de3889/results/453747/?format=api",
            "id": 453747,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/7f8391c9-35f0-4852-83b7-97b633ea0781/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/19e8535f-2945-4ce9-9fd0-203b74de3889/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250317%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250317T030100Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=679f8b7983b0dd5c7740a84d7e0c2cc59940a64944881c2510ea304a6006128e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/19e8535f-2945-4ce9-9fd0-203b74de3889/results/453748/?format=api",
            "id": 453748,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/3e345815-f494-44d3-b06b-63994878881f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/19e8535f-2945-4ce9-9fd0-203b74de3889/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250317%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250317T030100Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6b00cb3283d56fcafd3180099f181ae7b9d5de6f18ae550caff15c5016394044"
        }
    ]
}