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/459dc4ed-287a-4d3e-adbe-cd15992d7075/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/459dc4ed-287a-4d3e-adbe-cd15992d7075/results/441628/?format=api",
            "id": 441628,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4b45eb4d-dd9a-4559-966d-4d6a4ecb332e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/459dc4ed-287a-4d3e-adbe-cd15992d7075/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T013328Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=fad37d6aeb6d9bbe45b8245b165456d62487380cf65f7ab646909755f3937239"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/459dc4ed-287a-4d3e-adbe-cd15992d7075/results/441629/?format=api",
            "id": 441629,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b4382843-9ea4-4cac-b251-1f60b9a5525a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/459dc4ed-287a-4d3e-adbe-cd15992d7075/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T013328Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1575b121c694e8fd97ceccab0cd918285e38ab3b9d9c0632b63f91b94e4dfabf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/459dc4ed-287a-4d3e-adbe-cd15992d7075/results/441630/?format=api",
            "id": 441630,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/ad64a113-e57e-40cc-9b28-68c44759b6ec/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/459dc4ed-287a-4d3e-adbe-cd15992d7075/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T013328Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=61c82750d8c1885f240bf672f61352d0d9ffe8b9777fcb224fb16edcb25aa80e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/459dc4ed-287a-4d3e-adbe-cd15992d7075/results/441631/?format=api",
            "id": 441631,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/079ce017-ea45-4953-9fef-3c7f1e5b7df9/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/459dc4ed-287a-4d3e-adbe-cd15992d7075/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T013328Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c9561670cd878527858683f67c7fb3ae337a68ae4e244151c6133e4611379013"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/459dc4ed-287a-4d3e-adbe-cd15992d7075/results/441632/?format=api",
            "id": 441632,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/ac7c0b63-18d1-4a84-95e0-b2984749d070/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/459dc4ed-287a-4d3e-adbe-cd15992d7075/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T013328Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ce12bf94c2b2d4ad0e30093fca798587b6959a9368f0d1855cb16b2b4f1661ed"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/459dc4ed-287a-4d3e-adbe-cd15992d7075/results/441633/?format=api",
            "id": 441633,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/3885fe1f-b3c6-4746-ae54-28d0072e35f4/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/459dc4ed-287a-4d3e-adbe-cd15992d7075/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T013328Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f412744f8bb97cbb46f0295a4c50c470992922c636ec1e47fb5004f02f910728"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/459dc4ed-287a-4d3e-adbe-cd15992d7075/results/441634/?format=api",
            "id": 441634,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4783993f-1dca-4b40-8d50-930d811f76f9/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/459dc4ed-287a-4d3e-adbe-cd15992d7075/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T013328Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=eff74225daec4ba76809b42e111161221e2a5ef811b5b0603c40943fdf056c3e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/459dc4ed-287a-4d3e-adbe-cd15992d7075/results/441635/?format=api",
            "id": 441635,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/88607841-cc93-4946-862e-b469145408c7/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/459dc4ed-287a-4d3e-adbe-cd15992d7075/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T013328Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=25a886a1a1bcb4a197b953bf949d093670667f645fe5172942d9d71cc90286da"
        }
    ]
}