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/761a0c61-422a-48a1-b255-a57f86193a3d/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/761a0c61-422a-48a1-b255-a57f86193a3d/results/263171/?format=api",
            "id": 263171,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": "Water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/596cbb80-ca1b-446b-8b3b-d4a09bfe656f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/761a0c61-422a-48a1-b255-a57f86193a3d/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T192414Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7ecb3ad8a248c175dcfeb6c865571c6fee4cb634261add37a11d9846409854d6"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/761a0c61-422a-48a1-b255-a57f86193a3d/results/263172/?format=api",
            "id": 263172,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": "Max water depth",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/f9649010-a911-4859-ada5-1984bc65d407/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/761a0c61-422a-48a1-b255-a57f86193a3d/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T192414Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=93b88a30c577bb821b662d97e778f5a9ce7f6a60919c568e79fd8771eb4b0160"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/761a0c61-422a-48a1-b255-a57f86193a3d/results/263173/?format=api",
            "id": 263173,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": "Flood hazard rating",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/9e1095b3-6ce6-4f40-bf46-8c15a47d3d44/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/761a0c61-422a-48a1-b255-a57f86193a3d/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T192414Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8fdae3b13cba087da9a59f03fa0d8f8a4661bda29be8eeb80fb75f1b22ccc457"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/761a0c61-422a-48a1-b255-a57f86193a3d/results/263174/?format=api",
            "id": 263174,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": "Rate of rise of the water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/461af5f1-183c-4b96-9566-0e1a6f22a1e3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/761a0c61-422a-48a1-b255-a57f86193a3d/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T192414Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f023187ef1579840bbbbd7be10da60beb1bbaa386e97781e289375d577468364"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/761a0c61-422a-48a1-b255-a57f86193a3d/results/263175/?format=api",
            "id": 263175,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": "Water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/3986e82b-ad50-46d2-bd48-95b28ee018ac/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/761a0c61-422a-48a1-b255-a57f86193a3d/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T192414Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a838d190455dc8dac6673a221b2905aa2559c651c6b54e726ccfd00c075f7b24"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/761a0c61-422a-48a1-b255-a57f86193a3d/results/263176/?format=api",
            "id": 263176,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": "Max water level",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d427188e-c20e-4c55-8179-0c0288b2e16e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/761a0c61-422a-48a1-b255-a57f86193a3d/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T192414Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b7b02f6dad0836c0022ef60cbad187b0fb5dc14d1787d6c0fc92fc443d413a1a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/761a0c61-422a-48a1-b255-a57f86193a3d/results/263177/?format=api",
            "id": 263177,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": "Max flow velocity",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/9beb012c-076a-47fb-8e34-e47f5d9b52db/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/761a0c61-422a-48a1-b255-a57f86193a3d/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T192414Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7437cfcc5c047f633f5e5c5d248705224f6d5fd49a428d93b1cdc6dc074c3b72"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/761a0c61-422a-48a1-b255-a57f86193a3d/results/263178/?format=api",
            "id": 263178,
            "name": "Rain",
            "code": "rain-quad",
            "description": "Rain",
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/10166ec7-c8a3-484c-9759-ceb998904361/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/761a0c61-422a-48a1-b255-a57f86193a3d/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T192414Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4f3a54de29faf6830eaed5cbbb9947c6fb2b31f994fd22f862443c9c96c98c59"
        }
    ]
}