Download workspace item content
Downloads one or more workspace items as defined by the paths specified in the request body. Paths can be to files or folders. If a single path is specified and it is to a file, that file is downloaded as a stream on the response. If it is a single path and it is to a folder or if multiple paths are provided, the items are downloaded to a ZIP file and returned as a stream on the response. For folders, all child items are downloaded to the ZIP file.
Optionally, an action status ID can be provided to monitor the completion status. To get the action status ID, first call batchUpdate with the action DOWNLOAD, which returns the action status ID on the request header.
The workspace download specification. One or more paths can be specified for download. An optional actionStatusId can be specified if performing a batch operation and tracking download status via the action status API.
The information to download items from the workspace.
| Name | Type | Required | Description |
|---|---|---|---|
version | number | false | The version of the representation. This is version 1. |
paths | array [string] | false | The paths of the files or folders to be downloaded. |
| Status | Meaning | Description | ||
|---|---|---|---|---|
| 200 | OK | OK |