This API has a deprecated equivalent from v7.0U1.
Get Item Download Session
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}/api/content/library/item/download-session/{download_session_id}
Path Parameters
Path Parameters
string
download_session_id
Required
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
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
LibraryItemDownloadSessionModel
of type application/json
The DownloadSessionModel instance with the given downloadSessionId.
{
"client_progress": 0,
"error_message": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"expiration_time": "string",
"id": "string",
"library_item_content_version": "string",
"library_item_id": "string",
"state": "ACTIVE"
}
integer
client_progress
Optional
The progress that has been made with the download. This property is to be updated by the client during the download process to indicate the progress of its work in completing the download. The initial progress is 0 until updated by the client. The maximum value is 100, which indicates that the download is complete. This field is not used for the create operation. It will always be present in the result of the get or list operations. It is optional for the update operation.
error_message
Optional
If the session is in the ERROR status this property will have more details about the error. This field is not used for the create operation. It is optional in the result of the get or list operations. It is not used for the update operation.
string
expiration_time
Optional
Indicates the time after which the session will expire. The session is guaranteed not to expire before this time. This field is not used for the create operation. It will always be present in the result of the get or list operations. It is not used for the update operation.
string
id
Optional
The identifier of this download session. This field is not used for the create operation. It will not be present in the result of the get or list operations. It is not used for the update operation. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.content.library.item.DownloadSession. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.content.library.item.DownloadSession.
string
library_item_content_version
Optional
The content version of the library item whose content is being downloaded. This value is the ItemModel.content-version at the time when the session is created for the library item. This field is not used for the create operation. It will always be present in the result of the get or list operations. It is not used for the update operation.
string
library_item_id
Optional
The identifier of the library item whose content is being downloaded. This field must be provided for the create operation. It will always be present in the result of the get or list operations. It is not used for the update operation. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.content.library.Item. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.content.library.Item.
state
Optional
The state of the download session.
ACTIVE : The session is active. Individual files may be in the process of being transferred and may become ready for download at different times.
CANCELED : The session has been canceled. On-going downloads may fail. The session will stay in this state until it is either deleted by the user or automatically cleaned up by the Content Library Service.
ERROR : Indicates there was an error during the session lifecycle.
Possible values are: ACTIVE , CANCELED , ERROR
Errors
404
com.vmware.vapi.std.errors.not_found : if no download session with the given downloadSessionId exists.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-GetDownloadSessionIdItem -DownloadSessionId "MyDownloadSessionId"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/content/library/item/download-session/{download_session_id}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/com/vmware/content/library/item/download-session/id:{download_session_id}
x-vmw-doc-operation: get
Availability
Added in 7.0U2
