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/9aa6fe72-f10a-4d31-88b4-4129a877644e/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/9aa6fe72-f10a-4d31-88b4-4129a877644e/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/results/447958/?format=api",
            "id": 447958,
            "name": "Grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/447958/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/results/447959/?format=api",
            "id": 447959,
            "name": "Raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/447959/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/results/447960/?format=api",
            "id": 447960,
            "name": "Calculation core logging",
            "code": "logfiles",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/447960/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/results/447961/?format=api",
            "id": 447961,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/8a8e8ce7-0f8a-429e-b052-6fc3886c6bb2/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T192517Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c55ec6f1fd97384fed82113104b3e758079a98aa863afed47d6c3264252c9074"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/results/447962/?format=api",
            "id": 447962,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/815ea297-af58-4ef5-b783-6204e4881159/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T192517Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1c2f9263277ab2cf57ad84e901b74ec7d89ce67957b2a4e3c33a645dcd798e4d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/results/447963/?format=api",
            "id": 447963,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/30c068b5-96c6-4299-bcf6-9955399865b3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T192517Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=44b1d11394dd8aeef4f05cd60d34dc69f837bd0c8d4570cfb360e49c8d1a5b0e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/results/447964/?format=api",
            "id": 447964,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/58a83d94-e50b-4ca4-b669-7293bcc6c1fb/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T192517Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6d34be0595cceedad8d7f8848f4aa3c3ac57cff5783d1c932b26c1316b93175a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/results/447965/?format=api",
            "id": 447965,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/18069119-6521-483c-a7e5-036468ebb263/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T192517Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=225485c3487dc57636d5f5aa8c5b9d7aad385030aef5f80fb31510805886b41d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/results/447966/?format=api",
            "id": 447966,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a6fe26cf-5450-4ce5-87fb-b76abc45d38a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T192517Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a4bef9f432de08348c64c8b9affa841f6e478fd7f3d98d87af38635a78520d70"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/results/447967/?format=api",
            "id": 447967,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/64483dee-df37-4361-8ea6-0c5dccfab820/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T192517Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9ce7a6867ea90a44290d3305d7a14c90f3ca9086d0332872c936e123c553f3c0"
        }
    ]
}