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/334c23ae-0f74-4176-b2bd-e5a75a224b62/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/334c23ae-0f74-4176-b2bd-e5a75a224b62/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/334c23ae-0f74-4176-b2bd-e5a75a224b62/results/441212/?format=api",
            "id": 441212,
            "name": "Grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/441212/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/334c23ae-0f74-4176-b2bd-e5a75a224b62/results/441213/?format=api",
            "id": 441213,
            "name": "Raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/441213/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/334c23ae-0f74-4176-b2bd-e5a75a224b62/results/441214/?format=api",
            "id": 441214,
            "name": "Calculation core logging",
            "code": "logfiles",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/441214/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/334c23ae-0f74-4176-b2bd-e5a75a224b62/results/441215/?format=api",
            "id": 441215,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/9eff9271-ae86-4d77-99f3-08df0632c8f0/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/334c23ae-0f74-4176-b2bd-e5a75a224b62/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T220930Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c167df6cc3334842eb8ec7730c0042a2ad6634ba4783c7759c81452f14367724"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/334c23ae-0f74-4176-b2bd-e5a75a224b62/results/441216/?format=api",
            "id": 441216,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/56da5a77-74c6-4523-988f-b8ff196261e5/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/334c23ae-0f74-4176-b2bd-e5a75a224b62/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T220930Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=224f9d9f1468f4eb374b9697f49e06e05ffd513ba55076dd2e7feb54da47b68c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/334c23ae-0f74-4176-b2bd-e5a75a224b62/results/441217/?format=api",
            "id": 441217,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/0581e54f-0062-4192-9334-d6249ccfd1be/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/334c23ae-0f74-4176-b2bd-e5a75a224b62/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T220930Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c1180000fc2e6bcd9c2220383c1c152a3f757614dc3bc716786b963b67c7919d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/334c23ae-0f74-4176-b2bd-e5a75a224b62/results/441218/?format=api",
            "id": 441218,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b960a798-2877-4c99-9d7c-a65b65ba8a4f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/334c23ae-0f74-4176-b2bd-e5a75a224b62/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T220930Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8d6f6d2684c28cf99f5f67c6b7c827536f264105549925f30c98717e43084949"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/334c23ae-0f74-4176-b2bd-e5a75a224b62/results/441219/?format=api",
            "id": 441219,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/f10cdac8-a7c6-4281-b7bc-1537cb87fb6c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/334c23ae-0f74-4176-b2bd-e5a75a224b62/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T220930Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=cfa1358dd70abf1317ce27b1191a19b1c93beeefb8d18955443b13fe3122af36"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/334c23ae-0f74-4176-b2bd-e5a75a224b62/results/441220/?format=api",
            "id": 441220,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c39f616f-63de-46fb-a409-1ab67fbaafe4/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/334c23ae-0f74-4176-b2bd-e5a75a224b62/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T220930Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c095305c56f6f276b59b728b7d85dd3b5f30ee777be6f7e4b9e078e4f83ba38c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/334c23ae-0f74-4176-b2bd-e5a75a224b62/results/441221/?format=api",
            "id": 441221,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/8bd8c8d5-8fdb-463e-975a-4260f445db3c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/334c23ae-0f74-4176-b2bd-e5a75a224b62/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T220930Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=82dde5445af683f23d17bb2ac451ac435d29b1772d1699e1601d1d38d5dd2495"
        }
    ]
}