Basic – Django REST framework

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/basic/?format=api

HTTP 200 OK
Allow: GET, DELETE, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "count": 8,
    "next": null,
    "previous": null,
    "results": [
        {
            "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=20250315T061956Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=bfe1ea8ec7a0c5336b322b01b2e074a32e8f3423a6f0f77a799c734506361978"
        },
        {
            "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=20250315T061956Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6f219f222f6628f153658d05ac14310934399573b4933d61f602c7db0341c7a3"
        },
        {
            "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=20250315T061956Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=376c1a9889ca919b579e111f22af8a8cec5aa68693174e7de0d34382b6037326"
        },
        {
            "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=20250315T061956Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=89abea1c9e9678fa107c42dcd16f0abf31a52c5c3bd819f8feb143b27b58a6b8"
        },
        {
            "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=20250315T061956Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=49965a9b3a46c910197c32e3fb029c67cbad34d21e4bf6a28e9cb0e170dc6662"
        },
        {
            "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=20250315T061956Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c1beccfa7a0223a004de6ea084a8ad69a5b51fa7b957d6ba9d2861687e77c564"
        },
        {
            "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=20250315T061956Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0c7c344de5572b154475019c2c26723b1a3a4812e836d80cf61031d89c5cf62f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/58ecbef9-50c5-4b63-94b2-a765ad935f5a/results/452294/?format=api",
            "id": 452294,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/0c21a43e-9703-442f-a80e-de32afec9150/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/58ecbef9-50c5-4b63-94b2-a765ad935f5a/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T061956Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3da62adb82f0d7de0408ea4c389a3cf432974172712763845bd658527e9e7767"
        }
    ]
}