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/f168d19b-06d6-4ab2-bb63-8e82050fef8d/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/f168d19b-06d6-4ab2-bb63-8e82050fef8d/results/441291/?format=api",
            "id": 441291,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b938417f-be67-4192-bd4b-65135033878b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f168d19b-06d6-4ab2-bb63-8e82050fef8d/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010026Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1090fea53a2804d42ad85019c6392fcd3406637740a642e6fbdbd6ee1583283c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f168d19b-06d6-4ab2-bb63-8e82050fef8d/results/441292/?format=api",
            "id": 441292,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/dfa6a3a2-a9b8-4dd9-9837-23a29363150c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f168d19b-06d6-4ab2-bb63-8e82050fef8d/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010026Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=060dcf47e200caeb3e1564ce8d8772d9e62f46ca0fca3f5c05b6022c38bfcc9b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f168d19b-06d6-4ab2-bb63-8e82050fef8d/results/441293/?format=api",
            "id": 441293,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/e3f3e2c4-b360-4a50-96d5-83f319577abe/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f168d19b-06d6-4ab2-bb63-8e82050fef8d/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010026Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=65f3b0bc03c6d373f643ff5016882f40d616b7a9b6ce35ce93a3f326fcb23385"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f168d19b-06d6-4ab2-bb63-8e82050fef8d/results/441294/?format=api",
            "id": 441294,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a3294c69-9873-4b05-bdad-9d4f55be75a4/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f168d19b-06d6-4ab2-bb63-8e82050fef8d/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010026Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5546c5e97680428b097ba1dfff16e8f967366ef4cb71efeea7659e7ba2624ce1"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f168d19b-06d6-4ab2-bb63-8e82050fef8d/results/441295/?format=api",
            "id": 441295,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/345dd5a9-0422-4285-8e50-8c009611c70e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f168d19b-06d6-4ab2-bb63-8e82050fef8d/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010026Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=64147a76be42d147543260e82447d2a68e6db571772bfc04fb4a3011baff0475"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f168d19b-06d6-4ab2-bb63-8e82050fef8d/results/441296/?format=api",
            "id": 441296,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/7113adef-68cf-4b35-9719-8b2269f06219/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f168d19b-06d6-4ab2-bb63-8e82050fef8d/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010026Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=974b6ca98aa101a6c457a1d5854a62e3a7212377df7c51316f5d8b5635a02b54"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f168d19b-06d6-4ab2-bb63-8e82050fef8d/results/441297/?format=api",
            "id": 441297,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/f0c82e54-9ef9-4a5d-92a1-bf07bb3986df/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f168d19b-06d6-4ab2-bb63-8e82050fef8d/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010026Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=864f9243af3fe9a02a4aba0edbde0ab9bdbe700f2232099239c240a8ffa1e767"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f168d19b-06d6-4ab2-bb63-8e82050fef8d/results/441298/?format=api",
            "id": 441298,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/73c41b69-97e6-4ef4-a72d-3a77d106af16/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f168d19b-06d6-4ab2-bb63-8e82050fef8d/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010026Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b6d0afbe292d3ada61a6fec1e2c927d078697f7235c01b3e30c54d056619125a"
        }
    ]
}