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.
