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/9aa6fe72-f10a-4d31-88b4-4129a877644e/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/9aa6fe72-f10a-4d31-88b4-4129a877644e/results/?format=api",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/results/447968/?format=api",
            "id": 447968,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/4ef92431-c8be-44d3-b2cb-8023f40ed000/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T012805Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=578b19f461ef4fdf66f194d8aa399e5debab3824033c854585675f98cbc0b5c1"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/results/447969/?format=api",
            "id": 447969,
            "name": "Arrival time",
            "code": "depth-first-dtri",
            "description": null,
            "family": "Arrival",
            "raster": "https://demo.lizard.net/api/v4/rasters/37cd8a84-3646-4e38-bc8c-326e62444d37/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/depth-first-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T012805Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6f8f0db729e904d4e9e1df2374b141e3ba4b672720be7f5f8e8109af5156da0c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/results/447998/?format=api",
            "id": 447998,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/447998/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/results/448019/?format=api",
            "id": 448019,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/12fdc202-a3ad-43cb-b707-e34c429604dd/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T012805Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=07f6beaa23f6fdea9b67bcc68f2212d59c725a092e3226c855b7700cf179e0c7"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/results/448020/?format=api",
            "id": 448020,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/9889056a-621a-4263-9452-7b51932e282f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T012805Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1cea8ee7311e62618cc438179afb115bdbd2ca7c311b686e98d6173c2d5ba864"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/results/448021/?format=api",
            "id": 448021,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/04952cf9-8a2e-40ea-94df-69a9b8ff6547/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T012805Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f3c84699b70cd4f940a3c0ccb7118e3a83d1d7f08b3640d8109ea68b0b8b5a71"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/results/448022/?format=api",
            "id": 448022,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/5f90d1eb-b450-4f1f-a91a-71bf6daf55f6/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T012805Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5e759346c0ec41c4e7fcd0ba2cfa5593b847d287a35dd37156fc7be668ffc3f8"
        }
    ]
}