REST API - get

REST API - get

com.vmware.content.library.item.update_session

The update_session service manipulates sessions that are used to upload content into the Content Library Service, and/or to remove files from a library item.

An update session is a resource which tracks changes to content. An update session is created with a set of files that are intended to be uploaded to a specific com.vmware.content.library.item_model, or removed from an item. The session object can be used to track the uploads and inspect the changes that are being made to the item by that upload. It can also serve as a channel to check on the result of the upload, and status messages such as errors and warnings for the upload.

Modifications are not visible to other clients unless the session is completed and all necessary files have been received.

The management of the files within the session is done through the com.vmware.content.library.item.updatesession.file service.

get

GET /com/vmware/content/library/item/update-session/id:{update_session_id}
POST /com/vmware/content/library/item/update-session/id:{update_session_id}?~action=get
POST /com/vmware/content/library/item/update-session?~action=get

Gets the update session with the specified identifier, including the most up-to-date status information for the session.
Request:
Representations:
{
    "update_session_id": "obj-103"
}
<?xml version="1.0" ?>
<ns0:Get-Input xmlns:ns0="http://vmware.com/content/library/item/update_session" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <update_session_id>obj-103</update_session_id>
</ns0:Get-Input>
POST /com/vmware/content/library/item/update-session?~action=get
&update_session_id=obj-103

Parameters:
Name Type Required Description
update_session_id
 *
 ID Yes Identifier of the update session to retrieve. Id of type com.vmware.content.library.item.UpdateSession.

Response:
Representations:
{
    "value": {
        "client_progress": 10,
        "error_message": {
            "args": [
                "string",
                "string"
            ],
            "default_message": "string",
            "id": "string"
        },
        "expiration_time": "2013-06-06T22:13:05",
        "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>10</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>2013-06-06T22:13:05</expiration_time>
    <library_item_content_version>string</library_item_content_version>
  </value>
</ns0:Get-Result>

Parameters:
Name Type Required Description
result update_session_model Yes The com.vmware.content.library.item.update_session_model instance with the given update_session_id.

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

Copyright © 2014. All Rights Reserved.