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/5e5c3525-7575-4561-853a-604be8f57ae1/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/5e5c3525-7575-4561-853a-604be8f57ae1/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5e5c3525-7575-4561-853a-604be8f57ae1/results/453700/?format=api",
            "id": 453700,
            "name": "Grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/453700/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5e5c3525-7575-4561-853a-604be8f57ae1/results/453701/?format=api",
            "id": 453701,
            "name": "Raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/453701/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5e5c3525-7575-4561-853a-604be8f57ae1/results/453702/?format=api",
            "id": 453702,
            "name": "Calculation core logging",
            "code": "logfiles",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/453702/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5e5c3525-7575-4561-853a-604be8f57ae1/results/453703/?format=api",
            "id": 453703,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/ffc611bd-17c1-4649-a1f3-367a35619dc1/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5e5c3525-7575-4561-853a-604be8f57ae1/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T032728Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a1f75490aa26900cc6de82ebe019d76b22394ef199d8a508e969645f9ab662f4"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5e5c3525-7575-4561-853a-604be8f57ae1/results/453704/?format=api",
            "id": 453704,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/8225ccae-003e-4e0f-95e1-946701af1d99/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5e5c3525-7575-4561-853a-604be8f57ae1/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T032728Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1fbfd87c3056307f62a76c35d414d50dec3536da7a85301d36e8e2685b241f57"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5e5c3525-7575-4561-853a-604be8f57ae1/results/453705/?format=api",
            "id": 453705,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/b55d21da-e012-424b-b85c-b592d62625ee/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5e5c3525-7575-4561-853a-604be8f57ae1/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T032728Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7283ef035989b4e3aa0c1713c2491a79ef14912572808953b9e4869ac1cfc3c1"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5e5c3525-7575-4561-853a-604be8f57ae1/results/453706/?format=api",
            "id": 453706,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/05dbb955-da85-4427-90d9-c07385807015/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5e5c3525-7575-4561-853a-604be8f57ae1/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T032728Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=95deb45db0d92131119c20a0249544ce705b842baa5319eab85f50c30138c502"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5e5c3525-7575-4561-853a-604be8f57ae1/results/453707/?format=api",
            "id": 453707,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/1dab2263-88e6-4d19-9f52-6083e7c9b0ec/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5e5c3525-7575-4561-853a-604be8f57ae1/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T032728Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=716b77068f03d57225a16cde986f7b76cef9f3de0f7d4db4d3406386b7e60da8"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5e5c3525-7575-4561-853a-604be8f57ae1/results/453708/?format=api",
            "id": 453708,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/744268d8-44a7-4c66-b2f4-0db46ae5d1ac/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5e5c3525-7575-4561-853a-604be8f57ae1/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T032728Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f79ea1e3910a367dd02e0f11ba1515362491bc76057735631b22e841315c561f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5e5c3525-7575-4561-853a-604be8f57ae1/results/453709/?format=api",
            "id": 453709,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/812ce16c-11c3-4c0c-a31c-7b9a28bd9b3a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5e5c3525-7575-4561-853a-604be8f57ae1/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T032728Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e2b62068dd2e226c456cee49833ab61f8013a994be0acd5f2089757f98d695f3"
        }
    ]
}