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/92cb60f0-2b27-4c4f-95b0-8f000cce7437/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/92cb60f0-2b27-4c4f-95b0-8f000cce7437/results/441191/?format=api",
            "id": 441191,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/ee06ae6e-531f-4803-9e59-1bfb70078887/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/92cb60f0-2b27-4c4f-95b0-8f000cce7437/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T051107Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7528c6b61e38f70529c2fb64f6762cf44b06d3c8c7a10349c9bd57f853646c82"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/92cb60f0-2b27-4c4f-95b0-8f000cce7437/results/441192/?format=api",
            "id": 441192,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/44603d0f-b740-4ba8-82fa-5a71c7426802/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/92cb60f0-2b27-4c4f-95b0-8f000cce7437/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T051107Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0f7407f3774542dbb76f6f3481b7c571fef83da65fb5db1c991b0bc8125ee3ba"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/92cb60f0-2b27-4c4f-95b0-8f000cce7437/results/441193/?format=api",
            "id": 441193,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c8c59d46-69df-4078-a855-7a22e7a14158/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/92cb60f0-2b27-4c4f-95b0-8f000cce7437/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T051107Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=198f0390f8f6b7f693047c98a4a619fb04233e1a64f6b9853dbf95f41a353b88"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/92cb60f0-2b27-4c4f-95b0-8f000cce7437/results/441194/?format=api",
            "id": 441194,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/52d1287b-477e-4535-9a15-35f513c0498b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/92cb60f0-2b27-4c4f-95b0-8f000cce7437/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T051107Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c30def33d1e1eef6dca963a5ea0b8a2df9befffb99149a6df07c787146283a0d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/92cb60f0-2b27-4c4f-95b0-8f000cce7437/results/441195/?format=api",
            "id": 441195,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/9d9ef852-e179-4249-84a7-b2aae787039b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/92cb60f0-2b27-4c4f-95b0-8f000cce7437/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T051107Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6741e119c700708f64fb63da35aa3643430f6f2488b6e584f4c9c0d582ee4b19"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/92cb60f0-2b27-4c4f-95b0-8f000cce7437/results/441196/?format=api",
            "id": 441196,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4aaa325d-dd75-44f6-9675-2e67b3f22d10/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/92cb60f0-2b27-4c4f-95b0-8f000cce7437/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T051107Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1ab3982c1bbf431809dd067e9547876c108ca29aed79ac527e97f110ba0d71fd"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/92cb60f0-2b27-4c4f-95b0-8f000cce7437/results/441197/?format=api",
            "id": 441197,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/fd12d111-0f06-4991-94f5-1f3f82ef1895/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/92cb60f0-2b27-4c4f-95b0-8f000cce7437/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T051107Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=560bdad5ec5d2b3631959c0ac44433695f890c876d0a2647ccbe9217f91829e2"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/92cb60f0-2b27-4c4f-95b0-8f000cce7437/results/441198/?format=api",
            "id": 441198,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/54b622ea-1f5f-4b59-ade1-145f1778a49a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/92cb60f0-2b27-4c4f-95b0-8f000cce7437/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T051107Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e2b7c13c4495481e5e09f988072371dc80d50c2ff2189c6fcf742652c7663b29"
        }
    ]
}