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/58ecbef9-50c5-4b63-94b2-a765ad935f5a/results/?format=api
HTTP 200 OK
Allow: GET, POST, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "count": 16,
    "next": "https://demo.lizard.net/api/v4/scenarios/58ecbef9-50c5-4b63-94b2-a765ad935f5a/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/58ecbef9-50c5-4b63-94b2-a765ad935f5a/results/452265/?format=api",
            "id": 452265,
            "name": "Grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/452265/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/58ecbef9-50c5-4b63-94b2-a765ad935f5a/results/452266/?format=api",
            "id": 452266,
            "name": "Raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/452266/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/58ecbef9-50c5-4b63-94b2-a765ad935f5a/results/452267/?format=api",
            "id": 452267,
            "name": "Calculation core logging",
            "code": "logfiles",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/452267/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/58ecbef9-50c5-4b63-94b2-a765ad935f5a/results/452287/?format=api",
            "id": 452287,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/94e36494-7134-4a1c-ac59-f7ef047804d7/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/58ecbef9-50c5-4b63-94b2-a765ad935f5a/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T021914Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5be8eb65aa256aceee7be14dd7cab25c5719227df457fac5c68ef730282e2c6f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/58ecbef9-50c5-4b63-94b2-a765ad935f5a/results/452288/?format=api",
            "id": 452288,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2f7f3167-9ef3-4a34-841d-0ddc9518cb1f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/58ecbef9-50c5-4b63-94b2-a765ad935f5a/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T021914Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1cf2e3f520cf46fa4935cb8c07472a6a5ea5ed028ff97bd3ed7075a1cdcc901f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/58ecbef9-50c5-4b63-94b2-a765ad935f5a/results/452289/?format=api",
            "id": 452289,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/42f06ba3-4216-458d-a251-bff0e20ea317/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/58ecbef9-50c5-4b63-94b2-a765ad935f5a/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T021914Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=440b5a8e1f7dba5eb1c9e31b326d5eeb00f3f04741ffff3ec284788720cdf886"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/58ecbef9-50c5-4b63-94b2-a765ad935f5a/results/452290/?format=api",
            "id": 452290,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/daae6c72-6e4d-4577-81eb-146550e1defe/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/58ecbef9-50c5-4b63-94b2-a765ad935f5a/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T021914Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=50d3cac49cdd3c96cf2c8f0c7e786fb9fd6c26496b4782770bb21115d0581292"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/58ecbef9-50c5-4b63-94b2-a765ad935f5a/results/452291/?format=api",
            "id": 452291,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a7e503ab-17d5-4a1a-a730-97a71a229afe/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/58ecbef9-50c5-4b63-94b2-a765ad935f5a/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T021914Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e94b17767f1db2f8cdda70f911af9c50caf11f058f67dabd7853219219f5366b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/58ecbef9-50c5-4b63-94b2-a765ad935f5a/results/452292/?format=api",
            "id": 452292,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/68a543fc-b4c9-4607-ab9b-82502dea5766/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/58ecbef9-50c5-4b63-94b2-a765ad935f5a/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T021914Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=54e7f5bc2b26f0256b4f62600ed1db76b927e5bcd20bc2e776e95f54d6776c94"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/58ecbef9-50c5-4b63-94b2-a765ad935f5a/results/452293/?format=api",
            "id": 452293,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/527ff2e9-5871-457e-92d1-c28e2a1d5bf7/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/58ecbef9-50c5-4b63-94b2-a765ad935f5a/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T021914Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6f40d66e7cca2fe1a775ea371e02f4d72c0fc65eb887c524fce1be15deae63be"
        }
    ]
}