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/083da304-0459-4dc3-9d89-806d98da4d38/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/083da304-0459-4dc3-9d89-806d98da4d38/results/441028/?format=api",
            "id": 441028,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/179a401d-818e-4e19-8fed-a410b893e564/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/083da304-0459-4dc3-9d89-806d98da4d38/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T082956Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e94b78b50985cd5617a39479192b5263ecd2f8754f5b1c6fda85046b61e88772"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/083da304-0459-4dc3-9d89-806d98da4d38/results/441029/?format=api",
            "id": 441029,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/cdffac82-fd7f-4768-b2a4-eba73652e47d/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/083da304-0459-4dc3-9d89-806d98da4d38/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T082956Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ebbb872e84ba67742f275ba0c72ae50e08712cd23b9a470459be00f72294175a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/083da304-0459-4dc3-9d89-806d98da4d38/results/441030/?format=api",
            "id": 441030,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/8dba0fca-a24d-44cb-93d7-0d56b5d40102/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/083da304-0459-4dc3-9d89-806d98da4d38/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T082956Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d5524af2327c45de613030adedda334752a85efd84cdd2ebeefbbdac09c85e10"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/083da304-0459-4dc3-9d89-806d98da4d38/results/441031/?format=api",
            "id": 441031,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/5a9e4966-883b-4b9c-8202-82a769ce02d3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/083da304-0459-4dc3-9d89-806d98da4d38/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T082956Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ec9d1c58f7b5ebc3864d0d26f348dfedf5757fd573fef6999fb39c51af6e1d91"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/083da304-0459-4dc3-9d89-806d98da4d38/results/441032/?format=api",
            "id": 441032,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/f7bb6269-bcce-4c3e-82a8-40399fccb9cf/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/083da304-0459-4dc3-9d89-806d98da4d38/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T082956Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0d7951147360b02573dca30c9cf1eb435d580bdccbe580d4cd8104b47bb4b158"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/083da304-0459-4dc3-9d89-806d98da4d38/results/441033/?format=api",
            "id": 441033,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/cf7c9efa-cbe6-4b91-9293-f1096ff19a21/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/083da304-0459-4dc3-9d89-806d98da4d38/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T082956Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=513b81c36a5eeb48b6bf51db73f9a878815d0e22e71c1c767b11fb668ac305cc"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/083da304-0459-4dc3-9d89-806d98da4d38/results/441034/?format=api",
            "id": 441034,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/572a53ff-613b-4b0a-8683-41666e9df313/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/083da304-0459-4dc3-9d89-806d98da4d38/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T082956Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9d4bdc076e45057023a16ef000f339263ed826482763635a6b241f44749572d5"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/083da304-0459-4dc3-9d89-806d98da4d38/results/441035/?format=api",
            "id": 441035,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2c3a5387-578f-41c8-a118-386f0f223a3c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/083da304-0459-4dc3-9d89-806d98da4d38/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T082956Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4335efd99845cfda99d676015a79bfcaa21bb852bbd8f4bf98da92278be38ae5"
        }
    ]
}