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/6e5a64d7-9a6a-4f6d-a595-38a4b2f1cebb/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/6e5a64d7-9a6a-4f6d-a595-38a4b2f1cebb/results/453513/?format=api",
            "id": 453513,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c6ffd796-58ad-40a6-a6f9-2ec24c7a5d0f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6e5a64d7-9a6a-4f6d-a595-38a4b2f1cebb/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T061951Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4cdc1622ce89733041b58e8e1a919228b9316775fa3448c161a78785897c790d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6e5a64d7-9a6a-4f6d-a595-38a4b2f1cebb/results/453514/?format=api",
            "id": 453514,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/8d70ea93-7702-4d1f-ac86-1672231e5fa1/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6e5a64d7-9a6a-4f6d-a595-38a4b2f1cebb/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T061951Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=94abfd63ba8a34c442684e571f421db196cf5954363504e64c04046e9306929b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6e5a64d7-9a6a-4f6d-a595-38a4b2f1cebb/results/453515/?format=api",
            "id": 453515,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4111109f-cace-40aa-acaf-f2d07ed0460b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6e5a64d7-9a6a-4f6d-a595-38a4b2f1cebb/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T061951Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=86c0320afca780cfa6809c7bf799389e31d0291d75f48b023595e4ba24bad045"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6e5a64d7-9a6a-4f6d-a595-38a4b2f1cebb/results/453516/?format=api",
            "id": 453516,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/23a113c9-97bb-4862-b95c-14cdfb073aba/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6e5a64d7-9a6a-4f6d-a595-38a4b2f1cebb/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T061951Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f6625326027f23f3df4c7fbc403a9fa00840321bd539f97c44adc06c1bbdc007"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6e5a64d7-9a6a-4f6d-a595-38a4b2f1cebb/results/453517/?format=api",
            "id": 453517,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/7cb1b53e-d3e2-4743-8b35-ea1045e6d43c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6e5a64d7-9a6a-4f6d-a595-38a4b2f1cebb/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T061951Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8dc0e42ffe842b9b566bce8ff59676b217f96207a6cef0bec3b73b1cec5ecdf7"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6e5a64d7-9a6a-4f6d-a595-38a4b2f1cebb/results/453518/?format=api",
            "id": 453518,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/fb27fbf4-8491-4ee1-b6a9-03bb7d3fd973/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6e5a64d7-9a6a-4f6d-a595-38a4b2f1cebb/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T061951Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=dabfb92769e5601a37bd00b7dac711ced53241fba9dc4827f1fcb3973298ab77"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6e5a64d7-9a6a-4f6d-a595-38a4b2f1cebb/results/453519/?format=api",
            "id": 453519,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/6bb1870e-50a0-44c7-9214-6b20559cfb67/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6e5a64d7-9a6a-4f6d-a595-38a4b2f1cebb/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T061951Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7583c001ae2f660d1dfcba220a59095b4b4350fa4f4aeda38253d703e93f3489"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6e5a64d7-9a6a-4f6d-a595-38a4b2f1cebb/results/453520/?format=api",
            "id": 453520,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b1da65b6-286f-466a-98e6-585a8303cd35/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6e5a64d7-9a6a-4f6d-a595-38a4b2f1cebb/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T061951Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0efc51734477d77f29999fc6d2a0c7f65740f1ab425040bd4516360818e18eb0"
        }
    ]
}