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/c0c5ac18-6754-4500-9e40-7c68ce2e3eb7/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/c0c5ac18-6754-4500-9e40-7c68ce2e3eb7/results/449517/?format=api",
            "id": 449517,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/1f468b0c-74b9-4188-97fc-e23027e8aa6c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c0c5ac18-6754-4500-9e40-7c68ce2e3eb7/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T111138Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a25e48c6f9c1f8bb3ba602c8a765821eb7fe6fa9908288512193718fbe061690"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c0c5ac18-6754-4500-9e40-7c68ce2e3eb7/results/449518/?format=api",
            "id": 449518,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/fe647c62-42dd-4a2c-b784-4daa8537a8da/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c0c5ac18-6754-4500-9e40-7c68ce2e3eb7/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T111138Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e9043a743c4774d0768ced9ab001bc7723f73b829e62c69fbdd0a7e3248b732c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c0c5ac18-6754-4500-9e40-7c68ce2e3eb7/results/449519/?format=api",
            "id": 449519,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/699ff81d-2f46-498c-930e-f0b761f397f1/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c0c5ac18-6754-4500-9e40-7c68ce2e3eb7/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T111138Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=998337c14a185c3b8fc956d045551b696a9aa027755e8e449b2346c3e427c8e2"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c0c5ac18-6754-4500-9e40-7c68ce2e3eb7/results/449520/?format=api",
            "id": 449520,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/6a6765ec-c1c0-4fe7-8f02-74ff245dbc21/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c0c5ac18-6754-4500-9e40-7c68ce2e3eb7/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T111138Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=46a3de2970eccbb99520e540439a3099741d169da9137c53d2193db4b0044285"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c0c5ac18-6754-4500-9e40-7c68ce2e3eb7/results/449521/?format=api",
            "id": 449521,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/590d218b-6115-4d18-8301-266fa0635bb3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c0c5ac18-6754-4500-9e40-7c68ce2e3eb7/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T111138Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=977230bf86cc8b3c45207655203a09e6b8953fe4f94204e44148f03332dacdbe"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c0c5ac18-6754-4500-9e40-7c68ce2e3eb7/results/449522/?format=api",
            "id": 449522,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/cc795297-a7bb-4bb5-b5eb-da2e917f299b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c0c5ac18-6754-4500-9e40-7c68ce2e3eb7/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T111138Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c9e8a54297bbf20f2af15f7aa788897e0c40d3a0802b73ff35691551e7236032"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c0c5ac18-6754-4500-9e40-7c68ce2e3eb7/results/449523/?format=api",
            "id": 449523,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4a480839-0e63-4e74-bc89-a7a7f949bfd1/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c0c5ac18-6754-4500-9e40-7c68ce2e3eb7/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T111138Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=84456111408bace6f2dfc395e68e4715459557f8a81e86fea0d179aa1245fc5e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c0c5ac18-6754-4500-9e40-7c68ce2e3eb7/results/449524/?format=api",
            "id": 449524,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c7edcbc1-26da-4656-a569-708cdb08f7f8/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c0c5ac18-6754-4500-9e40-7c68ce2e3eb7/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T111138Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c3ad06a3a241a2389bad8c305f53faf5d8752b97c0de40b55cf2446cf8e88e3d"
        }
    ]
}