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=20250315T054106Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d6c4da2f74e390669bdac3fee0c595e150b926ca20a08c4fc71fd2f3e10655bb"
        },
        {
            "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=20250315T054106Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2da22a21eb09eaff300ef08aa038901a23b114299cd5f8cfc489e4d00f99cb26"
        },
        {
            "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=20250315T054106Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e749c69a95dc252bc05b38a342a382a5d833640a56090811a9bb4a9762fdd7a3"
        },
        {
            "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=20250315T054106Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3b3c38678504dc3049c58bc83e2b1f39fe8927448aed2505e80cea04ad2b59bc"
        },
        {
            "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=20250315T054106Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=605964ddb582fefe4e6f27bbfa820624f373f7c97eb0788403cc46a02446c68d"
        },
        {
            "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=20250315T054106Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a8ebbb0e69880217738d6c3253bb06d6b126add4d7fad78fff902d0d2b78c8b7"
        },
        {
            "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=20250315T054106Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0c7eb52c391671b12a1c168405ac4c9533a8e08f866b90e5d9d358b4ccc09c1a"
        }
    ]
}