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/db8ed832-20f6-4a9f-a0be-33fcb1692643/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/db8ed832-20f6-4a9f-a0be-33fcb1692643/results/448196/?format=api",
            "id": 448196,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/dc50dd18-28c6-419d-8dbe-5e5f9789c852/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/db8ed832-20f6-4a9f-a0be-33fcb1692643/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T192413Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3fd86ba435743e9e929b630c0ed2cb8f65e8f88fa0479e5571b1e25cc505586a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/db8ed832-20f6-4a9f-a0be-33fcb1692643/results/448197/?format=api",
            "id": 448197,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/3446b25c-8c72-4762-ba78-99102928a8a7/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/db8ed832-20f6-4a9f-a0be-33fcb1692643/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T192413Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=737677dd49cb91352877929c583dded3f2d91f74773d7a1ba50fba462c031288"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/db8ed832-20f6-4a9f-a0be-33fcb1692643/results/448198/?format=api",
            "id": 448198,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4fde81c7-1c12-477c-b738-636250e33fc1/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/db8ed832-20f6-4a9f-a0be-33fcb1692643/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T192413Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6eaa75e6ded8329d648a4820afa3a18402c1f97d70469850e5da167014d09409"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/db8ed832-20f6-4a9f-a0be-33fcb1692643/results/448199/?format=api",
            "id": 448199,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d8e0c7f6-7ada-4cc0-81fc-39de5e61015c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/db8ed832-20f6-4a9f-a0be-33fcb1692643/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T192414Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=07cde26c52d28444e1216159c8ad71dc57e1aaa644be9e47c396b08ac46aa94b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/db8ed832-20f6-4a9f-a0be-33fcb1692643/results/448200/?format=api",
            "id": 448200,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/1a6c5e30-20db-46ce-afcf-92223c513905/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/db8ed832-20f6-4a9f-a0be-33fcb1692643/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T192414Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5aa74c9788dc2274d57810425d782c3ab3ce10103b290dd196bf6a0ef60d070c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/db8ed832-20f6-4a9f-a0be-33fcb1692643/results/448201/?format=api",
            "id": 448201,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/fe484f23-929c-4eb0-b0d5-09f362f39a06/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/db8ed832-20f6-4a9f-a0be-33fcb1692643/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T192414Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a907fff8a7dbdd2412b2fa5e57111e00d2d2be0888327059e6f92fd8b5cf6e14"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/db8ed832-20f6-4a9f-a0be-33fcb1692643/results/448202/?format=api",
            "id": 448202,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/20d0bd1d-14e8-44cb-857f-27a8a3060943/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/db8ed832-20f6-4a9f-a0be-33fcb1692643/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T192414Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=effe7501cfed1b55dae28b857b102ca0091402a258f70736e18cf90f8c58cfa4"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/db8ed832-20f6-4a9f-a0be-33fcb1692643/results/448203/?format=api",
            "id": 448203,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b25b0034-132a-4fa7-ae1d-e03f0b4eb8a2/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/db8ed832-20f6-4a9f-a0be-33fcb1692643/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T192414Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=61f50d0467e37d0ff4c07e7d45f9de10bbf8aeff4f0402dcb0b7997722cb2981"
        }
    ]
}