DMS management API endpoints

The API endpoints detailed below allows the API client to view and update external DMS content, to and from Collaborate. Please note that there are specific configuration options which require enabling to use these methods, so if you come across any issues in using these methods then please create a support request for the support to enable these API features. 

Gate Keeper implementation workflow

• Use the 'Documents to Sync' API to discover if files and folders have been added under the linked folder in Collaborate
• When a document is downloaded from Collaborate and added to the external DMS system, a user can call the 'Update file' API to update the document's DMS location within Collaborate
• Call the 'Document DMS  sync status' to change the status of documents that have been uploaded to the external DMS. This switches the status icon in Collaborate from In Sync (blue) to Synced (green)
• The 'Folder link'  API method is used to link a Collaborate folder to the external DMS folder.

List of DMS related API's 
 

API calls to save back documents to DMS

Folder link

Documents to Sync

Document DMS sync status

Note: 

In addition to the above-mentioned API calls,  the following API endpoints are required to implement the DMS gatekeeper workflow:

• Get Folder Metadata
• Get File Metadata
• Download file

The details of these methods can be found in the files API documentation.