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/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/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/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/results/449647/?format=api",
            "id": 449647,
            "name": "Grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/449647/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/results/449648/?format=api",
            "id": 449648,
            "name": "Raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/449648/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/results/449649/?format=api",
            "id": 449649,
            "name": "Calculation core logging",
            "code": "logfiles",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/449649/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/results/449667/?format=api",
            "id": 449667,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/caaa058c-8a63-47c8-b10b-1e16874c7b78/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T033206Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=601db8fb3d4dd18f7ec00029ca3554b0fa1a7fa4d3c829b6fb9f71d9d0d31582"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/results/449668/?format=api",
            "id": 449668,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/81b972d9-c7b4-4cb0-a6c9-9e8d8aeb169d/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T033206Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a794fa88f720d05541107b08eef9df8846b5bf7b2537d8df7102d1b742257142"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/results/449669/?format=api",
            "id": 449669,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c0d519c8-ee93-4759-9c0f-1fb04c01e871/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T033206Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2f07be2f2f1857b02ec3025be0457a9b4d40ddcd23d9e92ca82551cf17021832"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/results/449670/?format=api",
            "id": 449670,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/e92c7882-75cf-45d0-8bed-8830e8c955f0/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T033206Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8b91460572046ef08410df3670ceea01554b39e8bc7bf11c32e46a593db07b18"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/results/449671/?format=api",
            "id": 449671,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/5c44d838-dd08-45d4-8c56-eb3d8fe08223/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T033206Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6de22daae5d4e254eb741c0df87998eb8f70736883bf2d37e04996662e592676"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/results/449672/?format=api",
            "id": 449672,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b99d6dd5-5d32-4c81-8c7f-a324b074976e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T033206Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=646c09a88b94f508051b44a5827800da225514bb78df094977b45533f04b795c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/results/449673/?format=api",
            "id": 449673,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c8f5f461-ac59-48e0-bd03-a5ed34a0b299/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T033206Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=07fa440289fa1ac9e62cc4d6eafcbf3add5ca2418a42b0cadaf6a885a94c5c67"
        }
    ]
}