Related
Recommended
Imran Aziz

 

Please note that we have decided to beta release Collaborate 4.3 for API testing on the 8th of December 2017. The beta sandbox instance https://integrationbeta.highq.com will be upgraded on 8th December and the documentation for the new API endpoints will be made available in the developer community. 

HighQ is introducing multiple API changes in Collaborate 4.3 called API version 3.

We will continue to support and maintain API methods supported in API version 1 and 2.  

The key changes in Collaborate API version 3 are as under

  • Site user and group permissions API

  • Comprehensive ISheets API which replaces the existing API endpoints

  • Tasks API

Site user and group permissions API

This API endpoint will allow you to do the following key operations in both group-based and user-based permissions model. The API endpoints will cover CRUD operations for each of the below

  • Add new users to the site

  • Add existing system users to the site

  • Add new groups to the site

  • Add existing system groups to the site

  • Manage file/folder permissions

  • Manage permissions to the site modules

ISheets API

The existing legacy API endpoints will we replaced with a comprehensive iSheets API. The new API will cover CRUD operations for the following areas

  • Admin Functions

    • ISheet Operations

    • iSheet Sections

    • Column Operations

    • iSheet Views

    • iSheet Permissions

    • iSheet Templates (Using iSheet template in a site)

    • iSheet Document Automation

    • Sorting iSheet, Views and Columns

  • iSheet Module

    • Get ISheet items

    • CRUD iSheet Item

    • Download attachments

    • Generate DD / CC report

Tasks API

This API endpoint will provide methods for the tasks module. The following functions will be supported

  • List of tasks

  • Capability to add, update and delete tasks

  • Get the task lists

  • Manage task lists

  • Task status management


We plan to upgrade our beta integration instance https://integrationbeta.highq.com to Collaborate 4.3 towards the end of November in order for our integration partners to try out the new endpoints and provide us feedback. 

Please note that there are some smaller updates to the API which we have not listed in this post. We plan to provide a detailed documentation along with Postman scripts for these new API endpoints. 

Thank you 

The product team. 
 

  •

    Raef Gameil Collaborate 4.3 is scheduled to release towards the end of January. The new iSheets API's are going to be released with Collaborate 4.3. Our plan is to update our beta sandbox instance to Collaborate 4.3 towards the end of this month to allow our partners to try out the new API's before the release. Please raise a support ticket with our team (support.highq.com) to add you to our Integration beta instance https://integrationbeta.highq.com if you do not have access to the sandbox instance.

     

  •

    Hi Imran ,

    When downloading  iSheet  with  XML feeds  it requires a valid user session so it can obtain the file successfully,  we heard that in the new XML API 4.3 release  these problems will be addressed .

    Has the Collaborate 4.3 been released with API end points to obtain records ?  and if not and we have to get records using the XML  feeds,  is there a way to create a user session silently to download the XML file ?

  •

    Carl Murphy the API is following the Collaborate rules according to which the user can only access the Site content after accepting the T & C. Unfortunately, we do not have an API through which the API client can accept or bypass such security setting, we plan to provide an API endpoint to address this requirement. Currently, this API endpoint is scheduled for Collaborate 4.4 so I do not have an immediate solution for your requirement.

  •

    Hi Imran we have noticed here at Dentons that when you try to use the Files API to upload to HighQ it does not work if there are Terms and Conditions enabled. Please could you let us know if there is a way to either get around this using the API or have something put in for future reference.

    As a work around we have had to disable the T&C screen for sites that are being synchronised from Worksite.

    Thanks

  •

    Imran Aziz fantastic news! - thank you