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/ab0784f7-ef67-41b4-b565-373bfa8db2a6/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/ab0784f7-ef67-41b4-b565-373bfa8db2a6/results/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/results/449487/?format=api",
            "id": 449487,
            "name": "Grid administration",
            "code": "grid-admin",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/449487/gridadmin.h5?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/results/449488/?format=api",
            "id": 449488,
            "name": "Raw 3Di output",
            "code": "results-3di",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/449488/results_3di.nc?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/results/449489/?format=api",
            "id": 449489,
            "name": "Calculation core logging",
            "code": "logfiles",
            "description": null,
            "family": "Raw",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/449489/log_files.zip?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/results/449490/?format=api",
            "id": 449490,
            "name": "Water depth (timeseries)",
            "code": "depth-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/8a1fe0a6-cb8e-4088-804f-a3c38fe50aef/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/depth-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T071943Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=acbcbb71a1c285a76219944a4992151489c3d77d1f105e14ec648b9e8a2988bf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/results/449491/?format=api",
            "id": 449491,
            "name": "Max water depth",
            "code": "depth-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/de7a615f-432a-4672-b14e-72a606415f99/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/depth-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T071943Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=08b3b737e52332b4adc1254ef73794fe7abf6646b98f2c2655b913a28955feab"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/results/449492/?format=api",
            "id": 449492,
            "name": "Flood hazard rating",
            "code": "flood-hazard-rating",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/12ffc2e8-a4f0-4e8b-8a37-7d36258e1eca/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/flood-hazard-rating-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T071943Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ff6a6de6ac0d76f1236ef40d669c4f1c76513ad77548d8e766ccd5c8939cc4bf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/results/449493/?format=api",
            "id": 449493,
            "name": "Rain",
            "code": "rain-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4c935b78-f71c-49bc-90e2-c98d04f6b093/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/rain-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T071943Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=772a78485f2a263c2572b7bbf37984b56adbef90b9321497ebdd66c0fa8ca950"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/results/449494/?format=api",
            "id": 449494,
            "name": "Rate of rise",
            "code": "rise-velocity-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/34cd9306-4f7a-41cf-9494-8d7e449a98d9/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/rise-velocity-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T071943Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a442e455c4718a5458b20ebc25e723b887f75815d709a2723b9038058f08453e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/results/449495/?format=api",
            "id": 449495,
            "name": "Water level (timeseries)",
            "code": "s1-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/9f127204-9d6a-498c-9e51-92cb20a173d2/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/s1-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T071943Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=30a0d4df9aaf0394962eed2f5b01f4dfce9dabe2897476aaebaf268b79bfa89f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/results/449496/?format=api",
            "id": 449496,
            "name": "Max water level",
            "code": "s1-max-dtri",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/652a0b84-c104-4d5a-816e-7ad22383eb45/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ab0784f7-ef67-41b4-b565-373bfa8db2a6/s1-max-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T071943Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b7d30d1940acaa2b205e92939d6509774c75941917a41f43671bea3670c48af7"
        }
    ]
}