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/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/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/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/results/?format=api",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/results/449674/?format=api",
            "id": 449674,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/aaf0fd73-6545-469f-843d-e15c71bc152a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062217Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f9bb033b8ffc328a02af8e55e9a897ba1ea2d2779bfe97f2dd94140ed0f0d3cb"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/results/449716/?format=api",
            "id": 449716,
            "name": "Arrival time",
            "code": "depth-first-dtri",
            "description": null,
            "family": "Arrival",
            "raster": "https://demo.lizard.net/api/v4/rasters/036272e8-21c7-4f46-8a3b-7394ab41571e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/depth-first-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062217Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e8e9bf26080dd7a7e527c277976f9f67491c5918491e79db0d624a19c382f32d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/results/449725/?format=api",
            "id": 449725,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/449725/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/results/449726/?format=api",
            "id": 449726,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/8898d3e2-01fe-496e-8e39-e501f40eb8ee/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062217Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=364fe65298dc659fca62c5295630ac0fe6b20c00304fa6f5d2ef6f8ff649b622"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/results/449727/?format=api",
            "id": 449727,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/ddf2b0d3-4588-4dbb-b5b8-1a9e7fbbae12/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062217Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2d1f3d51dda17bfbe18486659da3cdbaa4873d4c4d2cabeff0f91fd42a95b038"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/results/449728/?format=api",
            "id": 449728,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/3c0ac654-c7a0-424a-8bf5-e03aff0d2a7d/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062217Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d9ece59cf65561000ddcbf6efe0db360bd8cd81537b15cc2b949efdd34ee9714"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/results/449729/?format=api",
            "id": 449729,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/77a96940-c3e0-4715-800b-a6686e90a4b2/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062217Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6196043ebac539e068d3a2cc5a003113f409b9aa15ce07d55446417931e134d7"
        }
    ]
}