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/049a4784-9b33-4fe3-a6a0-236cc1dd281b/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/049a4784-9b33-4fe3-a6a0-236cc1dd281b/results/441557/?format=api",
            "id": 441557,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/300067d0-22ce-4ea6-8414-961fe0c1eb75/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/049a4784-9b33-4fe3-a6a0-236cc1dd281b/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T044503Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=07045fc939846177d395fc8db9611352f59beda528d1e4c0924a7834c725ffbf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/049a4784-9b33-4fe3-a6a0-236cc1dd281b/results/441558/?format=api",
            "id": 441558,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/6cbcebb0-c53d-43ed-a668-0beef1c92253/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/049a4784-9b33-4fe3-a6a0-236cc1dd281b/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T044503Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=172625fb0178af90fa2746368289b244f80270e604f169f2d0cb40b711735790"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/049a4784-9b33-4fe3-a6a0-236cc1dd281b/results/441559/?format=api",
            "id": 441559,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/e1c5877f-b140-426e-ac02-e012a5b5a67f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/049a4784-9b33-4fe3-a6a0-236cc1dd281b/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T044503Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=566dda8336eeff662eec23d29284b8bab651424c6e32d9b878d6634296a7ae73"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/049a4784-9b33-4fe3-a6a0-236cc1dd281b/results/441560/?format=api",
            "id": 441560,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/dfe28a0f-34af-4496-be74-77ac2e6dd1d1/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/049a4784-9b33-4fe3-a6a0-236cc1dd281b/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T044503Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=76cade63c6bad4a589333d174bfcb3c6a59ac3a12397826848a4f7f23f2f3522"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/049a4784-9b33-4fe3-a6a0-236cc1dd281b/results/441561/?format=api",
            "id": 441561,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/cef53eea-54ed-4322-bb37-600ac9518835/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/049a4784-9b33-4fe3-a6a0-236cc1dd281b/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T044503Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b39de217ee35e1e4d08e049dfe2dca1d3a1de9ced871d39362eb5e2977749358"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/049a4784-9b33-4fe3-a6a0-236cc1dd281b/results/441562/?format=api",
            "id": 441562,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/61fd98dc-ee67-4dcf-bfee-dc4b76bac069/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/049a4784-9b33-4fe3-a6a0-236cc1dd281b/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T044503Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9fd7488242bd006d960642cee25084308bd182dde647b9612fb9fcef462b71a6"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/049a4784-9b33-4fe3-a6a0-236cc1dd281b/results/441563/?format=api",
            "id": 441563,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/ba066e0b-8b7c-43ae-8d78-8853bec51505/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/049a4784-9b33-4fe3-a6a0-236cc1dd281b/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T044503Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=53d4f9d00080d12b12271754d0ba4f384d8b9cf1234299de2b0706f058b2eb09"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/049a4784-9b33-4fe3-a6a0-236cc1dd281b/results/441564/?format=api",
            "id": 441564,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d28a5b07-4803-421f-bfb8-008f070a4df7/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/049a4784-9b33-4fe3-a6a0-236cc1dd281b/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T044503Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0c0a6bd1391a4ce911aafbf037efa34e1ae3f98471a366683ae78552ce496999"
        }
    ]
}