REST API - sync

REST API - sync

com.vmware.content.subscribed_library

sync

POST /com/vmware/content/subscribed-library/id:{library_id}?~action=sync
POST /com/vmware/content/subscribed-library?~action=sync

Forces the synchronization of the subscribed library.

Synchronizing a subscribed library forcefully with this operation will perform the same synchronization behavior as would run periodically for the library. The com.vmware.content.library.subscription_info.on_demand setting is respected. Calling this operation on a library that is already in the process of synchronizing will have no effect.

Request:
Representations:
{
    "library_id": "obj-103"
}
<?xml version="1.0" ?>
<ns0:Sync-Input xmlns:ns0="http://vmware.com/content/subscribed_library" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <library_id>obj-103</library_id>
</ns0:Sync-Input>
POST /com/vmware/content/subscribed-library?~action=sync
&library_id=obj-103

Parameters:
Name Type Required Description
library_id
 *
 ID Yes Identifier of the subscribed library to synchronize. Id of type com.vmware.content.Library.

Response:
Representations:

Parameters:
Name Type Required Description
result VOID Yes

Errors:
Type Description HTTP Status Code
not_found if the library specified by library_id does not exist. 404
invalid_element_type if the library specified by library_id is not a subscribed library. 400
invalid_argument if some parameter in the subscribed library subscription info is invalid. 400
resource_inaccessible if the published library cannot be contacted or found. 400

Copyright © 2014. All Rights Reserved.