HighQ 5.5

Files : API changes for 5.5 - Deduplication API Get File Duplicates

OVERVIEW

REST API params
Parameter Value
HTTP Method GET
Resource(API) EndPoint 
/files/duplicates/{filenamewithextension}
Consumes  
Produces MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML
SecurityLevel FOLDER_ACCESS{verifyDocumentModuleIsEnable=true}
AuditTypeAlias GET_FILE_DUPLICATES
ApiVersion ApiVersionConstant.API_VERSION_V12, ApiVersionConstant.API_CURRENT_VERSION
Notes API method to find a files duplicates in Collaborate. The method supports download by a specific document version.
Method Parameters
Name Name of the path/query parameter Type Param Type Inner type value  defaultValue Required
version version String ApiParam PathParam version of api ApiVersionConstant.API_VERSION_V1 true
fileNameWithExtensionStr filenamewithextension String ApiParam PathParam filename with extension   true 
folderID
 parentfolderid String ApiParam QueryParam 
Parent folder ID
 -1 true

Response

Response XML Response JSON 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <file>
    <name>BIG SIZE.jpg</name>
    <folderID>3083</folderID>
    <siteid>2016</siteid>
    <documentduplicatelist>
      <name>BIG SIZE</name>
      <fileid>9575</fileid>
      <size>600891</size>
    </documentduplicatelist>
    <documentduplicatelist>
      <name>BIG SIZE</name>
      <fileid>9576</fileid>
      <size>600891</size>
    </documentduplicatelist>
    <documentduplicatelist>
      <name>BIG SIZE</name>
      <fileid>9588</fileid>
      <size>600891</size>
    </documentduplicatelist>
  </file>
 
{
  "name": "BIG SIZE.jpg",
  "folderID": "3083",
  "siteid": 2016,
  "documentduplicatelist": [
    {
      "name": "BIG SIZE",
      "fileid": "9575",
      "size": 600891
    },
    {
      "name": "BIG SIZE",
      "fileid": "9576",
      "size": 600891
    },
    {
      "name": "BIG SIZE",
      "fileid": "9588",
      "size": 600891
    }
  ]
}

 

 

Response codes
Code Message Other
200 File duplicates have been found  
204 No duplicates were found  
400 Problem with parsing XML or JSON object (Bad Request)  
401 Unauthorised  
403 Validation failed / forbidden  
404 Document doesn't exist in the system  
405 Method not allowed (calling api with wrong method)  
500 Internal error occurred while getting document content response = ErrorDBO.class

 

Comments


0 Comments

Last Updated: Jun 09,2023