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/91373aa6-f692-4f3b-bd69-a4d88dc5f26d/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/91373aa6-f692-4f3b-bd69-a4d88dc5f26d/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/91373aa6-f692-4f3b-bd69-a4d88dc5f26d/results/454914/?format=api",
            "id": 454914,
            "name": "Grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/454914/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/91373aa6-f692-4f3b-bd69-a4d88dc5f26d/results/454915/?format=api",
            "id": 454915,
            "name": "Raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/454915/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/91373aa6-f692-4f3b-bd69-a4d88dc5f26d/results/454916/?format=api",
            "id": 454916,
            "name": "Calculation core logging",
            "code": "logfiles",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/454916/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/91373aa6-f692-4f3b-bd69-a4d88dc5f26d/results/454917/?format=api",
            "id": 454917,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d64db472-b7bb-4a43-8ab1-8ec2d5969056/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/91373aa6-f692-4f3b-bd69-a4d88dc5f26d/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T043250Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1f9946a3589490144addaacfde4a36e4622e4d58ccca962d8e6c38496994f038"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/91373aa6-f692-4f3b-bd69-a4d88dc5f26d/results/454918/?format=api",
            "id": 454918,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/04767549-b054-4aa3-a03e-96cda82ddfdf/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/91373aa6-f692-4f3b-bd69-a4d88dc5f26d/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T043250Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=17e1a804a02ad3674f62efb3265209525e60f8d102b9c024457d0a087974eae2"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/91373aa6-f692-4f3b-bd69-a4d88dc5f26d/results/454919/?format=api",
            "id": 454919,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/7e906a54-085d-43be-9e12-2af337e62010/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/91373aa6-f692-4f3b-bd69-a4d88dc5f26d/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T043250Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3419f0d965a882258e6ff38752ebb938d44589c70e5341d1eb3d3c1b51944b23"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/91373aa6-f692-4f3b-bd69-a4d88dc5f26d/results/454920/?format=api",
            "id": 454920,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/402f43a2-57dd-4c50-819f-e45367f71881/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/91373aa6-f692-4f3b-bd69-a4d88dc5f26d/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T043250Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ef341476167842e1df26a103c02b6f842999deb6e7740a4b7124952ea09cb312"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/91373aa6-f692-4f3b-bd69-a4d88dc5f26d/results/454921/?format=api",
            "id": 454921,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/ea3b1d28-7d71-4d04-ad30-42c42e7e816a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/91373aa6-f692-4f3b-bd69-a4d88dc5f26d/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T043250Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=124fbafaf3c99dc343fabf917aafe92e1997e0f328c3832cc1d3746ff3f89d68"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/91373aa6-f692-4f3b-bd69-a4d88dc5f26d/results/454922/?format=api",
            "id": 454922,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2368eba9-20d3-436c-b718-a30aa7e95af8/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/91373aa6-f692-4f3b-bd69-a4d88dc5f26d/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T043250Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=38ecc2afcd9de12b8bd8613eb56752e5f926728718b2c3f2245e9341d7b57dd4"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/91373aa6-f692-4f3b-bd69-a4d88dc5f26d/results/454923/?format=api",
            "id": 454923,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d782beb9-58e5-4ff1-8fcd-d3532dd5e58b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/91373aa6-f692-4f3b-bd69-a4d88dc5f26d/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T043250Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1ed0283ae5140349f6855d0cfc0713fc9fe1500aa23ec307f75c82fd13e1fb9e"
        }
    ]
}