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/83dbe61b-c32b-4e32-b543-02fcdc913d97/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/83dbe61b-c32b-4e32-b543-02fcdc913d97/results/477542/?format=api",
            "id": 477542,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/91e0ffd5-ddf3-47f1-bbc3-227e69835710/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/83dbe61b-c32b-4e32-b543-02fcdc913d97/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T122457Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7600bbd6466a6f097bf9103b4812b5dd521d42f18d2b1ca15f42cf64c6166182"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/83dbe61b-c32b-4e32-b543-02fcdc913d97/results/477543/?format=api",
            "id": 477543,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/aaf20082-472c-443c-93fc-6421705f2c2b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/83dbe61b-c32b-4e32-b543-02fcdc913d97/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T122457Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ec05dea4fa4d45e1bc87b24f4fa790e883bf6b6ab335d47aa072e0e716b5c527"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/83dbe61b-c32b-4e32-b543-02fcdc913d97/results/477544/?format=api",
            "id": 477544,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/1562fab8-5fc2-4673-9fac-5403b72904aa/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/83dbe61b-c32b-4e32-b543-02fcdc913d97/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T122457Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=21f6a53f104c4038fc56b0a12ec38161e3bf967048e25cc82a2aa9695b2d75e4"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/83dbe61b-c32b-4e32-b543-02fcdc913d97/results/477545/?format=api",
            "id": 477545,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/737d7fd1-aafa-4ca3-b351-81ac8e576b1e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/83dbe61b-c32b-4e32-b543-02fcdc913d97/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T122457Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=49556a747a68542734b29c1a8a6a62487329580ce1589a086ff7c3d7a101824e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/83dbe61b-c32b-4e32-b543-02fcdc913d97/results/477546/?format=api",
            "id": 477546,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/25b77200-185e-4d49-88ff-e8de2986772a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/83dbe61b-c32b-4e32-b543-02fcdc913d97/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T122457Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=88d26849ee4afd7f005090e91234c7a5ddab7a876c789cb7cf6ffea8489384e2"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/83dbe61b-c32b-4e32-b543-02fcdc913d97/results/477547/?format=api",
            "id": 477547,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/f85090d2-e303-4c46-bb0a-fc1582b39694/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/83dbe61b-c32b-4e32-b543-02fcdc913d97/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T122457Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8b6db055273097d3c3177425891e9e2c7d39c4f919fd93d0abb9b6ed68b57385"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/83dbe61b-c32b-4e32-b543-02fcdc913d97/results/477548/?format=api",
            "id": 477548,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/7a9ed96e-3a44-4501-ad41-a440f59df104/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/83dbe61b-c32b-4e32-b543-02fcdc913d97/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T122457Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8a74d7b21dd019b8bf3b18fc01bfc23f18b99c4890fac0437bc616d3423052f5"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/83dbe61b-c32b-4e32-b543-02fcdc913d97/results/477549/?format=api",
            "id": 477549,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/3e025469-55ee-4c11-aa38-fd47b8fa6a08/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/83dbe61b-c32b-4e32-b543-02fcdc913d97/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250615%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250615T122457Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a85c7d554496f18c32d33a591f0bd70411dfe4ea7ca217f7a209d5391a208d44"
        }
    ]
}