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/cd618165-e012-48a4-a8a2-d7d2f035bebd/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/cd618165-e012-48a4-a8a2-d7d2f035bebd/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/cd618165-e012-48a4-a8a2-d7d2f035bebd/results/449656/?format=api",
            "id": 449656,
            "name": "Grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/449656/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/cd618165-e012-48a4-a8a2-d7d2f035bebd/results/449657/?format=api",
            "id": 449657,
            "name": "Raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/449657/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/cd618165-e012-48a4-a8a2-d7d2f035bebd/results/449658/?format=api",
            "id": 449658,
            "name": "Calculation core logging",
            "code": "logfiles",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/449658/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/cd618165-e012-48a4-a8a2-d7d2f035bebd/results/449735/?format=api",
            "id": 449735,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/78ccd790-0bb8-4b4f-ba76-1616dec85454/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/cd618165-e012-48a4-a8a2-d7d2f035bebd/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T043249Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=aff58b413552749756c16f42a33836bef3149437b198b403d1e84f6531ad5aa4"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/cd618165-e012-48a4-a8a2-d7d2f035bebd/results/449736/?format=api",
            "id": 449736,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/46a71306-7d0d-4925-84a1-897c5e1ad5ad/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/cd618165-e012-48a4-a8a2-d7d2f035bebd/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T043249Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=82376f809b595b0b8a6435d547e63c42b775071ae92e577a513e85259410931f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/cd618165-e012-48a4-a8a2-d7d2f035bebd/results/449737/?format=api",
            "id": 449737,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/ddce78f4-a30e-40da-8394-0d5050c904fd/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/cd618165-e012-48a4-a8a2-d7d2f035bebd/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T043249Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3588aee82713f0c636dc446cbd8cdc3e21fdd95ccfcf1238be949e6febc7c940"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/cd618165-e012-48a4-a8a2-d7d2f035bebd/results/449738/?format=api",
            "id": 449738,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/2c215a27-5872-47fd-af1b-d3b061457818/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/cd618165-e012-48a4-a8a2-d7d2f035bebd/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T043249Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=fe4c729d42531028155bdef7596bb97866768bb72606402c2161c8650045cb41"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/cd618165-e012-48a4-a8a2-d7d2f035bebd/results/449739/?format=api",
            "id": 449739,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4c04c2b7-614d-4fa0-b3b3-059d8b9ac0f7/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/cd618165-e012-48a4-a8a2-d7d2f035bebd/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T043249Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ec9a1e16d0fa1bc84b629774906771bfae7927366cee9c983d594494787d7dd8"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/cd618165-e012-48a4-a8a2-d7d2f035bebd/results/449740/?format=api",
            "id": 449740,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4c823ab5-f004-4e15-af0e-373004b1f878/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/cd618165-e012-48a4-a8a2-d7d2f035bebd/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T043249Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=72da524aa3f0db9411a307b6f2d4f078905ac6fa5824cee2e467e574347b20ae"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/cd618165-e012-48a4-a8a2-d7d2f035bebd/results/449741/?format=api",
            "id": 449741,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/d61a2e27-114d-4964-95cb-34f24b1ee2c0/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/cd618165-e012-48a4-a8a2-d7d2f035bebd/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T043249Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=56c85a8812fcd23a33ed9936274869ffdb1c2e1ce102e75aa9df28987c3041a2"
        }
    ]
}