File resource

DMS management API endpoints - Document DMS sync status

OVERVIEW

An API method which helps to bulk update Collaborate document's sync status when uploading the content to external DMS system. This method helps to toggle the Collaborate document status from inSync to synced or error, depending on the success or failure of the operation. This status change will change the icon colour from InSync (blue) to Synced (green) or Error (red), depending on the final status. 

Request: 

Method URL:

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

Request XML:

                <?XML version="1.0" encoding="UTF-8" standalone="yes"?>

                 <addrequest>

                        <request id="4">

                                <file>

                                      <fileid>1</fileid>

                                      <versionid>1</versionid>

                                     <status>ERROR</status>

                                     <error>Not able to connect worksite</error>

                             </file>

                            <file>

                                      <fileid>6</fileid>

                                      <versionid>1</versionid>

                                     <status>SUCCESS</status>

                                     <error/>

                            </file>

                            <file>

                                      <fileid>7</fileid>

                                      <versionid>2</versionid>

                                     <status>IGNORED</status>

                                     <error/>

                            </file>

                            <file>

                                     <fileid>8</fileid>

                                     <versionid>1</versionid>

                                     <status>OUT_DATED_VERSION</status><!-- OUT_DATED_VERSION status support from 'worksite phase - 3' -->

                                     <error/>

                           </file>

                </request>

               </addrequest>

Response:

Collaborate provides the following response codes 

200    updated successfully

403    Validation failed/ Forbidden

405    Method not allowed (calling API with the wrong method)

500    Internal error occurred

Comments


0 Comments

Last Updated: Jun 09,2023