Content Library Item DownloadSession get
Gets the download session with the specified identifier, including the most up-to-date status information for the session.
Returns an authorization error if you do not have all of the privileges described as follows:
- Operation execution requires
System.Anonymous.
Identifier of the download session to retrieve.
The parameter must be an identifier for the resource type: com.vmware.content.library.item.DownloadSession.
The Content Library Item DownloadSessionModel instance with the given downloadSessionId.
{
"id": "string",
"library_item_id": "string",
"library_item_content_version": "string",
"error_message": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"client_progress": 0,
"state": "string",
"expiration_time": "string"
}The identifier of this download session.
This property is not used for the create operation. It will not be present in the response of the get or list operations. It is not used for the update operation.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.content.library.item.DownloadSession. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.content.library.item.DownloadSession.
The identifier of the library item whose content is being downloaded.
This property must be provided for the create operation. It will always be present in the response of the get or list operations. It is not used for the update operation.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.content.library.Item. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.content.library.Item.
The content version of the library item whose content is being downloaded. This value is the Content Library ItemModel.content_version at the time when the session is created for the library item.
This property is not used for the create operation. It will always be present in the response of the get or list operations. It is not used for the update operation.
If the session is in the Content Library Item DownloadSessionModel State.ERROR status this property will have more details about the error.
This property is not used for the create operation. It is optional in the response of the get or list operations. It is not used for the update operation.
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 property is not used for the create operation. It will always be present in the response of the get or list operations. It is optional for the update operation.
The current state (State) of the download session.
For more information see: Content Library Item DownloadSessionModel State.
This property is not used for the create operation. It will always be present in the response of the get or list operations. It is not used for the update operation.
Indicates the time after which the session will expire. The session is guaranteed not to expire before this time.
This property is not used for the create operation. It will always be present in the response of the get or list operations. It is not used for the update operation.
if no download session with the given downloadSessionId exists.
"Vapi Std Errors NotFound Object" curl -H 'Authorization: <value>' https://{api_host}/api/content/library/item/download-session/{downloadSessionId}