HighQ 5.4

Files - Collaborate 5.4 API changes list

OVERVIEW

1.  Contract Express Document Automation API 
 

API method to generate a document using Contract Express document automation engine. The method requires prerequisites configured for the document automation template. 
 

Status information added to the files API's

The following methods Get File Info API, Get File List API, Get Folder Info API, Get Folder List API have been updated in HighQ 5.4 to provide status information for the content. The details are only returned if the query parameter of "statusinfo" is set to true. A value of 1 indicates that the status is enabled and a value of 0 indicates that the specific status is not enabled.

Email metadata information added to the files API's

The following methods Get File Info API, Get File List API have been updated in HighQ 5.3 to provide email metadata information for the file.The "emailmetadata" parameter allows you to access additional information about the file. The details are only returned if the query parameter of "emailmetadata" is set to true. (Support from 5.3 branch API version 10)

2. Get File Info API:

This API method has been updated to provide the following details of the file for status information.

  • If the API client has
    • Liked the file
    • Added the file to favourites
    • Shared the file
  • No of tasks created for the file
     

This API method has been updated to provide the following details of the file for email metadata information.

  •     from
  •     to
  •     cc 
  •     sent
  •     received
     

3. Get File List API: 

This API method has been updated to provide the following details for each file in the file list for status information.

  • If the API client has
    • Liked the file
    • Added the file to favourites
    • Shared the file
  • No of tasks created for the file

This API method has been updated to provide the following details of the file for email metadata information.

  •     from
  •     to
  •     cc 
  •     sent
  •     received

 

4. Get Folder Info API: 

This API method has been updated to provide the following details for the folder

  • If the API client has
    • Added the folder to favourites
    • Shared the folder

5. Get Folder List API: 

This API method has been updated to provide the following details for each folder in the folder list

  • If the API client has
    • Added the folder to favourites
    • Shared the folder

6. List of shares API: 

API method to get the list of file and folders shared using the Secure file sharing. 

 

7. Download API : 

Previously this API can only generate the thumbnails for the image file types only but from 5.4 onwards API can generate the thumnails of different file types.
This API endpoint has been updated to provide with a existing parameter as below to get the thumbnail of the file.

  • thumbnail = true allows the user to obtain the thumbnail of the specified document.
  • imagewidth = should in range of '2048,1024,800,512,256,128,64'. If thumbnail is true then 'imagewidth' will be mandatory.

 

8. Changes API : 

The API has been updated to report on 28 new changes related to social features e.g "like" and comments. 

9. Delete file API
Delete file API we have change the message "Access denied" for 2 below cases for all API versions in collaborate 5.4
1. If file is in deleted items and user tries to delete file
then response code 403 and summary message as - "file is in recycle bin"
2. If file is permanently deleted and user tries to delete file
then response code 403 and summary message as - "file is permanently deleted"

 

Comments


6 Comments


For anyone interested, this is the correct progress REST call to make: ./api/11/progressivekeystatus/{progressive_key} . And it does return the ID of the file that was generated.


Mark Salamon Can you raise a ticket with support and we can look at this in detail, for you.. support@highq.com?


Peter Simpson I figured out most of this. The API version is indeed 11. And I managed to find the TemplateID by going into the page source for the admin page where you have configured the templates for a site and found the number. And the output of the REST call is that the document is generated and saved to the site.

The response was a progress key, but I was not able to make use of it. When I tried this call:

​/{version}​/progress​/{progresskey}

I received a 404 error. I wasn't sure which version of the API to use but I tried 1, 2 and 3, to no avail.

Assuming I can get that working, is there any way using the API to get the ID of the file (or files) that was generated?

 


Peter Simpson Thank you! 3 quick follow ups:

1 - In the swagger is says the API version is "11" but I think it should be "1"?

2 - Where do we get the ID of the CE template? Is that in the CE admin page somewhere or is it available in Collaborate?

3 - What is the output of this REST call? Is a document returned or does it save a document to the default location for that template configured in the site?

 


Mark Salamon 

-> If you have access to Swagger, under the heading 'Document Resource APIs' , the final endpoint is the one you are looking for '/{version}/files/docauto/{docautoengineid}/generatedocument/singlerecord/{templateid}'



yourinstance.com/showSwaggerUI.action#/Document Resource APIs/generateCEDocument



I believe that is the endpoint referenced at the top here...


The top of this page references "Contract Express Document Automation API" but I have not been able to find any more information on this site regarding the full CE REST API and which calls are available thru HighQ. Is that information available anywhere?

Last Updated: Jun 09,2023