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/58ecbef9-50c5-4b63-94b2-a765ad935f5a/results/?format=api&page=2

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

{
    "count": 16,
    "next": null,
    "previous": "https://demo.lizard.net/api/v4/scenarios/58ecbef9-50c5-4b63-94b2-a765ad935f5a/results/?format=api",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/58ecbef9-50c5-4b63-94b2-a765ad935f5a/results/452294/?format=api",
            "id": 452294,
            "name": "Max flow velocity",
            "code": "ucr-max-quad",
            "description": null,
            "family": "Basic",
            "raster": "https://demo.lizard.net/api/v4/rasters/0c21a43e-9703-442f-a80e-de32afec9150/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/58ecbef9-50c5-4b63-94b2-a765ad935f5a/ucr-max-quad-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062330Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e54ea49bd386cc95a06842b9a48b255570fe3fe8007dacda165ea2133e9c98ae"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/58ecbef9-50c5-4b63-94b2-a765ad935f5a/results/452340/?format=api",
            "id": 452340,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/452340/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/58ecbef9-50c5-4b63-94b2-a765ad935f5a/results/452341/?format=api",
            "id": 452341,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/f15ad3a7-caec-4c4f-85b6-91698e8f257e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/58ecbef9-50c5-4b63-94b2-a765ad935f5a/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062330Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2dc8e4c282d54320790a51247309823764f93a9efd4fa50ca564b4a9837870c7"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/58ecbef9-50c5-4b63-94b2-a765ad935f5a/results/452342/?format=api",
            "id": 452342,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/5cc83b0d-371b-4e12-b338-afac57127cfc/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/58ecbef9-50c5-4b63-94b2-a765ad935f5a/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062330Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=85244feee69dc63045694db139d01c953845ccc72d502996ab44240d919e265d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/58ecbef9-50c5-4b63-94b2-a765ad935f5a/results/452343/?format=api",
            "id": 452343,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/0c94c4c4-1241-4665-b9ed-29c3ea62e7af/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/58ecbef9-50c5-4b63-94b2-a765ad935f5a/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062330Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0239a35daa24d86657674652f20213c13e7fde137c70aebc3cda9df4e8a28dc1"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/58ecbef9-50c5-4b63-94b2-a765ad935f5a/results/452344/?format=api",
            "id": 452344,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/37d8eb44-4b80-44e8-8cd4-450878c38a0b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/58ecbef9-50c5-4b63-94b2-a765ad935f5a/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062330Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6b955fc2aaded664389c255297f1e114111e18082b8513ed94432d764d88a07d"
        }
    ]
}