DMS management API endpoints - Documents to Sync

An API method that provides a list of files and folders added to the synced folder in Collaborate and can be synced from Collaborate to Worksite. An API client can call this method at regular intervals to find out if there are any changes at the Collaborate end, and then based on that, can sync the changes back to DMS.

For this method to work you should schedule the unsynced document to sync by select the documents in the files module and using the menu option of "Save back to DMS". A limitation of this method is that it only returns the list of documents once and if called again does not return the list of documents to sync again. 

Request: 

Method URL:

GET   folders/${folderid}/dmsaddrequest/?metaData.siteID=${siteid} 

Where folderid is the ID of the linked folder and siteID is the ID of the site in which the linked folder exists. 

Response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<addrequest>
    <request id="28" type="document">
        <user>
            <firstname>Viraj</firstname>
            <lastname>Vekariya</lastname>
            <email>viraj.vekariya@highq.com</email>
        </user>
        <folder>
            <name>Viraj_API_Test_For_SeeUnity</name>
            <folderid>31623</folderid>
            <parentFolderID>31622</parentFolderID>
            <dmsfolderid>11286</dmsfolderid>
        </folder>
        <file>
            <name>WS_Error</name>
            <fileid>42538</fileid>
            <versionid>1</versionid>
            <parentfolderid>31623</parentfolderid>
        </file>
    </request>
</addrequest>

Please note that the changes related to each document are listed under the 'request' element and this includes the user responsible for adding the document to Collaborate and the folder hierarchy under which the document was uploaded. The parentfolderid element helps to understand the folder hierarchy so that the same folder hierarchy can be created in the external DMS.