Result List – 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/ef61f7f1-0c8f-46e8-a55f-16be545d9f8a/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/ef61f7f1-0c8f-46e8-a55f-16be545d9f8a/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ef61f7f1-0c8f-46e8-a55f-16be545d9f8a/results/452268/?format=api",
            "id": 452268,
            "name": "Grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/452268/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ef61f7f1-0c8f-46e8-a55f-16be545d9f8a/results/452269/?format=api",
            "id": 452269,
            "name": "Raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/452269/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ef61f7f1-0c8f-46e8-a55f-16be545d9f8a/results/452270/?format=api",
            "id": 452270,
            "name": "Calculation core logging",
            "code": "logfiles",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/452270/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ef61f7f1-0c8f-46e8-a55f-16be545d9f8a/results/452295/?format=api",
            "id": 452295,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/5af4f30e-e123-4b20-9986-456f57a7f463/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ef61f7f1-0c8f-46e8-a55f-16be545d9f8a/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T053915Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=956020fd32d6858a3584b43b09c2b4eabb6595d7b6fec35676190b56695e4a75"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ef61f7f1-0c8f-46e8-a55f-16be545d9f8a/results/452296/?format=api",
            "id": 452296,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d41f4063-f157-40cf-8a57-0907d20448fd/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ef61f7f1-0c8f-46e8-a55f-16be545d9f8a/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T053915Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7f9b86989759248c104f986e0037222d24b5bf0cf1286b44c37e9ca45d976d1a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ef61f7f1-0c8f-46e8-a55f-16be545d9f8a/results/452297/?format=api",
            "id": 452297,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4ed8f2ef-6279-4a75-9f51-cf40e541e45a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ef61f7f1-0c8f-46e8-a55f-16be545d9f8a/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T053915Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a833ee2585ae31af43196b95360edfc3904478844a305386414e91e64d4e3852"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ef61f7f1-0c8f-46e8-a55f-16be545d9f8a/results/452298/?format=api",
            "id": 452298,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/7b57a8aa-3f19-4522-a7e0-0d4cf3df1184/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ef61f7f1-0c8f-46e8-a55f-16be545d9f8a/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T053915Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2f8dc6e27f2f0bd992a8dd2498a235729b2fd417a6eddf9c7c0a2b75bc8830f5"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ef61f7f1-0c8f-46e8-a55f-16be545d9f8a/results/452299/?format=api",
            "id": 452299,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a0727ed3-b9a1-4c47-bc12-48af01b3bdad/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ef61f7f1-0c8f-46e8-a55f-16be545d9f8a/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T053915Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=03ea9dff962f98a26713974c55f5eeca1c1c334b0cfeda524db59821acb64e72"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ef61f7f1-0c8f-46e8-a55f-16be545d9f8a/results/452300/?format=api",
            "id": 452300,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/08641dc0-f3ed-4e0a-bc7f-757b2a15b2ce/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ef61f7f1-0c8f-46e8-a55f-16be545d9f8a/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T053915Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7790aeb1e9b963ddc2e38b5ee6039253e22161ea367b42cd939de17582af5baf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ef61f7f1-0c8f-46e8-a55f-16be545d9f8a/results/452301/?format=api",
            "id": 452301,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/6d712513-cef4-4c54-84c5-16364bd6a523/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ef61f7f1-0c8f-46e8-a55f-16be545d9f8a/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T053915Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=14ebc96924f3fcd82b23178c07592d2bcfc46fa8f3b87f12535aa7c6ad1d4183"
        }
    ]
}