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/81d5415e-fcbd-40b9-afb7-dac4858a0f01/results/?format=api
HTTP 200 OK
Allow: GET, POST, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "count": 16,
    "next": "https://demo.lizard.net/api/v4/scenarios/81d5415e-fcbd-40b9-afb7-dac4858a0f01/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/81d5415e-fcbd-40b9-afb7-dac4858a0f01/results/448095/?format=api",
            "id": 448095,
            "name": "Grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/448095/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/81d5415e-fcbd-40b9-afb7-dac4858a0f01/results/448096/?format=api",
            "id": 448096,
            "name": "Raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/448096/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/81d5415e-fcbd-40b9-afb7-dac4858a0f01/results/448097/?format=api",
            "id": 448097,
            "name": "Calculation core logging",
            "code": "logfiles",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/448097/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/81d5415e-fcbd-40b9-afb7-dac4858a0f01/results/448098/?format=api",
            "id": 448098,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/00551c79-3f3a-4804-b7a4-7edb1b8016c9/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/81d5415e-fcbd-40b9-afb7-dac4858a0f01/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T184539Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4d095b844114d6e18d125e444495a463d295400bd9129949002f23cffbf482a5"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/81d5415e-fcbd-40b9-afb7-dac4858a0f01/results/448099/?format=api",
            "id": 448099,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/1a34b39f-456a-42e9-ac8e-c387a27b1113/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/81d5415e-fcbd-40b9-afb7-dac4858a0f01/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T184539Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c0001c1ebcb136b296fd7ff12561b9c706888ffaaefcefc464218245c94e68ed"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/81d5415e-fcbd-40b9-afb7-dac4858a0f01/results/448100/?format=api",
            "id": 448100,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/3b0c57bf-f034-4c04-9324-b1af7c5d6ec4/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/81d5415e-fcbd-40b9-afb7-dac4858a0f01/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T184539Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e2c2a597291fb9c7e14f6943185b84642ed182611b81ee1e288ee1fd66b9085b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/81d5415e-fcbd-40b9-afb7-dac4858a0f01/results/448101/?format=api",
            "id": 448101,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a1ce9d0d-700f-4c09-8833-57a520d9a1b5/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/81d5415e-fcbd-40b9-afb7-dac4858a0f01/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T184539Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=de8bbfe8b66eabda96b1f2f5923158f80d02481353f16bdef7bc01c1db352820"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/81d5415e-fcbd-40b9-afb7-dac4858a0f01/results/448102/?format=api",
            "id": 448102,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/aa669d1b-3606-4b8c-bf84-2e2b54d2f9b3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/81d5415e-fcbd-40b9-afb7-dac4858a0f01/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T184539Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=33887861ed077797b65cde61983f65df8b331a17f433590f7cb3aa941d6108e6"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/81d5415e-fcbd-40b9-afb7-dac4858a0f01/results/448103/?format=api",
            "id": 448103,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/7dad8902-7d0e-454b-a20e-f82867849930/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/81d5415e-fcbd-40b9-afb7-dac4858a0f01/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T184539Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9118ba0ea6aa04a73b4b7f44b16693d6b14657114ebb9dbcb716d792cce15860"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/81d5415e-fcbd-40b9-afb7-dac4858a0f01/results/448104/?format=api",
            "id": 448104,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2b635643-909a-4d29-b255-73539e153353/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/81d5415e-fcbd-40b9-afb7-dac4858a0f01/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T184539Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2fee5e0b4e053a25b69a5b05c21994c91653651d68fe0df97b15f6a69bb26168"
        }
    ]
}