LibraryItemUpdateSessionModel
The UpdateSessionModel structure provides information on an active UpdateSession resource.
Properties
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 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.
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.
Indicates the time after which the session will expire. The session is guaranteed not to expire earlier than 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.
The identifier of this update 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.UpdateSession. 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.UpdateSession.
The content version of the library item whose content is being modified. 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.
The identifier of the library item to which content will be uploaded or removed. 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.
A preview of the files currently being uploaded in the session. This property will be set only when the session is in the ACTIVE. This field is optional and it is only relevant when the value of UpdateSessionModel.state is ACTIVE.
The state of an update session.
ACTIVE : The session is currently active. This is the initial state when the session is created. Files may be uploaded by the client or pulled by the Content Library Service at this stage.
DONE : The session is done and all its effects are now visible.
ERROR : There was an error during the session.
CANCELED : The session has been canceled.
Possible values are: ACTIVE , DONE , ERROR , CANCELED
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 field is optional for the create operation. It is optional in the result of the get or list operations. It is optional for the update operation.
JSON Example
{
"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",
"preview_info": {
"cert_chain": [
"string"
],
"certificate_info": {
"issuer": "string",
"self_signed": false,
"subject": "string",
"x509": "string"
},
"state": "UNAVAILABLE",
"warnings": [
{
"ignored": false,
"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"
}
}
},
"type": "SELF_SIGNED_CERTIFICATE"
}
]
},
"state": "ACTIVE",
"warning_behavior": [
{
"ignored": false,
"type": "SELF_SIGNED_CERTIFICATE"
}
]
}
Parameter To
Create Item Update Session
Update Item Update Session
Returned By
Get Item Update Session
