1. Operations
  2. content
  3. library
  4. item
  5. update session

content library item update session: get

Gets the update session with the specified identifier, including the most up-to-date status information for the session.

Request:

HTTP request

GET https://{server}/rest/com/vmware/content/library/item/update-session/id:{update_session_id}

Path Parameters

Name Type Description
Required
update_session_id string Identifier of the update session to retrieve.

Response:

HTTP Status Code: 200

Representations:

{
    "value": {
        "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"
    }
}
<?xml version="1.0" ?>
<ns0:Get-Result xmlns:ns0="http://vmware.com/content/library/item/update_session" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <value>
    <id>obj-103</id>
    <library_item_id>obj-103</library_item_id>
    <client_progress>1</client_progress>
    <error_message>
      <default_message>string</default_message>
      <id>string</id>
      <args-array>
        <array-item>string</array-item>
        <array-item>string</array-item>
      </args-array>
    </error_message>
    <state>ACTIVE</state>
    <expiration_time>2015-01-01T22:13:05.651Z</expiration_time>
    <library_item_content_version>string</library_item_content_version>
  </value>
</ns0:Get-Result>

Response Type:

Name Type Description
bold = required
value update_session_model The content.library.item.update_session_model instance with the given update_session_id.
value.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.
value.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.
value.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.
value.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.
value.error_message.id string Unique identifier of the localizable string or message template.

This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
value.error_message.default_message string The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.
value.error_message.args string[] Arguments to be substituted into a message template.
value.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.
value.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.
value.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.

Errors:

HTTP Status Code Type Description
404 not_found if no update session with the given identifier exists.