Result Instance – 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/eb57a6c8-4c02-4ae3-b64c-247200f63d7c/results/263182/?format=api

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

{
    "url": "https://demo.lizard.net/api/v4/scenarios/eb57a6c8-4c02-4ae3-b64c-247200f63d7c/results/263182/?format=api",
    "id": 263182,
    "name": "aggregated 3Di output",
    "code": "aggregate-results-3di",
    "description": null,
    "family": "Raw",
    "raster": null,
    "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/263182/aggregate_results_3di.nc?format=api",
    "upload_url": null
}