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/eb57a6c8-4c02-4ae3-b64c-247200f63d7c/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/eb57a6c8-4c02-4ae3-b64c-247200f63d7c/results/263183/?format=api",
            "id": 263183,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": "Water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c0ba3a2d-ff34-40e6-94c2-447a6f5c0e8c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/eb57a6c8-4c02-4ae3-b64c-247200f63d7c/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T183534Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=77a8825f9ce3c23e92701326e635792d98bd8138009e7889cdee1041a16f9472"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/eb57a6c8-4c02-4ae3-b64c-247200f63d7c/results/263184/?format=api",
            "id": 263184,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": "Max water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b51841a2-5222-47d8-8822-64ff38149804/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/eb57a6c8-4c02-4ae3-b64c-247200f63d7c/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T183534Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6e4b2df8ebb97295c48f9b17187439821b8425fbc1edfece8463bfaa4b1edade"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/eb57a6c8-4c02-4ae3-b64c-247200f63d7c/results/263185/?format=api",
            "id": 263185,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": "Flood hazard rating",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/367597f1-c8d3-446f-8567-0a81f4ab49ed/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/eb57a6c8-4c02-4ae3-b64c-247200f63d7c/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T183534Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0ee7c98b25dfae632cefbbf9e141f869d4dc284f6119eca80d9b2922a1b04138"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/eb57a6c8-4c02-4ae3-b64c-247200f63d7c/results/263186/?format=api",
            "id": 263186,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": "Rate of rise of the water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/8ebabce8-1e0f-4b3b-81f1-50d0bf632ecb/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/eb57a6c8-4c02-4ae3-b64c-247200f63d7c/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T183534Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5c9d7beb17d107a2afd79d0bccd9910fb3efa4c9125c8706ddcec97199884ea1"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/eb57a6c8-4c02-4ae3-b64c-247200f63d7c/results/263187/?format=api",
            "id": 263187,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": "Water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4c57e4a3-6a48-4699-8fcb-2bf71c7e0700/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/eb57a6c8-4c02-4ae3-b64c-247200f63d7c/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T183534Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1ddd9314ac5f3c8411fd1b11ea108ba65d359864dca0fa0c2c11b08f6b3e411a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/eb57a6c8-4c02-4ae3-b64c-247200f63d7c/results/263188/?format=api",
            "id": 263188,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": "Max water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/1de9811f-0e64-430c-8fa2-a9bd216cba4b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/eb57a6c8-4c02-4ae3-b64c-247200f63d7c/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T183534Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=62f62c6239144640b58178a4a2161342e749ed2f3db997497c6e98088aef03a3"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/eb57a6c8-4c02-4ae3-b64c-247200f63d7c/results/263189/?format=api",
            "id": 263189,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": "Max flow velocity",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a489f3ec-ca3f-4b2e-a94a-e2e231145acb/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/eb57a6c8-4c02-4ae3-b64c-247200f63d7c/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T183534Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=03c0832b3ed232b3d27b0b5b28f4141866f54b3114f963f4104c299821412a7e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/eb57a6c8-4c02-4ae3-b64c-247200f63d7c/results/263190/?format=api",
            "id": 263190,
            "name": "Rain",
            "code": "rain-quad",
            "description": "Rain",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b3015d26-8da9-487c-9dc8-950a572237b4/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/eb57a6c8-4c02-4ae3-b64c-247200f63d7c/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T183534Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=71c60aa931bec35703aa28b7d6c200d75d5c22e30a2d737229b7ce121514b145"
        }
    ]
}