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/47e8e9df-5349-4b7c-97df-7fc10d22e271/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/47e8e9df-5349-4b7c-97df-7fc10d22e271/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/47e8e9df-5349-4b7c-97df-7fc10d22e271/results/455376/?format=api",
            "id": 455376,
            "name": "Grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/455376/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/47e8e9df-5349-4b7c-97df-7fc10d22e271/results/455377/?format=api",
            "id": 455377,
            "name": "Raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/455377/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/47e8e9df-5349-4b7c-97df-7fc10d22e271/results/455378/?format=api",
            "id": 455378,
            "name": "Calculation core logging",
            "code": "logfiles",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/455378/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/47e8e9df-5349-4b7c-97df-7fc10d22e271/results/455379/?format=api",
            "id": 455379,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/68c2bdcb-f74f-48eb-9ec5-c3d141ba5704/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/47e8e9df-5349-4b7c-97df-7fc10d22e271/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001614Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=458d59d223ed59cb4d8302ff70a72fa1cc27b2cba86292670214b23b3c08383a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/47e8e9df-5349-4b7c-97df-7fc10d22e271/results/455380/?format=api",
            "id": 455380,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/bb78daff-5e23-4b2b-bb7a-543c48dc45f8/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/47e8e9df-5349-4b7c-97df-7fc10d22e271/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001614Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7a9cbbac1df8b520240ed704dcad91f8c60e5035f3a41f47ac77fbb1a0edf966"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/47e8e9df-5349-4b7c-97df-7fc10d22e271/results/455381/?format=api",
            "id": 455381,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/9b621822-a45b-454c-bc85-cc0af5f8aba1/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/47e8e9df-5349-4b7c-97df-7fc10d22e271/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001614Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3fd90dea5aa882243eff0ebe5d043aa5ec328e972eea0c4b182aeb1fea9505c9"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/47e8e9df-5349-4b7c-97df-7fc10d22e271/results/455382/?format=api",
            "id": 455382,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/dbdadd55-39e5-4b46-9686-09a49fa318c2/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/47e8e9df-5349-4b7c-97df-7fc10d22e271/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001614Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b17a84c1ebc321c762dfdd954f3c7c55baac9489c5af48c771c9edd6bd792ab8"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/47e8e9df-5349-4b7c-97df-7fc10d22e271/results/455383/?format=api",
            "id": 455383,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/fd1a8540-f3b8-4d6f-9248-c5bc42e1b153/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/47e8e9df-5349-4b7c-97df-7fc10d22e271/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001614Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5bf6dc4a2d3d468895a8888f2586d8f7b836d2ee4d5881460e8071ee48068ba4"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/47e8e9df-5349-4b7c-97df-7fc10d22e271/results/455384/?format=api",
            "id": 455384,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/3422341a-d073-4aa7-a885-6f4250c52aab/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/47e8e9df-5349-4b7c-97df-7fc10d22e271/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001614Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=410527858dff770b91a697c3e244189ed5e3c5e428f6398f1c6133b176e54d16"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/47e8e9df-5349-4b7c-97df-7fc10d22e271/results/455385/?format=api",
            "id": 455385,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b2f20c13-555c-474a-86d6-66b33c00047e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/47e8e9df-5349-4b7c-97df-7fc10d22e271/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T001614Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3ac5b58bdbd3c584cd1129919168fa7239411f566891ea2f07ac1bcac04fa074"
        }
    ]
}