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/b8009661-9f11-4d1b-ba94-a835888e5abf/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/b8009661-9f11-4d1b-ba94-a835888e5abf/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b8009661-9f11-4d1b-ba94-a835888e5abf/results/455431/?format=api",
            "id": 455431,
            "name": "Grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/455431/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b8009661-9f11-4d1b-ba94-a835888e5abf/results/455432/?format=api",
            "id": 455432,
            "name": "Raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/455432/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b8009661-9f11-4d1b-ba94-a835888e5abf/results/455433/?format=api",
            "id": 455433,
            "name": "Calculation core logging",
            "code": "logfiles",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/455433/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b8009661-9f11-4d1b-ba94-a835888e5abf/results/455434/?format=api",
            "id": 455434,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/baf3485b-47bb-4978-9183-7b6eec4b0a45/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b8009661-9f11-4d1b-ba94-a835888e5abf/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T071417Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=04b11c4b8356c2c31ec5e37cf6b46aba2a6305b0632a28cf286fe9f765942d86"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b8009661-9f11-4d1b-ba94-a835888e5abf/results/455435/?format=api",
            "id": 455435,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b5dc58f0-2e62-473e-8cde-5a82a9eee0c6/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b8009661-9f11-4d1b-ba94-a835888e5abf/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T071417Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6cf0ecafd3dc53b67791addb1cdd19c430240d5084d4e8cd2bcdc0b5bf588433"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b8009661-9f11-4d1b-ba94-a835888e5abf/results/455436/?format=api",
            "id": 455436,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/1d975aed-222d-46ea-84c1-a098ca10323b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b8009661-9f11-4d1b-ba94-a835888e5abf/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T071417Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b60ebd26bf86f6344f5c924112f2419f516d8a03fd5be33e9e1ae53d185549a8"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b8009661-9f11-4d1b-ba94-a835888e5abf/results/455437/?format=api",
            "id": 455437,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/f714e04f-759c-4438-9a9b-963eb5bbc785/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b8009661-9f11-4d1b-ba94-a835888e5abf/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T071417Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=01defe5f236b5b6a38d677481a2ea07cb63e8b7c6a36885c2ff2b8091b7785ea"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b8009661-9f11-4d1b-ba94-a835888e5abf/results/455438/?format=api",
            "id": 455438,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a4d7bbaf-de4e-4d74-b865-547eb1d029d6/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b8009661-9f11-4d1b-ba94-a835888e5abf/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T071417Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=bd47770def232373211a60b1eb6be39c55b68d985f50c8936ea91ca0b4664eb4"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b8009661-9f11-4d1b-ba94-a835888e5abf/results/455439/?format=api",
            "id": 455439,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/efbcf59e-1d79-4116-9266-4a3278df0bd6/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b8009661-9f11-4d1b-ba94-a835888e5abf/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T071417Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7a8f9154f48691f944ff9fab24c4631017bf0f21c1ff3094618c55efbf6e194a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b8009661-9f11-4d1b-ba94-a835888e5abf/results/455440/?format=api",
            "id": 455440,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/5a5faa70-124b-4754-b9ce-cb29665c8901/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b8009661-9f11-4d1b-ba94-a835888e5abf/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T071417Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=87cf4d2290d61f0d8beb217ca182bd538135de6aac9f957048ed1f785d2ef1a0"
        }
    ]
}