Get Item Download Session
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
Gets the download session with the specified identifier, including the most up-to-date status information for the session. if you do not have all of the privileges described as follows: - Operation execution requires System.Anonymous.
Request
URLURL
https://{api_host}/rest/com/vmware/content/library/item/download-session/id:{download_session_id}
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Identifier of the download session to retrieve. The parameter must be an identifier for the resource type: com.vmware.content.library.item.DownloadSession. |
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Response
Response
Response BodyResponse Body
200 OK returns
LibraryItemDownloadSessionGetResponseBody
of type application/json
The DownloadSessionModel instance with the given downloadSessionId.
{
"value": {
"client_progress": 0,
"expiration_time": "string",
"id": "string",
"library_item_content_version": "string",
"library_item_id": "string",
"state": "enum"
}
}| Property Name | Type | Description |
|---|---|---|
| value | LibraryItemDownloadSessionModel |
The DownloadSessionModel instance with the given downloadSessionId. |
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/com/vmware/content/library/item/download-session/id:{download_session_id}
Errors
| Code | Returns | Description |
|---|---|---|
| 404 | ErrorRest | com.vmware.vapi.std.errors.not_found : if no download session with the given downloadSessionId exists. |
| default | ErrorRest | Not available |
