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/821e4a54-b30d-43b3-bca2-7b68807e9ebb/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/821e4a54-b30d-43b3-bca2-7b68807e9ebb/results/?format=api",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/821e4a54-b30d-43b3-bca2-7b68807e9ebb/results/449754/?format=api",
            "id": 449754,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/039a24b1-75a0-41de-8add-eb4f75817dbe/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/821e4a54-b30d-43b3-bca2-7b68807e9ebb/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062222Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=52932cb972fccee2290183c050067d50f5488b5684ab022da939ba75a70ff617"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/821e4a54-b30d-43b3-bca2-7b68807e9ebb/results/449793/?format=api",
            "id": 449793,
            "name": "Arrival time",
            "code": "depth-first-dtri",
            "description": null,
            "family": "Arrival",
            "raster": "https://demo.lizard.net/api/v4/rasters/32d1ce59-07c0-4c43-b88e-c7bfb79018e0/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/821e4a54-b30d-43b3-bca2-7b68807e9ebb/depth-first-dtri-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062222Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=67e1968b3176ccfb509a42889a8f38ee409fc65da46f5061a0de377f1fcfda5f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/821e4a54-b30d-43b3-bca2-7b68807e9ebb/results/449795/?format=api",
            "id": 449795,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/449795/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/821e4a54-b30d-43b3-bca2-7b68807e9ebb/results/449798/?format=api",
            "id": 449798,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/d04ed0a1-7db3-4b02-92ef-9e24ca830073/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/821e4a54-b30d-43b3-bca2-7b68807e9ebb/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062222Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b6b8ca55efa75d9331ef7a2027aa34f7edcea257dd0cbe2e91f50b2d32f1a120"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/821e4a54-b30d-43b3-bca2-7b68807e9ebb/results/449799/?format=api",
            "id": 449799,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/b58e2483-975b-4e89-b3fe-bbc08cbb66b3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/821e4a54-b30d-43b3-bca2-7b68807e9ebb/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062222Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1b2a9b80daa0fb4b528e27db15daa2ef1b47d3359b52ab0f8f6c089774a4e4d2"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/821e4a54-b30d-43b3-bca2-7b68807e9ebb/results/449800/?format=api",
            "id": 449800,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/3bcca9a4-8304-4695-a8a5-8abb58b2726c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/821e4a54-b30d-43b3-bca2-7b68807e9ebb/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062222Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=fa3a8f1cbb25cbbe906dc50479dc3acb07f815c8fa70949e472c542bb12b933a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/821e4a54-b30d-43b3-bca2-7b68807e9ebb/results/449801/?format=api",
            "id": 449801,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/5ceca0b6-e008-4790-a2f9-688f8ba76a5e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/821e4a54-b30d-43b3-bca2-7b68807e9ebb/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062222Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4c89e93ba055f0a08e556ecb9f7d0e7ab7027648a138f0184fee0ee29d3b3300"
        }
    ]
}