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/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/results/?format=api&page=2

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

{
    "count": 17,
    "next": null,
    "previous": "https://demo.lizard.net/api/v4/scenarios/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/results/?format=api",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/results/455926/?format=api",
            "id": 455926,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/0a005907-00a5-4512-a736-425b39d32c50/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062945Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5d5f4a592f57bc614044fdb3b3c2f67fbd4758b54c8f0d71fdcd789b147abfd2"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/results/455927/?format=api",
            "id": 455927,
            "name": "Arrival time",
            "code": "depth-first-dtri",
            "description": null,
            "family": "Arrival",
            "raster": "https://demo.lizard.net/api/v4/rasters/76bd30e6-3a93-489a-b0e9-7fd69f8e78b8/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/depth-first-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062945Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0d177180eaa03d979efbf4a792e5df8d8a6928dde12adf7973dba0bf7d70dc34"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/results/455952/?format=api",
            "id": 455952,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/455952/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/results/455953/?format=api",
            "id": 455953,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/3ac0fff7-55a0-4492-a853-811baf6dfeb8/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062945Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4abd1056fb2957038b2b7d196574a14ccd1a029fca1b7d1782f987210c6e8fa8"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/results/455954/?format=api",
            "id": 455954,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/e7fc3ffd-6c56-47f2-9913-a42588b40300/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062945Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5d635b41263b603778f37790757ffa193697314bebd4362516ed93760646bf95"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/results/455955/?format=api",
            "id": 455955,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/12acfd23-9e23-4f4d-83b8-ff403d96711f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062945Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f8dd3d2e30c8c4434f7e63f11d55fb257faaca43df69237eb09849d393aa4cbb"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/results/455956/?format=api",
            "id": 455956,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/f1899c6f-e271-4c55-8e4a-daff24773a70/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062945Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=06cd8b64b304cb23c620db5076d7a6f066a7f08007d96d04725c507aa4584536"
        }
    ]
}