HighQ 5.5

Files : API changes for 5.5 - Deduplication Add File API changes for duplicate files

OVERVIEW

Add File API changes:

Purpose : Allow user to add duplicate files with options for overrideduplicate parameter in Add file API

Endpoint: /{version}/files/content

Method: POST

Available from version: any

Type: Existing API

New Parameter need to add:

Query Parameters Data type Purpose Mandatory
overrideduplicate Boolean true - Need to add new version on all duplicates except locked files
false - Need to add new duplicate file		 NO

Note: Even though overrideduplicate=true then if all duplicate file is either 1.sent for signature or 2. file is checkout then it will add new duplicate file.

RESPONSES:

Area Response Response Code
overrideduplicate=true  
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <file>
    <documentsWithUpdatedVersion>
      <name>BIG SIZE</name>
      <fileid>9588</fileid>
      <size>600891</size>
    </documentsWithUpdatedVersion>
  </file>
 202
overrideduplicate=false/None 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <file>
    <fileid>9623</fileid>
  </file>
 201
overrideduplicate=true then if all duplicate files are either 1.sent for signature or 2. file is checkout then it will add it as a new duplicate file. 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <file>
    <fileid>9624</fileid>
  </file>
 201

 

Response codes
Code Message
201 Document uploaded successfully
202 File duplicates have been found
401 Unauthorised
403 Validation failed / Forbidden
405 Method not allowed (calling api with wrong method)
500 Internal error occurred while getting document content

 

Comments


0 Comments

Last Updated: Jun 09,2023