REST API - update_session

content library item: update session model

The update_session_model structure provides information on an active content.library.item.update_session resource.

Representation:

JSON

{
    "client_progress": 1,
    "error_message": {
        "args": [
            "string",
            "string"
        ],
        "default_message": "string",
        "id": "string"
    },
    "expiration_time": "2015-01-01T22:13:05.651Z",
    "id": "obj-103",
    "library_item_content_version": "string",
    "library_item_id": "obj-103",
    "state": "ACTIVE"
}

Attributes:

Name	Type	Description
Optional
id	string	The identifier of this update session. Optional. 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`.
library_item_id	string	The identifier of the library item to which content will be uploaded or removed. Optional. 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`.
library_item_content_version	string	The content version of the library item whose content is being modified. This value is the content.library.item_model.content_version at the time when the session is created for the library item. Optional. 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.
error_message	localizable_message	If the session is in the ERROR status this property will have more details about the error. Optional. 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.
client_progress	long	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. Optional. 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.
state	string	The current state (`ACTIVE`, `DONE`, `ERROR`, `CANCELED`) of the update session. The state of an update session. Value is one of: 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.Optional. 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.
expiration_time	date_time	Indicates the time after which the session will expire. The session is guaranteed not to expire earlier than this time. Optional. 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.