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/1d99482c-9426-480a-8bdb-d81dd439dc0f/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/1d99482c-9426-480a-8bdb-d81dd439dc0f/results/440984/?format=api",
            "id": 440984,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/1265c99b-037b-4fd0-8897-da2f643e25dc/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1d99482c-9426-480a-8bdb-d81dd439dc0f/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T003548Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=598efd9e318a00795f6607beeafedac8e33ee7e55bbb99b0ca57b551e4c61a4c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1d99482c-9426-480a-8bdb-d81dd439dc0f/results/440985/?format=api",
            "id": 440985,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2d616bfe-60c3-484f-a364-48a42fd02242/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1d99482c-9426-480a-8bdb-d81dd439dc0f/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T003548Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=194dd84f4097e1fdcaec76f1e0be37cb53ac9e4721db3b2bf1371aadbc9f18d6"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1d99482c-9426-480a-8bdb-d81dd439dc0f/results/440986/?format=api",
            "id": 440986,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2c758a1b-3857-42c1-bd7e-ee3a31cc15dc/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1d99482c-9426-480a-8bdb-d81dd439dc0f/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T003548Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5b26dfc2a60029737fb57c5933078da3df088ea01977ead73397383dc4cb4b60"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1d99482c-9426-480a-8bdb-d81dd439dc0f/results/440987/?format=api",
            "id": 440987,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/71f27c1a-484b-4a53-92af-ddafa0550e5c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1d99482c-9426-480a-8bdb-d81dd439dc0f/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T003548Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=43c07956d967be589ccf440b266b5c6c7a8bee045b0da9cdee7420eed4dae920"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1d99482c-9426-480a-8bdb-d81dd439dc0f/results/440988/?format=api",
            "id": 440988,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/56e07266-731f-4788-876d-111687aba72f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1d99482c-9426-480a-8bdb-d81dd439dc0f/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T003548Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=076a9ea69ff2fb13bc7286f8a48ffe3f2477881c7992aeddd66f39cce0d476ff"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1d99482c-9426-480a-8bdb-d81dd439dc0f/results/440989/?format=api",
            "id": 440989,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/8df8049a-db0c-42bb-8be1-a2dc26d2e9f0/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1d99482c-9426-480a-8bdb-d81dd439dc0f/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T003548Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b42648cae367c0ce243c342e8bac6de3d666fb7577c743d8f7fc10bf97c7ce79"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1d99482c-9426-480a-8bdb-d81dd439dc0f/results/440990/?format=api",
            "id": 440990,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/bf65d3e7-e825-4f43-9aba-1a1829df762a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1d99482c-9426-480a-8bdb-d81dd439dc0f/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T003548Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3f5bf4badb8d9d478194dfbc5c849827879136c4a4aec0d07daeabb5d69fc7fa"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1d99482c-9426-480a-8bdb-d81dd439dc0f/results/440991/?format=api",
            "id": 440991,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/fe3435a1-8757-4bd4-bc25-9862fa2968cd/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1d99482c-9426-480a-8bdb-d81dd439dc0f/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T003548Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2f11fc8d5331b6bb2e9c0204245941e5ce7b5c0a624b2377a217507fcbb61756"
        }
    ]
}