Overview 
OVERVIEW
API Access Mechanism using OAuth2
How are permissions determined for the API calls
OAuth for desktop Applications (Automating OAuth)
What to use for redirect_uri parameter
Adding a new API application registration
API changes in Collaborate 4.1.4
New API's in 4.3 - Site API changes in Collaborate 4.3 and 4.3.4
API changes in Collaborate 4.4
Share file API - Add file for quick share
Share file API - Share via link
Share file API - Share via microblog
Share file API - Share via private message
Share file API - Share via email
Share file API - Remove a share
Get isheet record id for a file
DMS management API endpoints - Documents to Sync
DMS management API endpoints - Document DMS sync status
DMS management API endpoints - Folder link
DMS management API endpoints - API calls to save back documents to DMS
File/folder group and user permissions
File/folder group and user permissions - Get folder group/user permissions
File/folder group and user permissions - Add/update group/user folder permissions
File/folder group and user permissions - Get file group/user permissions
File/folder group and user permissions - Add/update group/user file permissions
Get files/folders from recycle bin
Get file info - Get file info v1
Get file info - Get file info v2
Get files list - Get files list v1
Get files list - Get files list v2
Download File - Download file v1
Document bundling - Rounding file and folder names
Restore folder from recycle bin
Get folder info - Get folder Info v1
Get folder info - Get folder info v2
Delete folder from recycle bin
Get folder list - Get folder list v1
Get folder list - Get folder list v2
Get activity list - Get activity list v1
API to display the Activity filters
Get site list - Get site list v1
Get site list - Get site list v2
Get site templates - Get site templates v1
Associating multiple matter IDs to a site
Site users management - Add existing user to site
Site users management - Add user to site
Site users management - Models
Site users management - Get all site users
Site users management - Get email alert settings
Site users management - Set email alert settings
Site users management - Remove users from a site
Site users management - Send reset password email to users
Site users management - Send invitation email to users
Site users management - Send an email to users
Site users management - Suspend users
Site users management - Activate users
Site users management - Add / edit user module permission
Site users management - Get user module permission
Get user list - Get all users v1
Delete/ Archive User - Delete user v1
Site group management - Get all site groups
Site group management - Group models
Site group management - Get site group
Site group management - Add site group
Site group management - Add existing group to site
Site group management - Get group module permission
Site group management - Add / edit group module permission
Site group management - Add user to a group
Site group management - Delete user from a group
Site group management - Update site group
Site group management - Get users of a site group
Get group list - Get all groups v1
Update group - Update group v1
Get Instance details - Get Instance details v1
Get Usage and Quota for a site
System reporting API for site summary
Get externalID's of iSheet records
Get a list of iSheets created using a specific iSheet template
Get isheet record id for a file
iSheets API version 2 - Common objects
iSheets API version 2 - Get column types
iSheets API version 2 - iSheet module - API
iSheets API version 2 - iSheet admin - API
iSheets API version 2 - iSheet System Admin - API
Common objects - Task attachments
Common objects - Task reminders
Task status API - Add task status
Task status API - Edit task status
Task status API - Delete task status
Task status API - Get all task status
Task list API - Remove task list
Task list API - Get all task lists
Task list API - Edit task list
Task reminder API - Delete task reminder
Task CRUD operations API - Add task
Task CRUD operations API - Edit task
Task CRUD operations API - Delete task
Task CRUD operations API - Get task
Task CRUD operations API - Get all tasks
Task attachment API - Remove task attachment
Get isheet record id for a task
Group/user folder permissions object
Group/user file permissions object
Favourite Items - Add to favourites / Remove from favourites
Comments list object - Add / Edit comment
Remove attachment from content (un-link)
Add Organisation - Add Organisation v1
Managing changes API response for multiple sites
Register folder for Changes API based on sourceclient
Remove folder registration for Changes API based on sourceclient
Remove all folder registrations for Changes API based on sourceclient
Sandbox environments for integration
Steps to move from Sandbox to Production
Using content-length for accelerated Collaborate instances
Common objects - Event categories
Events category - GET event category list
Event CRUD API - Add event API
Move bulk users to another domain
User API - Bulk - Reset password
Add User profile image(Avatar)
Importing file along with its metadata
Storing information of a file imported from an external DMS system
External Object Storage Connector
Rapid Application Prototyping Framework
Inderjeet Kaur Please check the menu to the left of this page... Site resources is where you will find endpoints for pulling down data about Sites, User resource (immediately below) for users,etc ,etc ,etc.
Different endpoints have different path and query parameters, as you'd expect for a REST API.
If you have a problem with a particular endpoint, feel free to raise a support ticket.
You can append /showSwaggerUI.action? to the end of your instance's url to see Swagger documentation which you may find more intuitive.
instance.com/instace/showSwaggerUI.action?
I was using activity to test the connection.
I need to extract login data for all users and Site data (Site, Categories, Matter..........). Can you please share the end point for the same and if i need to pass any request parameters with it?
Thanks
Inderjeet Kaur Its not entirely clear to me what you question is exactly? What are you hoping to report on? Site Object will be the correct resource if you are wanting to report on properties of 'Sites' within a Collaborate instance. The link you have pasted is for 'Activity', which is a different resource from the perspective of our system...
Ultimately withour undestanding your use-case fully, Icant comment much further. Feel free to let me know.
Hi
I have successfully registered the API and have got access token and refresh token. How can I get the data for reporting ? Site Object seems to be the method which gives all the data but its not a get method.
Can you please help if url to access the data is correct?
Ex: https://instancename.highqsolutions.com/instancename/api/version/activities/activityfilter
Hi Nupur Gupta,
You should take a look at See Unity, with whom we partner. Their products act as a 'port' between various DMS solutions and HighQ. Most commonly it tends to be iManage, but SharePoint is listed amongst their supported products.
Tom Chick & Daniel Rahman from the HighQ Pro Services team are responsible for the setting up of the integration, so they could be good people to reach out to.
Endpoint-wise, we do have a 'DMS Management' segment, which may be of use. Otherwise Files and Folders will be what you want!
Comments
19 Comments