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/c31ee575-0408-4261-8c67-82b50e11f118/results/?format=api

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

{
    "count": 12,
    "next": "https://demo.lizard.net/api/v4/scenarios/c31ee575-0408-4261-8c67-82b50e11f118/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c31ee575-0408-4261-8c67-82b50e11f118/results/296887/?format=api",
            "id": 296887,
            "name": "Grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/296887/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c31ee575-0408-4261-8c67-82b50e11f118/results/296888/?format=api",
            "id": 296888,
            "name": "Raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/296888/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c31ee575-0408-4261-8c67-82b50e11f118/results/296889/?format=api",
            "id": 296889,
            "name": "Calculation core logging",
            "code": "logfiles",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/296889/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c31ee575-0408-4261-8c67-82b50e11f118/results/296890/?format=api",
            "id": 296890,
            "name": "Aggregated 3Di output",
            "code": "aggregate-results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/296890/aggregate_results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c31ee575-0408-4261-8c67-82b50e11f118/results/296891/?format=api",
            "id": 296891,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/c00bb2a2-4fcc-4181-83af-99e7b56029b8/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c31ee575-0408-4261-8c67-82b50e11f118/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T213101Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1bc21236b72c564024475f7192eb54ae3e3903bd344dabad0f107255dafb9177"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c31ee575-0408-4261-8c67-82b50e11f118/results/296892/?format=api",
            "id": 296892,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/7b4b50be-8201-4936-9c40-413dee2b4136/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c31ee575-0408-4261-8c67-82b50e11f118/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T213101Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ca79ae42b9ad5ccbe4629251e11898d7bf077ce449bf5b45a5bdac2beba31c3f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c31ee575-0408-4261-8c67-82b50e11f118/results/296893/?format=api",
            "id": 296893,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/586324df-ad19-41af-b9a8-954dd0a119bd/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c31ee575-0408-4261-8c67-82b50e11f118/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T213101Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ac7059c9513197788e45869eb5d269c882d3f0a3154c9e3bc58b2e70eabb008c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c31ee575-0408-4261-8c67-82b50e11f118/results/296894/?format=api",
            "id": 296894,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/015960a6-b6b6-4ea6-bed5-fb6e3c5ffdfa/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c31ee575-0408-4261-8c67-82b50e11f118/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T213101Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4db8f9eb841b40d555faeeb059ae836ca6e9e4c3af9956263f7fc5d3238feba1"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c31ee575-0408-4261-8c67-82b50e11f118/results/296895/?format=api",
            "id": 296895,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/ab67fd7d-5ae8-4bc8-aee6-d8cc86ed1c68/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c31ee575-0408-4261-8c67-82b50e11f118/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T213101Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b082f8668dd401fc5b6244613dc6edbd135c3b484e4364eab7b5d3abe6a44874"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c31ee575-0408-4261-8c67-82b50e11f118/results/296896/?format=api",
            "id": 296896,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/a6f444c1-76be-413a-baa8-f7d02a18a94c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c31ee575-0408-4261-8c67-82b50e11f118/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T213101Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4e351fa99afa8c8fc3e007e6a3d9a9ce0f7701e4394aae49e774537f7e6f4f13"
        }
    ]
}