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/5ce1ebf1-59f5-4adf-8673-8c9cdd0dcc88/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/5ce1ebf1-59f5-4adf-8673-8c9cdd0dcc88/results/500106/?format=api",
            "id": 500106,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/52ccb28f-3732-4e81-b83e-743ff06bf3fb/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5ce1ebf1-59f5-4adf-8673-8c9cdd0dcc88/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250428%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250428T191103Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=26cf8f43ffc1a0cabd01daa554a295fc964f08f489929e99ed8ce07d807f0e38"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5ce1ebf1-59f5-4adf-8673-8c9cdd0dcc88/results/500107/?format=api",
            "id": 500107,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/f53f9411-cb3d-4c25-899e-4ce792359350/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5ce1ebf1-59f5-4adf-8673-8c9cdd0dcc88/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250428%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250428T191103Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=937b115c01ff64e78cd9a8731cb0dbf1ece0b9a27194c8e092a945749e54c4d0"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5ce1ebf1-59f5-4adf-8673-8c9cdd0dcc88/results/500108/?format=api",
            "id": 500108,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/39654b4c-8996-4c0a-9fa2-6b832e7f1278/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5ce1ebf1-59f5-4adf-8673-8c9cdd0dcc88/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250428%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250428T191103Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=919600e0bc8ef99b49bf4095eca9adc736b034ad609d7b7af837674a16f9f65a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5ce1ebf1-59f5-4adf-8673-8c9cdd0dcc88/results/500109/?format=api",
            "id": 500109,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2e395746-f247-4af9-a1c4-ddc5cf92430c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5ce1ebf1-59f5-4adf-8673-8c9cdd0dcc88/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250428%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250428T191103Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a90c41bbbac4b65c99b51dba8fdea72d161d7a4cbbae761bc473a854a33f2cbe"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5ce1ebf1-59f5-4adf-8673-8c9cdd0dcc88/results/500110/?format=api",
            "id": 500110,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b567643c-8117-4731-8e75-c2c00df3de32/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5ce1ebf1-59f5-4adf-8673-8c9cdd0dcc88/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250428%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250428T191103Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=badfa88332dbb2cad35482e67c52918cd6404d80f8b56b8043204a8a3388a300"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5ce1ebf1-59f5-4adf-8673-8c9cdd0dcc88/results/500111/?format=api",
            "id": 500111,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/fe151e5f-da3e-4ab7-84e1-76364ab0cc68/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5ce1ebf1-59f5-4adf-8673-8c9cdd0dcc88/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250428%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250428T191103Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=06b63c6c4d871d291688a6fe048bd7d0e6b1e1230d6fe730a3bff729123cc2bf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5ce1ebf1-59f5-4adf-8673-8c9cdd0dcc88/results/500112/?format=api",
            "id": 500112,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d248eeac-81aa-461e-9a86-5406c7f2a636/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5ce1ebf1-59f5-4adf-8673-8c9cdd0dcc88/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250428%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250428T191103Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8fdf111167e373e6d7f35b45958c348d5dd370e2dd057002ff4990e2d83fd123"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5ce1ebf1-59f5-4adf-8673-8c9cdd0dcc88/results/500113/?format=api",
            "id": 500113,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/71446d90-0d2c-45fb-9dae-dae277d2b0a9/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5ce1ebf1-59f5-4adf-8673-8c9cdd0dcc88/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250428%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250428T191103Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9874ea4066bba0f9a720754b6150fb8b8f0dace817a3b9d8de0d85cf19316d28"
        }
    ]
}