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/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/results/?format=api
HTTP 200 OK
Allow: GET, POST, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "count": 17,
    "next": "https://demo.lizard.net/api/v4/scenarios/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/results/455916/?format=api",
            "id": 455916,
            "name": "Grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/455916/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/results/455917/?format=api",
            "id": 455917,
            "name": "Raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/455917/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/results/455918/?format=api",
            "id": 455918,
            "name": "Calculation core logging",
            "code": "logfiles",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/455918/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/results/455919/?format=api",
            "id": 455919,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/fb3fb60d-71bb-4973-badf-42764d54a37f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001407Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=23decac9a9102d0f08710e5cae20fdebe9318adda004353a2694d0cd8ddb40a0"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/results/455920/?format=api",
            "id": 455920,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c1811d22-e947-43b4-9330-81d6c650e2c9/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001407Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d939c6c792ad860dc837041fe5bfff6189afbaf8ce10ed31a5cb316d5d31a662"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/results/455921/?format=api",
            "id": 455921,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/611be140-09c8-4174-8231-3a044be3b5f1/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001407Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=bed5f1da1a86b4d20df3195fb0ce6c40d39eb1c3daccf92d081ac3ba3b28bced"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/results/455922/?format=api",
            "id": 455922,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/636cf70e-d097-43a7-8ad1-754b5ca5df31/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001407Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7548d7d60e9606ef7e4b935a3f7735798975d7979d574bcfa454ac97305a6f53"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/results/455923/?format=api",
            "id": 455923,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d0d729b5-1f74-458d-8a96-d387886681c5/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001407Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=68b2b64c4c7044b26e7059320dcd47d1d8d1af44f1ffb179345e115dacb3bac1"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/results/455924/?format=api",
            "id": 455924,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/0e56bd12-f317-45cb-9c78-e15cf260aa16/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001407Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=912d546b633e49a3effe1e83310a3e7bc7ca6a759c1cc9782755cd385fc04671"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/results/455925/?format=api",
            "id": 455925,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/78ecf19c-ae28-4101-a502-de3489450971/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001407Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e86d9fe4c73143bd3d2a09da3fde8a33131357fdbe137fe499f35da80cb81bef"
        }
    ]
}