REST API - list

REST API - list

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.

list

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

Lists the identifiers of the update session created by the calling user. Optionally may filter by library item.
Request:
Representations:
{
    "library_item_id": "obj-103"
}
<?xml version="1.0" ?>
<ns0:List-Input xmlns:ns0="http://vmware.com/content/library/item/update_session" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <library_item_id>obj-103</library_item_id>
</ns0:List-Input>
GET /com/vmware/content/library/item/update-session
?library_item_id=obj-103

Parameters:
Name Type Required Description
library_item_id ID No Optional library item identifier on which to filter results. Id of type com.vmware.content.library.item.UpdateSession.

Response:
Representations:
{
    "value": [
        "obj-103",
        "obj-103"
    ]
}
<?xml version="1.0" ?>
<ns0:List-Result xmlns:ns0="http://vmware.com/content/library/item/update_session" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <value-array>
    <array-item>obj-103</array-item>
    <array-item>obj-103</array-item>
  </value-array>
</ns0:List-Result>

Parameters:
Name Type Required Description
result List<ID> Yes The array of identifiers of all update sessions created by the calling user. Id of type com.vmware.content.library.item.UpdateSession.

Errors:
Type Description HTTP Status Code
not_found if a library item identifier is given for an item which does not exist. 404

Copyright © 2014. All Rights Reserved.