File resource

DMS management API endpoints - Folder link

OVERVIEW

This API method links a DMS folder to a Collaborate folder for syncing. Use this method to mark a folder as a linked folder in Collaborate. A linked folder in Collaborate displays the sync status of content placed in that folder. 

Method URL:

PUT /folders/{folderid} 

Where folderid is the ID of the Collaborate folder to link

Request XML:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<folder>
    <dms>
          <dmsfolderid></dmsfolderid> {numeric value expected}
          <dmsdatabasename></dmsdatabasename> {A string representing the databasename which can be used later}
          <dmsParentFolderID></dmsParentFolderID> {numeric value expected}
          <dmslink></dmslink> {possible values are true and false}
         <dmslinkby></dmslinkby> {Email of the user creating the link}
    </dms>
</folder>

A Link parameter can be used to link or unlink the folder

A Linkby parameter is used to specify the user who created the link

Parameters with a 'dms' prefix are the values related to the external DMS system

Response:

A 200 Ok response - if the method was successful otherwise, an error code is returned.

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. 

Comments


0 Comments

Last Updated: Jun 09,2023