Content Library Item UpdateSession get
Gets the update 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 update session to retrieve.
The parameter must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession.
The Content Library Item UpdateSessionModel instance with the given updateSessionId.
{
"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",
"preview_info": {
"state": "string",
"certificate_info": {
"issuer": "string",
"subject": "string",
"self_signed": false,
"x509": "string"
},
"warnings": [
{
"type": "string",
"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"
},
"ignored": false
}
],
"cert_chain": [
"string"
]
},
"warning_behavior": [
{
"type": "string",
"ignored": false
}
]
}The identifier of this update 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.UpdateSession. 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.UpdateSession.
The identifier of the library item to which content will be uploaded or removed.
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 modified. 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 UpdateSessionModel 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 upload. This property is to be updated by the client during the upload process to indicate the progress of its work in completing the upload. The initial progress is 0 until updated by the client. The maximum value is 100, which indicates that the update 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 not used for the update operation.
The current state (State) of the update session.
For more information see: Content Library Item UpdateSessionModel State.
This property was added in vSphere API 6.8.
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 earlier than 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.
A preview of the files currently being uploaded in the session. This property will be set only when the session is in the Content Library Item UpdateSessionModel State.ACTIVE.
This property was added in vSphere API 6.8.
This property is optional and it is only relevant when the value of state is Content Library Item UpdateSessionModel State.ACTIVE.
Indicates the update session behavior if warnings are raised in the session preview. Any warning which is raised by session preview but not ignored by the client will, by default, fail the update session.
This property was added in vSphere API 6.8.
This property is optional for the create operation. It is optional in the response of the get or list operations. It is optional for the update operation.
if no update session with the given identifier exists.
"Vapi Std Errors NotFound Object" curl -H 'Authorization: <value>' https://{api_host}/api/content/library/item/update-session/{updateSessionId}