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/aa58854a-6486-403b-a000-5ba185a52625/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/aa58854a-6486-403b-a000-5ba185a52625/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/aa58854a-6486-403b-a000-5ba185a52625/results/452259/?format=api",
            "id": 452259,
            "name": "Grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/452259/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/aa58854a-6486-403b-a000-5ba185a52625/results/452260/?format=api",
            "id": 452260,
            "name": "Raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/452260/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/aa58854a-6486-403b-a000-5ba185a52625/results/452261/?format=api",
            "id": 452261,
            "name": "Calculation core logging",
            "code": "logfiles",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/452261/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/aa58854a-6486-403b-a000-5ba185a52625/results/452271/?format=api",
            "id": 452271,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2dbde28e-2d0f-478a-8c31-571f5c5becce/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/aa58854a-6486-403b-a000-5ba185a52625/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T021915Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8a9f1bc58cd56b24e59598d6ece6ef7cc689bbeed3685fb411d8b863f4074232"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/aa58854a-6486-403b-a000-5ba185a52625/results/452272/?format=api",
            "id": 452272,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/5d4fb03a-11fd-4695-838b-0a97585ea472/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/aa58854a-6486-403b-a000-5ba185a52625/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T021915Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1c87dc0b20f43bfb7ab287d13151ce9efe1fc41d49d00ab4704e8701e7157ad2"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/aa58854a-6486-403b-a000-5ba185a52625/results/452273/?format=api",
            "id": 452273,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c14cf089-8490-42b1-a89a-873f627e7e4e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/aa58854a-6486-403b-a000-5ba185a52625/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T021915Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6542a706c5783ad0332217f0a40d8b1d09ccf9950739dba2faacc33d4ca3763f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/aa58854a-6486-403b-a000-5ba185a52625/results/452274/?format=api",
            "id": 452274,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c4ef5a84-7837-4f1f-8f5a-44514e0da4df/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/aa58854a-6486-403b-a000-5ba185a52625/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T021915Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7c8b601c1ff8d27468271235936a1315f63f0831e11031516a27cdd8a77f759d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/aa58854a-6486-403b-a000-5ba185a52625/results/452275/?format=api",
            "id": 452275,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/0cb99313-8fd2-40dd-839e-f36f34c66322/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/aa58854a-6486-403b-a000-5ba185a52625/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T021915Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a06be99c992a9f70fdf7e83cc0b3f6c738e381658627a87d2ff5d196de276a4d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/aa58854a-6486-403b-a000-5ba185a52625/results/452276/?format=api",
            "id": 452276,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/8f2c6f17-fe11-4d32-8662-1a6f909468ef/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/aa58854a-6486-403b-a000-5ba185a52625/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T021915Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2b6b9a4c35e1fb9656690e1caf85ec1bd117a32968653ea31019fdc64bd68c87"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/aa58854a-6486-403b-a000-5ba185a52625/results/452277/?format=api",
            "id": 452277,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a2e7a1b0-35bf-4965-ba99-f0ce0ec3e604/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/aa58854a-6486-403b-a000-5ba185a52625/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T021915Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=91ea14d181501a6220da8d2e9d2901194052b5a0cac29973eb0c330a9e9f97ae"
        }
    ]
}