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/265021da-c72b-40e2-83c4-9a0ec8bc2ebc/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/265021da-c72b-40e2-83c4-9a0ec8bc2ebc/results/449002/?format=api",
            "id": 449002,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b1c4c0c4-01b2-4718-a9fc-ed9689836d75/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/265021da-c72b-40e2-83c4-9a0ec8bc2ebc/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T190456Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1f7dd7f804a85ceb00e739a29bd7d6094297b0add4758e409ab77b9ea8551dc9"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/265021da-c72b-40e2-83c4-9a0ec8bc2ebc/results/449003/?format=api",
            "id": 449003,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/dc51be95-4ee4-4cf5-b7d3-3d442a994b42/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/265021da-c72b-40e2-83c4-9a0ec8bc2ebc/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T190456Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=05f5d08fae8fb441d74ae9de4501110aeeb95fc276cb298fb18004c11eb17b40"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/265021da-c72b-40e2-83c4-9a0ec8bc2ebc/results/449004/?format=api",
            "id": 449004,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/e12ca82b-cea6-49dd-a505-c67274ac837a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/265021da-c72b-40e2-83c4-9a0ec8bc2ebc/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T190456Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2563b9d34c539afc6fcecdc7f08097808535ac0c59997211484fbb14936236ad"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/265021da-c72b-40e2-83c4-9a0ec8bc2ebc/results/449005/?format=api",
            "id": 449005,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/3a3aa9c8-2ada-4097-bcea-33cc466cf390/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/265021da-c72b-40e2-83c4-9a0ec8bc2ebc/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T190456Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=773bde529a10e4fc8dfb4df83fada7019a15960295638a7e3098403e3e533378"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/265021da-c72b-40e2-83c4-9a0ec8bc2ebc/results/449006/?format=api",
            "id": 449006,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/edb526bc-0b4a-437a-8d9d-3ea0d22fc948/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/265021da-c72b-40e2-83c4-9a0ec8bc2ebc/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T190456Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c01f689ae0f390adf0fa5257433e5da6aee9876e4d5b181c67c61564fa305a1b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/265021da-c72b-40e2-83c4-9a0ec8bc2ebc/results/449007/?format=api",
            "id": 449007,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/8f90805f-58a3-4459-a09b-02b43afd736d/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/265021da-c72b-40e2-83c4-9a0ec8bc2ebc/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T190456Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ddbab0c5b9f036ec29303414456270eee58b77d0e6b6fb55622d42977d978b72"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/265021da-c72b-40e2-83c4-9a0ec8bc2ebc/results/449008/?format=api",
            "id": 449008,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a36adfbe-5d19-4921-8013-702a40968da8/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/265021da-c72b-40e2-83c4-9a0ec8bc2ebc/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T190456Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=bfe9c75160411e29dc1012404a9528a33092ff41d4aa768ddecc71fcc2097f96"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/265021da-c72b-40e2-83c4-9a0ec8bc2ebc/results/449009/?format=api",
            "id": 449009,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/91917c13-c72f-42e0-b8ca-d01e10a86024/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/265021da-c72b-40e2-83c4-9a0ec8bc2ebc/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T190456Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a3623bdfc52931ac4d8944107386f2e02da206c15c4f0c5f9d26cf64cfe10065"
        }
    ]
}