HighQ (Preview)

This connector enables secure and authenticated access to HighQ APIs, allowing seamless integration of collaboration and content management capabilities into custom workflows and applications. It supports document automation, data synchronization, and workflow orchestration—empowering legal and professional services teams to streamline operations, reduce manual effort, and enhance productivity.

This connector is available in the following products and regions:

Service	Class	Regions
Copilot Studio	Premium	All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)
Logic Apps	Standard	All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD)
Power Apps	Premium	All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)
Power Automate	Premium	All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)

Contact
Name	Highq
URL	https://www.thomsonreuters.com/en-gb/help/highq/feature-updates/support/technical-support
Email	highq-support@thomsonreuters.com

Connector Metadata
Publisher	Thomson Reuters Incorporated
Website	https://legal.thomsonreuters.com/en/products/highq
Privacy policy	https://www.thomsonreuters.com/en/privacy-statement
Categories	Collaboration;Content and Files

HighQ

Overview

HighQ provides seamless, secure, authenticated access to HighQ APIs. This connector enables seamless interaction with various HighQ services, including the ISheet Module, Document Resource APIs, ISheet Admin API, and User operations. It is designed to facilitate integration with the HighQ Collaborate platform, offering functionalities such as retrieving and creating iSheet items, managing document files, and administering user accounts.

Connector Version: 1.0.0
Title: HighQ
Description: This connector offers seamless, secure and authenticated access to HighQ APIs.
Contact:
- Name: Highq
- Website: HighQ Support
- Email: highq-support@thomsonreuters.com

Authentication

The connector leverages dynamic environment variables for secure connectivity:

Host: @environmentVariables("highqt_host")
Base Path: /@environmentVariables("highqt_instancename")/api
Client ID: @environmentVariables("highqt_clientid")
Client Secret: @environmentVariables("highqt_clientsecret")

For detailed authentication procedures, please refer to the HighQ Technical Support portal or contact HighQ support.

Connector Operations

ISheet Module

Retrieve iSheet Items
GET /{version}/isheet/{isheetid}/items
Retrieves a list of items within the specified iSheet.
Create iSheet Items
POST /{version}/isheet/{isheetid}/items
Inserts new items into an iSheet, with support for multiple iSheets and status tracking via progressive keys.

Document Resource APIs

Retrieve File Information
GET /{version}/files/{fileid}
Retrieves detailed information about a specific file on the HighQ Collaborate platform.
Upload a File
POST /{version}/files/content
Uploads a file to a specified folder, supporting chunked uploads when the Content-Range header is provided.
Retrieve Folder List
GET /{version}/folders/{folderid}/items
Retrieves a list of folders within the specified folder with support for sorting and pagination.

ISheet Admin API

Retrieve iSheet Columns
GET /{version}/isheets/admin/{isheetid}/columns
Retrieves column configurations for a given iSheet.

User Operations

Retrieve Users
GET /{version}/users
Retrieves a list of users with support for filtering, pagination, and detailed user roles.
Add a New User
POST /{version}/users
Creates a new user account with extended attributes and validation.
Archive a User
DELETE /{version}/users/{userid}
Archives an existing user from the system.

Document and Site Management

Create a Folder
POST /{version}/folders
Creates a new folder under a specified parent folder.
Move Documents
PUT /{version}/files/move
Moves one or multiple files from one folder to another within the same site.
Site Management Operations:
- Add Existing Group to Site: POST /{version}/sites/{siteid}/groups/{groupid}
- Update Site Group: PUT /{version}/sites/{siteid}/groups/{groupid}
- Add a New Site: POST /{version}/sites

Getting Started

Configuration:
- Define the environment variables highqt_host and highqt_instancename in your Power Platform environment.
Authentication:
- Follow the guidelines provided by HighQ to configure secure authentication for API requests.
Usage:
- Import the HighQ into your Power Platform instance.
- Utilize the available operations as needed. Refer to the operation summaries provided above for guidance.

Parameters and Settings

Path Parameters:
Include required parameters such as version, isheetid, fileid, folderid, and userid as applicable.
Query Parameters:
Optional parameters like sheetviewid, sortcolumnid, limit, and offset are available to refine API responses.
Body Parameters:
For operations that require a request body (e.g., creating iSheet items or users), ensure the request adheres to the defined schemas (such as isheetDBO, FolderDBO, or IntegrationUserDBO).

Troubleshooting and Limitations

Error Codes:
Standard HTTP status codes are used across operations:
- 200 for successful operations
- 401 for unauthorized access
- 403 for forbidden or validation failures
- 405 for invalid HTTP methods
- 500 for internal server errors
  Please refer to individual API documentation for detailed error descriptions.
Limitations:
Some endpoints may have default limits (e.g., a default limit of 100 records). Additional parameters may be required for sorting and filtering large datasets.

Additional Resources

For more detailed information and extended documentation, please consult:

HighQ Technical Support
Internal documentation accompanying the HighQ connector package.

Licensing and Support

For licensing details and technical support:

Contact: Highq
Support URL: HighQ Technical Support
Support Email: highq-support@thomsonreuters.com

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Add existing group to site

This API method adds an existing system group to the site.
This API has been extended to add existing system basic user groups (of system / org type) in the site.

Add site

Use this API to create a new site. The site object only supports attributes which are visible in the create site interface.

This API requires site name (and mandatory fields configured at ASP level if any) to create a new site.

"module" tag represents different module to configure in site as it is shown in request attributes.
To create site from template by passing "sitetemplateid" tag
- For less than version 7, If any module is not given ("module" tag is not passed) in the request, the template module configuration will take place. If module tag is provided with configuration, it will respect that and configure as given in the request (rather than utilizing template module configuration)
- For greater than version 7, If any module is given ("module" tag is passed) or not in the request, the template module configuration will take place.

This method does not support uploading site image in this call, the site icon support will be provided as a separate call.
The method call expects an existing category ID. The category ID should be obtained by the calling application by an earlier call to the Site categories interface. If no categories are given in the request, none category (not actual any category) will be added by default.

Site start and end date should be in the format of 'dd MMM yyyy' and it is NOT UTC. API client will always request actual date.

"landingpage" has default value as "files (root folder)".
"landingpage" expect three different wordings or identifications for File module. Possible values are:
- files (root folder)
- files (recent activity)
- files (advanced search)
The method implementation now supports (from 5.1 onward) Multilingual sitename. API version 6 or higher <sitename> will represent in request body based on user preference order. API version 5 or older <sitename> will represent default UK English.
<sitenametranslations> will represent sitenames in every languages (Which will be additional tag in "Object itself API" from 5.1 onward) API version 6 or higher, in request body, They are sending both tags i.e. <sitename> and <sitenametranslations> then we need to validate values e.g. <sitename> must match with respective <translation> tag in terms of User's language preference. API 7 or higher, site created from template will follow modules from source template and it will ignore module list sent in request body.

The method implementation now supports create site from template by providing "sitetemplateid" tag (old approach)

Please note support for creating site from template using this API will be deprecated in future. To create site from template please use new API Create site from template (/sites/templates/{templateid}/site) which is a long polling API (having support for long running requests)

This method supports multiple matter numbers to add into site using API version 10 onward. "matternos" tag indicates multiple matter numbers with readonly or not. Older version (less than version 10) single matter number "matterno" will reflect the first matter number of existed multiple matter numbers in site.

Version 18 onwards: a categories (site purpose) is required. If the site purpose is hidden, a message is displayed; otherwise, hidden site purposes are not added to the site.

Up to version 17: the site owner is the logged-in user; no other users can be added.

Version 18 onwards: the site owner can add other users to the site.

From API version 19 onwards, A new module is introduced called 'customPages' which is tightly coupled with home module. So, if home module value is True, customPages will be true and vice versa.

Add User

This API call is used to add a new user to the system.
Note:
1. Added support for the following new fields
emaildomain, org, invitationsent, createdby, createddate, modifiedby, modifieddate, ifpartner, lastlogindate, invalidlogins, externalid, publicwebsiteprofileid, systemuser, resetpassworddate, usertypeid, avatar, practicegroup, langcode, publicprofile, dateOfBirth
2. Address tag has been added in API version 4
<address>
<addressid>1</addressid>
</address>

Summary	Ref Code (before V4)	Ref Code (V4)
Email address is required	101	101
Invalid email address	104	104
First name is required	102	102
Maximum allowed characters for the first name must be between 1 to 100	102	352
The secretary's/assistant's email address is not valid	104	353
Status must be active or inactive	116	116
The entered department cannot be more than 256 characters	N/A	354
The entered ifpartner attribute is invalid	N/A	355
The entered systemuser attribute is invalid	N/A	356
The entered usertypeid attribute is invalid	N/A	357
The entered langcode attribute is invalid	N/A	358
The entered sourcetype attribute is invalid.Valid values are System, Active directory or System default .	N/A	359
Please enter valid phone number	N/A	360
Please enter valid phone number in format {countrycode} ${areacode}${number}.	N/A	361
Please enter valid mobile number in format {countrycode}${number}.	N/A	362
Enter a valid office phone country code	N/A	363
The office phone country code can have a maximum of 4 digits	N/A	364
Enter a valid office phone area code	N/A	365
The office phone area code can have a maximum of 5 Digits	N/A	366
Office phone number should have maximum of 15 digits	N/A	368
Enter a valid mobile phone country code	N/A	369
The mobile phone country code can have a maximum of 4 Digits	N/A	372
Please enter a valid mobile number	N/A	373
Mobile phone number should have maximum of 20 digits	N/A	374
Domain does not exist	105	105
Email already exists in the system	111	111
Mention organisation in case of self registered domain	187	187
Mention organisation in case of exceptional domain	115	115
Org id is not in the proper format	112	112
Organisation does not exist	106	106
Domain exist in other organisation	114	114
Entered Address Id is not valid	N/A	308
Social link name not found in system.	N/A	375
The social link name is required	N/A	376
The social link value is required	N/A	377
Maximum characters for social link value must be between 1 to 500	N/A	378
Enter the name for the custom link	N/A	379
The custom link value required	N/A	380
Max characters for custom link name must be between 1 to 500	N/A	381
Max characters for custom link value must be between 1 to 500	N/A	382
The message link name required	N/A	383
Message link name not found in system	N/A	384
The message link value required	N/A	385
Max characters for message link value must be between 1 to 500	N/A	386
The social link is disabled	N/A	408
The message link is disabled	N/A	409
The custom link is disabled	N/A	410

JIRA Ticket : https://dev.highq.com/jira/browse/COL-65685

Archive User

This API call is used to archive a user within the system.

Error Codes

Summary	Ref Code (before V4)	Ref Code (V4)
The following users do not exist within the system	110	110
A User ID is required	109	109
User ID is not in the proper format	113	113
The User's ID length cannot exceeds 50 characters	N/A	304

JIRA Ticket : https://dev.highq.com/jira/browse/COL-67441

Create Folder

This API creates a new folder within the specified site. It allows you to provide folder details and ensures the folder is created under the given parent folder.

Get folder info

The method provides folder detail of given folder id.

Move Documents

This API moves multiple files from one folder to another within the same site.

Retrieve a list of folders

This API call retrieves a list of folders contained within the specified folder. The 'limit' parameter sets the maximum number of items to return and the 'offset' parameter specifies the starting position for data retrieval. Default values are applied if these parameters are omitted, and the folders are returned in ascending order by creation date.

Retrieve a list of iSheet items

This API call retrieves a list of items contained in the specified iSheet.

Retrieve file information

This API call retrieves detailed information for a specified file from the HighQ Collaborate platform.

Retrieve iSheet columns

This API call retrieves the columns associated with the specified iSheet. This functionality is supported in API version 3 and above.

Retrieve user list

Retrieve a List of Users This API retrieves a list of users from the system. ## Key Features - Fetch user details with multiple filtering options - Supports pagination with `limit` and `offset` - New query parameters and fields introduced in recent versions - Structured response with user roles and attributes ## New Query Parameters (Version-Specific) - Introduced in V12: - `systemAdminSearch`: When set to `1`, only returns users with the System Admin role. - Introduced in V18: - `userid`: Accepts comma-separated values (CSV). ## Response Body Updates - New fields added: - `emaildomain`, `org`, `invitationsent`, `createdby`, `createddate`, `modifiedby`, `modifieddate` - `ifpartner`, `lastlogindate`, `invalidlogins`, `externalid`, `publicwebsiteprofileid` - `systemuser`, `resetpassworddate`, `usertypeid`, `avatar`, `practicegroup` - `langcode`, `publicprofile`, `dateOfBirth` ## Address Format Change (from V11) - The `location` tag has been renamed to `address` for consistency. - Example Response: `xml <address> <addressid>1</addressid> <addressline1>2nd floor</addressline1> <addressline2>additional</addressline2> <city>London</city> <state>state</state> <country>UK</country> <postCode>EC4R</postCode> </address>` ## User Roles (Introduced in API V11+) - Example Response: `xml <roles> <role> <alias>SYSTEM_ADMIN</alias> <name>System Admin</name> </role> <role> <alias>EXTERNAL_ADMIN</alias> <name>External Admin</name> </role> <role> <alias>INTERNAL_USER</alias> <name>Internal User</name> </role> </roles>` ## Limits & Offsets - Limit Behavior: - Default: `100` if no value is provided. - Use `-1` to return all records. - If value is less than `-1`, defaults to `100`. - Offset Behavior: - Default: `0` if no value is provided. - If offset exceeds total records, defaults back to `0`. ## New Roles Introduced - V12: `Basic User`, `Allow user to bypass XSS protection` - V14: `Allow user to manage Contract Express system groups` ## Error Codes | Summary | Ref Code (Before V4) | Ref Code (V4) | |---------|----------------------|--------------| | Invalid input for user status (ACTIVE, ARCHIVED, INACTIVE) | 147 | 147 | | Organisation ID is invalid | N/A | 260 | | Invalid `neverinvited` value (true/false) | N/A | 387 | | Invalid `neverlogin` value (true/false) | N/A | 388 | | Invalid `groupids` value | N/A | 214 | | Invalid `notingroup` value (true/false) | N/A | 389 | | Invalid `ordertype` (supported: name, organisation, status, etc.) | N/A | 289 | | Invalid `orderby` (supported: asc, desc) | N/A | 290 | | Invalid `offset` value | 138 | 138 | | Invalid `limit` value | 137 | 137 | ## Notes - From V13 onwards, this API is open for all users (previously limited to System Admins). - From V18 onwards, the `userregistered2FA` field indicates whether a user has registered for 2FA. --- This description follows Swagger 2.0 schema formatting and should be placed in the description field in Custom Connector schema.

To create the iSheet item

This API call is used to insert iSheet item. Multiple iSheets can be supported.

To get the status of an iSheet item based on a progressive key, call API POST /api/3/progressivekeystatus/{progressive_key}

e.g. POST /api/{version}/progressivekeystatus/{progressive_key}

Name	Type	Description
progressive_key	String	Key to check the status of your action.

Response

<progressivekeyresponse>
 \t<items>
  \t\t<item>
   \t\t\t<itemid>1232</itemid>
   \t\t\t<status>SUCCESS</status>
   \t\t\t<statuscode>200</statuscode>
   \t\t\t<message>Record added successfully</message>
  \t\t</item>
  \t\t<item>
   \t\t\t<itemid>1233</itemid>
   \t\t\t<status>SUCCESS</status>
   \t\t\t<statuscode>200</statuscode>
   \t\t\t<message>Record added successfully</message>
  \t\t</item>
 \t</items>
</progressivekeyresponse>

Update site

Use this API endpoint to update the details of an existing site. The API supports the same fields used in Create site API.

This method supports multiple matter numbers to add into site using API version 10 onward. "matternos" tag indicates multiple matter numbers with readonly or not.

Version 18 onwards: a categories (site purpose) is required. If the site purpose is hidden, a message is displayed; otherwise, hidden site purposes are not added to the site.

Now site owner can be assigned other users as well, but they must be site participants and have a role higher than site admin.

Version 18 onwards: the site owner can add other users to the site.

From API version 19 onwards, a new module called customPages is introduced, which is tightly coupled with the home module. If the home module value is True, customPages has to be true and vice versa.

Please note, all the properties/elements in get site response are not updatable/insertable. See below table to know which are read only, updatable, or insertable.

Update site group

This API method updates the name of an existing group in a site.
This API has been extended to update the name of an existing basic user group in a site.

Upload a file

This API call uploads a file to a specified folder on the HighQ Collaborate platform. It supports chunked uploads when the Content-Range header is provided.

Add existing group to site

Operation ID:: addExistingGroupToSite

This API method adds an existing system group to the site.
This API has been extended to add existing system basic user groups (of system / org type) in the site.

Parameters

Name	Key	Required	Type	Description
API Version	version	True	string	version
The ID of the site	siteid	True	string	The ID of the site.
The ID of the system group	groupid	True	string	The ID of the system group to be added to the site.

Returns

Body: sitegroup

Add site

Operation ID:: createSite

Parameters

Name	Key	Required	Type	Description
The version of the API being requested	version	True	string	version of api
id	id		integer	The site identifier.
sitename	sitename		string	The name of the site.
role	role		string	The role of the site.
sitedescription	sitedescription		string	The description of the site.
enabledmodules	enabledmodules		string	A list of modules enabled for the site.
sitefolderID	sitefolderID		string	The identifier for the site's folder.
sitefolderpermission	sitefolderpermission		string	The permission level for the site's folder.
enable	enable		string	Enable status for HomeDBO.
enable	enable		string	Enable status for ActivityDBO.
microblog	microblog		string	Microblog content associated with ActivityDBO.
docid	docid		string	Document ID.
blogTitle	blogTitle		string	Title of the blog post.
blogContent	blogContent		string	Content of the blog post.
showComment	showComment		integer	show the comment.
tagList	tagList		array of string	List of tags associated with the blog.
status	status		integer	status of the blog post.
siteID	siteID		integer	Identifier for the associated site.
author	author		string	Author of the blog.
categoryList	categoryList		array of string	Categories assigned to the blog post.
notificationTypeID	notificationTypeID		integer	Identifier for the notification type.
message	message		string	Message content related to the blog.
messageCode	messageCode		integer	Code associated with the message.
externalID	externalID		string	External identifier linked to the blog.
publishDate	publishDate		string	Publication date of the blog.
processtype	processtype		string	Process type associated with the blog.
enable	enable		string	Enable status for BlogDBO.
wikiid	wikiid		integer	Unique identifier for the wiki.
currentversionid	currentversionid		integer	Identifier for the current version of the wiki
parentwikiid	parentwikiid		integer	Identifier for the parent wiki.
wikititle	wikititle		string	Title of the wiki.
wikicontent	wikicontent		string	Content of the wiki.
showcomment	showcomment		integer	Indicating if comments are enabled.
createddate	createddate		string	Creation date of the wiki.
modifieddate	modifieddate		string	Last modification date of the wiki.
taglist	taglist		string	Comma-separated list of tags associated with the wiki.
wikipath	wikipath		string	Path to access the wiki.
wikidraftid	wikidraftid		integer	Identifier for the draft version of the wiki.
drafttype	drafttype		string	Type of draft associated with the wiki.
status	status		integer	Current status of the wiki.
wikiversionid	wikiversionid		integer	Version identifier of the wiki.
index	index		string	Index or identifier for the task.
parenttaskid	parenttaskid		integer	Identifier for the parent task.
taskid	taskid		integer	Unique identifier for the task.
title	title		string	Title of the task.
description	description		string	Detailed description of the task.
duedate	duedate		string	Due date for the task completion.
startdate	startdate		string	Start date when the task was initiated.
mattermaptaskid	mattermaptaskid		string	Identifier linking to the matter map task.
type	type		string	Type or category of the task.
dependenton	dependenton		string	Tasks that this task depends on.
daysfromdependent	daysfromdependent		string	Number of days from the dependent task.
ignoreweekend	ignoreweekend		integer	Indicates if weekends are ignored in scheduling.
duration	duration		integer	Duration to complete the task.
resource	resource		string	Resources assigned to the task.
eventTitle	eventTitle		string	Title of the event.
eventContent	eventContent		string	Content of the event.
showComment	showComment		integer	Indicating if comments are enabled for the event.
tagList	tagList		array of string	List of tags associated with the event.
status	status		integer	Current status of the event.
siteID	siteID		integer	Identifier for the site.
contact	contact		string	Contact information for the event.
categoryList	categoryList		array of string	Categories under which the event is listed.
notificationTypeID	notificationTypeID		integer	The notification type related to the event.
message	message		string	The message of the event.
messageCode	messageCode		integer	The message code of the event.
externalID	externalID		string	The external Identifier.
startDate	startDate		string	The start date of the event.
endDate	endDate		string	The end date of the event.
startTime	startTime		string	The start time of the event.
endTime	endTime		string	The end time of the event.
location	location		string	The location of the event.
author	author		string	The author of the event.
processtype	processtype		string	The process time of the event.
enable	enable		string	Enable's the event.
id	id		integer	Unique identifier for the iSheet.
title	title		string	Title of the iSheet.
description	description		string	Description of the isheet.
status	status		string	Status of the isheet.
accesstype	accesstype		string	Access type of the isheet.
type	type		string	Type of the isheet.
viewlink	viewlink		string	Link to view the iSheet.
allowsections	allowsections		string	Whether sections are allowed.
allowlookup	allowlookup		string	Whether lookup fields are enabled.
displayisheet	displayisheet		string	Display options for the iSheet.
searchasdefaultview	searchasdefaultview		string	Indicates if search is default view.
enableversion	enableversion		string	Versioning enabled flag.
enablesheetalerter	enablesheetalerter		string	Flag to enable sheet alerts.
alertercondition	alertercondition		string	Conditions for triggering alerts.
overrideitemmodifieddate	overrideitemmodifieddate		string	Override modified date flag.
enablebulkinsertupdate	enablebulkinsertupdate		string	Enable bulk insert/update.
fielddescriptions	fielddescriptions		string	Field descriptions for the iSheet.
enablerowlocking	enablerowlocking		string	Enable row-level locking.
setcharlimittruncatemultilinetextenabled	setcharlimittruncatemultilinetextenabled		string	Truncate multiline text flag.
setcharlimittruncatemultilinetextval	setcharlimittruncatemultilinetextval		string	Character limit for multiline truncation.
allowchoicelistvaluesforreuse	allowchoicelistvaluesforreuse		string	Allow reuse of choice list values.
allowscorelistvaluesforreuse	allowscorelistvaluesforreuse		string	Allow reuse of score list values.
allowIsheetComments	allowIsheetComments		string	Allow comments in iSheet.
shareRecordsLimit	shareRecordsLimit		integer	Limit of records allowed to share.
shareRecordsLimitEnabled	shareRecordsLimitEnabled		integer	Enabled records share limit.
enableIsheetAddRecordFormSharing	enableIsheetAddRecordFormSharing		string	Enable form sharing for adding records.
recordcount	recordcount		string	Current record count.
sheettypeid	sheettypeid		integer	Type ID of the iSheet
enable	enable		string	Enable QA functionality.
userid	userid		integer	User ID.
email	email		string	email address.
httpavatar	httpavatar		string	HTTP URL of avatar.
avatar	avatar		string	Avatar image.
userlink	userlink		string	Link to user profile.
httplink	httplink		string	HTTP link to user profile.
phone	phone		string	Phone Number.
mobile	mobile		string	Mobile Number.
department	department		string	User's department.
enable	enable		string	Enable Contract Express integration.
adminnote	adminnote		string	Administrative notes related to the site.
startdate	startdate		string	The start date of the site's operation.
enddate	enddate		string	The end date of the site's operation.
createddate	createddate		string	The date when the site was created.
archiveddate	archiveddate		string	The date when the site was archived.
clientno	clientno		string	The client number associated with the site.
matterno	matterno		string	The matter number associated with the site.
landingpage	landingpage		string	The landing page URL for the site.
link	link		string	A link related to the site.
status	status		string	The current status of the site.
statusid	statusid		integer	The identifier for the site's status.
size	size		string	The size of the site.
billingnotes	billingnotes		string	Notes related to billing for the site.
billingnextinvoicedate	billingnextinvoicedate		string	The date of the next invoice for the site.
billinglastinvoicedate	billinglastinvoicedate		string	The date of the last invoice for the site.
filepagecount	filepagecount		string	The total page count of files on the site.
maxpagecount	maxpagecount		string	The maximum allowed page count for files on the site.
sitehttplink	sitehttplink		string	The HTTP link to the site.
isSyncable	isSyncable		integer	Indicates if the site is syncable.
enforceusergroups	enforceusergroups		string	The user groups enforced for the site.
csvSiteCategory	csvSiteCategory		string	The category of the site in CSV format.
siteNameInDefaultLanguage	siteNameInDefaultLanguage		string	The name of the site in the default language.
visible	visible		integer	Indicates if the site is visible.
siteLogoName	siteLogoName		string	The name of the site's logo file.
siteLogoFileSize	siteLogoFileSize		integer	The file size of the site's logo.
siteLogoHeight	siteLogoHeight		integer	The height of the site's logo.
siteLogoWidth	siteLogoWidth		integer	The width of the site's logo.
siteStatus	siteStatus		integer	The status code of the site.
applySiteTerms	applySiteTerms		integer	Indicates if site terms are applied.
siteTerm	siteTerm		string	The terms applied to the site.
termType	termType		integer	The type of terms applied to the site.
nextLoginSiteTerms	nextLoginSiteTerms		integer	Indicates if site terms are required on next login.
defaultSiteTermsEnable	defaultSiteTermsEnable		integer	Indicates if default site terms are enabled.
advancedQAPermission	advancedQAPermission		integer	The advanced QA permission level for the site.
isInternal	isInternal		integer	Indicates if the site is internal.
psm	psm		integer	The Product Service Manager identifier.
siteLabelDisplay	siteLabelDisplay		string	The display label for the site.
allowSiteAdministration	allowSiteAdministration		integer	Indicating if site administration is allowed.
siteLevelPasswordEnable	siteLevelPasswordEnable		integer	To enable site-level password protection.
siteLevelPasscodeEnable	siteLevelPasscodeEnable		integer	To enable site-level passcode protection.
passcodeUsingAuthApp	passcodeUsingAuthApp		integer	Indicates if passcode authentication uses an authentication app.
sitePassword	sitePassword		string	The password associated with the site.
ipRestrictionEnable	ipRestrictionEnable		integer	To enable IP restrictions for site access.
availableIP	availableIP		string	Comma-separated list of IP addresses allowed to access the site.
highqDrive	highqDrive		integer	Indicates if HighQ Drive integration is enabled.
applySiteHomePage	applySiteHomePage		integer	To apply a custom home page for the site.
siteHomePage	siteHomePage		string	URL of the custom home page for the site.
siteHomePageType	siteHomePageType		integer	Type of the home page.
nextLoginSiteHomePage	nextLoginSiteHomePage		integer	To set the next login to the site home page.
applyDisplayContent	applyDisplayContent		integer	To apply display content settings.
displayContent	displayContent		string	Content to display on the site.
rssSecurity	rssSecurity		integer	RSS feed security level.
encryptedPassword	encryptedPassword		integer	Indicates if the site password is encrypted.
availableIPRangeCSV	availableIPRangeCSV		string	Comma-separated list of IP address ranges allowed to access the site.
siteModuleID	siteModuleID		integer	Identifier for the site module.
icalSecurity	icalSecurity		integer	iCal feed security level.
defaultDisplayContent	defaultDisplayContent		string	Default content to display on the site.
defaultEmailAlert	defaultEmailAlert		integer	To enable default email alerts.
excelReportFooter	excelReportFooter		integer	Includes a footer in Excel reports.
excelReportFooterText	excelReportFooterText		string	Text to display in the footer of Excel reports.
announcementMLJSON	announcementMLJSON		string	JSON-formatted announcements for the site.
templateType	templateType		integer	Type of template used for the site.
templateLicence	templateLicence		integer	License type for the site template.
openChannelAppID	openChannelAppID		string	Application ID for the open channel integration.
itemid	itemid		integer	Identifier for the item associated with the site.
sitemetadatasheetid	sitemetadatasheetid		integer	ID of the metadata sheet associated with the site.
mysite	mysite		boolean	Indicates if this is the user's personal site.
lastaccesseddate	lastaccesseddate		string	Date and time when the site was last accessed.
defaultViewerMetaDataTab	defaultViewerMetaDataTab		integer	Default metadata tab for the site viewer.
documentMetadataViewId	documentMetadataViewId		integer	document metadata for view identifier.
folderMetadataViewId	folderMetadataViewId		integer	folder metadata for view identifier.
docSort	docSort		integer	The sorting order of documents.
folderSort	folderSort		integer	The sorting order of folders.
defaultFolderRenderView	defaultFolderRenderView		integer	Determines the default view mode for folders.
isTaskAttachmentDefault	isTaskAttachmentDefault		integer	The default location for task attachments.
taskAttachmentDefaultFolderId	taskAttachmentDefaultFolderId		integer	The unique identifier of the folder designated as the default location for task attachments.
favourite	favourite		string	favourite status.
enabledocumentredaction	enabledocumentredaction		boolean	Specifies whether document redaction is enabled for the site.
mentiongroups	mentiongroups		integer	The mentioned groups.
enablefilerelationships	enablefilerelationships		boolean	Indicates whether file relationships are enabled.
filerelationshipsitepermissionlevel	filerelationshipsitepermissionlevel		integer	The permission level required to manage file relationships.

Returns

Body: site

Add User

Operation ID:: createUser

Summary	Ref Code (before V4)	Ref Code (V4)
Email address is required	101	101
Invalid email address	104	104
First name is required	102	102
Maximum allowed characters for the first name must be between 1 to 100	102	352
The secretary's/assistant's email address is not valid	104	353
Status must be active or inactive	116	116
The entered department cannot be more than 256 characters	N/A	354
The entered ifpartner attribute is invalid	N/A	355
The entered systemuser attribute is invalid	N/A	356
The entered usertypeid attribute is invalid	N/A	357
The entered langcode attribute is invalid	N/A	358
The entered sourcetype attribute is invalid.Valid values are System, Active directory or System default .	N/A	359
Please enter valid phone number	N/A	360
Please enter valid phone number in format {countrycode} ${areacode}${number}.	N/A	361
Please enter valid mobile number in format {countrycode}${number}.	N/A	362
Enter a valid office phone country code	N/A	363
The office phone country code can have a maximum of 4 digits	N/A	364
Enter a valid office phone area code	N/A	365
The office phone area code can have a maximum of 5 Digits	N/A	366
Office phone number should have maximum of 15 digits	N/A	368
Enter a valid mobile phone country code	N/A	369
The mobile phone country code can have a maximum of 4 Digits	N/A	372
Please enter a valid mobile number	N/A	373
Mobile phone number should have maximum of 20 digits	N/A	374
Domain does not exist	105	105
Email already exists in the system	111	111
Mention organisation in case of self registered domain	187	187
Mention organisation in case of exceptional domain	115	115
Org id is not in the proper format	112	112
Organisation does not exist	106	106
Domain exist in other organisation	114	114
Entered Address Id is not valid	N/A	308
Social link name not found in system.	N/A	375
The social link name is required	N/A	376
The social link value is required	N/A	377
Maximum characters for social link value must be between 1 to 500	N/A	378
Enter the name for the custom link	N/A	379
The custom link value required	N/A	380
Max characters for custom link name must be between 1 to 500	N/A	381
Max characters for custom link value must be between 1 to 500	N/A	382
The message link name required	N/A	383
Message link name not found in system	N/A	384
The message link value required	N/A	385
Max characters for message link value must be between 1 to 500	N/A	386
The social link is disabled	N/A	408
The message link is disabled	N/A	409
The custom link is disabled	N/A	410

JIRA Ticket : https://dev.highq.com/jira/browse/COL-65685

Parameters

Name	Key	Required	Type	Description
API Version	version	True	string	version of api
index	index		integer	Unique index for the user.
userid	userid		integer	Unique identifier for the user.
firstname	firstname		string	First name of the user.
lastname	lastname		string	Last name of the user.
practicegroup	practicegroup		string	Practice group the user belongs to.
langcode	langcode		string	Language code of the user.
localeID	localeID		string	Locale ID of the user.
publicprofile	publicprofile		string	Public profile of the user.
pwpid	pwpid		string	PWP ID of the user.
usertypeid	usertypeid		string	User type ID.
systemuser	systemuser		string	System user flag.
email	email		string	Email address of the user.
phone	phone		string	Phone number of the user.
mobile	mobile		string	Mobile number of the user.
department	department		string	Department of the user.
org	org		string	Organization the user belongs to.
addressline1	addressline1		string	First line of the address.
addressline2	addressline2		string	Second line of the address.
addressline3	addressline3		string	Third line of the address.
city	city		string	City of the address.
state	state		string	State of the address.
country	country		string	Country of the address.
postcode	postcode		string	Postal code of the address.
addressid	addressid		string	Unique identifier for the address.
addressline1	addressline1		string	First line of the address.
addressline2	addressline2		string	Second line of the address.
addressline3	addressline3		string	Third line of the address.
city	city		string	City of the address.
state	state		string	State of the address.
country	country		string	Country of the address.
postCode	postCode		string	Postal code of the address.
knownas	knownas		string	Alternative name or nickname for the address.
experience	experience		array of string
id	id		string	Link ID
name	name		string	Link Name.
value	value		string	Link Value.
id	id		string	Link ID
name	name		string	Link Name.
value	value		string	Link Value.
id	id		string	Link ID
name	name		string	Link Name.
value	value		string	Link Value.
img	img		string
reportsto	reportsto		string
metadataname	metadataname		array of string
metadatavalue	metadatavalue		array of string
group	group		array of string
externalid	externalid		string	External ID of the user.
jobtitle	jobtitle		string	Job title of the user.
secretaryname	secretaryname		string	Name of the user's secretary.
secretarymail	secretarymail		string	Email of the user's secretary.
specialities	specialities		string	Specialities of the user.
title	title		string	Title of the user.
goesby	goesby		string	preferred name of the user.
suffix	suffix		string	Suffix of the user's name.
atomlink	atomlink		string	Atom link associated with the user.
bio	bio		string	Biography of the user.
dateOfBirth	dateOfBirth		string	Date of birth of the user.
link	link		string	Link associated with the user.
status	status		string	Status of the user.
statuscode	statuscode		string	Status code of the user.
message	message		string	Message associated with the user.
sourcetype	sourcetype		string	Source type of the user.
orgid	orgid		string	Organization ID.
ifpartner	ifpartner		string	Partner flag.
emaildomain	emaildomain		string	Email domain of the user.
invitationsent	invitationsent		string	Invitation sent flag.
createdby	createdby		string	User who created the record.
createddate	createddate		string	Date the record was created.
modifiedby	modifiedby		string	User who modified the record.
modifieddate	modifieddate		string	Date the record was modified.
lastlogindate	lastlogindate		string	Date of the last login.
invalidlogins	invalidlogins		string	Count of invalid login attempts.
publicwebsiteprofileid	publicwebsiteprofileid		string	Public website profile ID.
resetpassworddate	resetpassworddate		string	Date the password was reset.
avatar	avatar		string	Avatar image URL.
followingcount	followingcount		integer	Count of users being followed.
followercount	followercount		integer	Count of followers.
following	following		boolean	Following flag.
role	role		string	Role of the user.
isbasicuser	isbasicuser		string	Basic user flag.
encryptedUserId	encryptedUserId		string	Encrypted user ID.
selfregistered	selfregistered		integer	Self-registered flag.
registeredWith2FA	registeredWith2FA		string	Two-factor authentication registration flag.
isInternal	isInternal		integer	Internal user flag.
orgName	orgName		string	Name of the organization.

Returns

Body: IntegrationUserDBO

Archive User

Operation ID:: deleteUser

This API call is used to archive a user within the system.

Error Codes

Summary	Ref Code (before V4)	Ref Code (V4)
The following users do not exist within the system	110	110
A User ID is required	109	109
User ID is not in the proper format	113	113
The User's ID length cannot exceeds 50 characters	N/A	304

JIRA Ticket : https://dev.highq.com/jira/browse/COL-67441

Parameters

Name	Key	Required	Type	Description
API Version	version	True	string	version of api
User Id	userid	True	string	user id

Create Folder

Operation ID:: addFolder

This API creates a new folder within the specified site. It allows you to provide folder details and ensures the folder is created under the given parent folder.

Parameters

Name	Key	Required	Type	Description
API Version	version	True	string	Specifies the API version.
Batch Identifier	batchid		string	A unique identifier for the batch operation.
Root Folder ID	rootfolderid		string	The unique identifier of the root folder.
Parent Folder ID	parentfolderid	True	string	The unique identifier of the parent folder where the new folder will be created.
Allow Duplicate Folder	allowduplicatefolder		boolean	Indicates whether duplicate folders are allowed in the specified parent folder.
name	name	True	string	The name of the folder.
description	description		string	A description of the folder.
accessInherited	accessInherited		integer	Indicates if the folder access is inherited.
batchID	batchID		string	The batch identifier for the operation.
dmsfolderid	dmsfolderid		string	The DMS folder identifier.
dmsParentFolderID	dmsParentFolderID		string	The DMS parent folder identifier.
dmscreateddate	dmscreateddate		date-time	The date the DMS folder was created.
dmsmodifiedBy	dmsmodifiedBy		string	The user who last modified the DMS folder.
dmsdatabasename	dmsdatabasename		string	The name of the DMS database.
dmslink	dmslink		boolean	Indicates whether a DMS link is available.
dmslinkby	dmslinkby		string	The user who linked the DMS folder.
emailmetadata	emailmetadata		string	Email metadata associated with the folder.

Returns

Body: FolderDBOV1

Get folder info

Operation ID:: getFolderInfo

The method provides folder detail of given folder id.

Parameters

Name	Key	Required	Type	Description
API Version	version	True	string	version of api
Folder ID	folderid	True	string	folderID
Status Information	statusinfo		boolean	The statusinfo parameter allows you to access additional information about the folder. The information available includes Shared Status, Favourite Status for logged in user

Returns

Body: FolderDBOV2

Move Documents

Operation ID:: moveDocuments

This API moves multiple files from one folder to another within the same site.

Parameters

Name	Key	Required	Type	Description
API Version	version	True	string	Specifies the API version.
Target Folder ID	targetfolder	True	string	The unique identifier of the target folder where the files will be moved.
fileidCSV	fileidCSV		string	The comma-separated list of file IDs to be moved.

Retrieve a list of folders

Operation ID:: getFolderList

Parameters

Name	Key	Required	Type	Description
API Version	version	True	string	Specifies the version of the API being used.
Folder ID	folderid	True	string	Specifies the unique ID of the folder.
Items Limit	limit		string	Specifies the maximum number of items to return.
Items Offset	offset		string	Specifies the starting position for the returned items.
Sort Order Direction	orderby		string	Specifies the order direction for sorting items. Use 'asc' for ascending order or 'desc' for descending order.
Sort Criterion	ordertype		string	Specifies the criterion for sorting items, such as name, author, or last modified date.
Include Folder Status Info	statusinfo		boolean	Indicates whether to include additional folder status information. The default value is false.
Include Smart Folders	includesmartfolder		boolean	Indicates whether to include smart folders in the returned list. The default value is false.

Returns

Name	Path	Type	Description
folder	folder	array of object
items	folder	object

Retrieve a list of iSheet items

Operation ID:: getISheetItems

This API call retrieves a list of items contained in the specified iSheet.

Parameters

Name	Key	Required	Type	Description
API Version	version	True	string	Specifies the version of the API being used.
iSheet ID	isheetid	True	integer	Specifies the unique ID of the iSheet.
iSheet View ID	sheetviewid		integer	Specifies the ID of the iSheet view. If omitted, the default view is returned.
Sort Column ID	sortcolumnid		integer	Specifies the ID of the column used for sorting the results.
Sort Order	sortorder		integer	Specifies the sorting order. For example, use 0 for ascending order or another value for descending order.
Record Limit	limit		integer	Specifies the maximum number of records to return; the default value is 100 if not specified.
Record Offset	offset		integer	Specifies the starting position for record retrieval; the default is 0 if not specified.
Include All Columns	allColumnRequired		boolean	A flag that indicates whether to include all column data regardless of the current view.
Ignore View Restrictions	isIgnoreView		boolean	A flag that indicates whether to ignore view restrictions when retrieving item data.

Returns

Name	Path	Type	Description
isheet	isheet	array of object	A list of iSheet items.
itemId	isheet.itemId	string	The unique ID of the item.
data	isheet.data	array of object	Detailed data of the item.
sequence	isheet.data.sequence	string	The sequence number associated with the data.
columnDisplayName	isheet.data.columnDisplayName	string	The display name of the column.
value	isheet.data.value	string	The value contained in the column.

Retrieve file information

Operation ID:: getDocumentInfo

This API call retrieves detailed information for a specified file from the HighQ Collaborate platform.

Parameters

Name	Key	Required	Type	Description
API Version	version	True	string	Specifies the version of the API being used.
File ID	fileid	True	string	Specifies the unique ID of the file.
Latest DMS Info Flag	lastdmsinfo		boolean	Indicates whether to retrieve the latest information from the Document Management System.
Folder Type	foldertype		string	Specifies the type of folder if applicable.
Include File Status Info	statusinfo		boolean	Indicates whether to include additional file status information such as shared status, favourite status, task count, and liked status. The default value is false.
Include Email Metadata	emailmetadata		boolean	Indicates whether to include email metadata such as sender, recipients, and timestamps. The default value is false.

Returns

Body: DocumentDBO

Retrieve iSheet columns

Operation ID:: getIsheetColumns

This API call retrieves the columns associated with the specified iSheet. This functionality is supported in API version 3 and above.

Parameters

Name	Key	Required	Type	Description
iSheet ID	isheetid	True	integer	Specifies the unique ID of the iSheet for which columns are required.
API Version	version	True	string	Specifies the version of the API being used.
iSheet View ID	sheetviewid		string	Specifies the ID of the iSheet view. If omitted, all columns are returned.
Include Deleted iSheet Columns	onlyForDeletedIsheet		boolean	Indicates whether to include columns from a deleted iSheet. The default value is false.

Returns

Body: columns

Retrieve user list

Operation ID:: getAllSystemUsers

Retrieve a List of Users This API retrieves a list of users from the system. ## Key Features - Fetch user details with multiple filtering options - Supports pagination with `limit` and `offset` - New query parameters and fields introduced in recent versions - Structured response with user roles and attributes ## New Query Parameters (Version-Specific) - Introduced in V12: - `systemAdminSearch`: When set to `1`, only returns users with the System Admin role. - Introduced in V18: - `userid`: Accepts comma-separated values (CSV). ## Response Body Updates - New fields added: - `emaildomain`, `org`, `invitationsent`, `createdby`, `createddate`, `modifiedby`, `modifieddate` - `ifpartner`, `lastlogindate`, `invalidlogins`, `externalid`, `publicwebsiteprofileid` - `systemuser`, `resetpassworddate`, `usertypeid`, `avatar`, `practicegroup` - `langcode`, `publicprofile`, `dateOfBirth` ## Address Format Change (from V11) - The `location` tag has been renamed to `address` for consistency. - Example Response: `xml <address> <addressid>1</addressid> <addressline1>2nd floor</addressline1> <addressline2>additional</addressline2> <city>London</city> <state>state</state> <country>UK</country> <postCode>EC4R</postCode> </address>` ## User Roles (Introduced in API V11+) - Example Response: `xml <roles> <role> <alias>SYSTEM_ADMIN</alias> <name>System Admin</name> </role> <role> <alias>EXTERNAL_ADMIN</alias> <name>External Admin</name> </role> <role> <alias>INTERNAL_USER</alias> <name>Internal User</name> </role> </roles>` ## Limits & Offsets - Limit Behavior: - Default: `100` if no value is provided. - Use `-1` to return all records. - If value is less than `-1`, defaults to `100`. - Offset Behavior: - Default: `0` if no value is provided. - If offset exceeds total records, defaults back to `0`. ## New Roles Introduced - V12: `Basic User`, `Allow user to bypass XSS protection` - V14: `Allow user to manage Contract Express system groups` ## Error Codes | Summary | Ref Code (Before V4) | Ref Code (V4) | |---------|----------------------|--------------| | Invalid input for user status (ACTIVE, ARCHIVED, INACTIVE) | 147 | 147 | | Organisation ID is invalid | N/A | 260 | | Invalid `neverinvited` value (true/false) | N/A | 387 | | Invalid `neverlogin` value (true/false) | N/A | 388 | | Invalid `groupids` value | N/A | 214 | | Invalid `notingroup` value (true/false) | N/A | 389 | | Invalid `ordertype` (supported: name, organisation, status, etc.) | N/A | 289 | | Invalid `orderby` (supported: asc, desc) | N/A | 290 | | Invalid `offset` value | 138 | 138 | | Invalid `limit` value | 137 | 137 | ## Notes - From V13 onwards, this API is open for all users (previously limited to System Admins). - From V18 onwards, the `userregistered2FA` field indicates whether a user has registered for 2FA. --- This description follows Swagger 2.0 schema formatting and should be placed in the description field in Custom Connector schema.

Parameters

Name	Key	Required	Type	Description
API Version	version	True	string	Version of the API.
User Status	status		string	Filter users by status: Active, Archived, Inactive, or Locked.
Pagination Offset	offset		string	Starting position for pagination.
Results Limit	limit		string	Number of items to return per request.
Organization ID	orgid		string	Filter users by organization ID.
Never Invited Users	neverinvited		string	Retrieve users who have never been invited.
Never Logged-in Users	neverlogin		string	Retrieve users who have never logged in.
User ID	userid		string	Filter users by their unique user ID(s).
Group ID	groupid		string	Filter users by group ID(s).
Users Not in Groups	notingroup		string	Retrieve users who are not in any group.
Sort Order Type	ordertype		string	Sort users by a specified field such as name, organization, or status.
Sort Order	orderby		string	Sort results in ascending or descending order.
External ID	externalid		string	Filter users by external ID.
First Name	firstname		string	Filter users by first name.
Last Name	lastname		string	Filter users by last name.
Email Address	email		string	Filter users by email address.
User Search	search		string	Search for users by various attributes including name, email, and job title.
Alphabet Filter	alphabets		string	Filter users whose last name starts with a specific letter.
Job Title	jobtitle		string	Filter users by job title.
Location	locations		string	Filter users by city.
Department	departments		string	Filter users by department.
Organization Name	organisations		string	Filter users by organization name.
Specialties	specialities		string	Filter users by their specialities.
System Admin Search	systemAdminSearch		string	Retrieve users with the System Admin role.

Returns

Body: users

To create the iSheet item

Operation ID:: insertISheetItems

This API call is used to insert iSheet item. Multiple iSheets can be supported.

To get the status of an iSheet item based on a progressive key, call API POST /api/3/progressivekeystatus/{progressive_key}

e.g. POST /api/{version}/progressivekeystatus/{progressive_key}

Name	Type	Description
progressive_key	String	Key to check the status of your action.

Response

<progressivekeyresponse>
 \t<items>
  \t\t<item>
   \t\t\t<itemid>1232</itemid>
   \t\t\t<status>SUCCESS</status>
   \t\t\t<statuscode>200</statuscode>
   \t\t\t<message>Record added successfully</message>
  \t\t</item>
  \t\t<item>
   \t\t\t<itemid>1233</itemid>
   \t\t\t<status>SUCCESS</status>
   \t\t\t<statuscode>200</statuscode>
   \t\t\t<message>Record added successfully</message>
  \t\t</item>
 \t</items>
</progressivekeyresponse>

Parameters

Name	Key	Required	Type	Description
API Version	version	True	string	Version of the api
iSheet Identifier	isheetid	True	integer	Id of the iSheet
Sheet View Identifier	sheetviewid		integer	Id of the iSheet view (Optional)
id	id		integer	Isheet identifier.
title	title		string	Title of the sheet.
description	description		string	Description of the sheet.
status	status		string	Status of the sheet.
accesstype	accesstype		string	Access type of the sheet.
type	type		string	Type of the sheet.
viewlink	viewlink		string	URL link to view the sheet.
allowsections	allowsections		string	Indicates if sections are allowed.
allowlookup	allowlookup		string	Indicates if lookup is permitted.
displayisheet	displayisheet		string	Display isheet.
searchasdefaultview	searchasdefaultview		string	Sets search as default view.
enableversion	enableversion		string	Enable Version.
enablesheetalerter	enablesheetalerter		string	Activates sheet alerter.
alertercondition	alertercondition		string	Condition for triggering alerts.
overrideitemmodifieddate	overrideitemmodifieddate		string	Over ride's the item modified date.
enablebulkinsertupdate	enablebulkinsertupdate		string	Allow bulk insert update.
fielddescriptions	fielddescriptions		string	description for fields.
enablerowlocking	enablerowlocking		string	Enables row locking.
setcharlimittruncatemultilinetextenabled	setcharlimittruncatemultilinetextenabled		string	Enables character limit truncation for multiline text.
setcharlimittruncatemultilinetextval	setcharlimittruncatemultilinetextval		string	sets character limit for truncation.
allowchoicelistvaluesforreuse	allowchoicelistvaluesforreuse		string	Allows reuse of choice list values.
allowscorelistvaluesforreuse	allowscorelistvaluesforreuse		string	Allows reuse of score list values.
allowIsheetComments	allowIsheetComments		string	Permits comments on the sheet.
shareRecordsLimit	shareRecordsLimit		integer	Limit on shared records.
shareRecordsLimitEnabled	shareRecordsLimitEnabled		integer	Enable sharing record limit.
enableIsheetAddRecordFormSharing	enableIsheetAddRecordFormSharing		string	Enables sharing of add record form.
allowViewBaseRendering	allowViewBaseRendering		string	Allows base rendering of views.
column	column		object
recordcount	recordcount		string	Total number of records.
viewId	viewId		integer	Unique identifier for the view.
siteId	siteId		integer	Identifier for the associated site.
siteName	siteName		string	Name of the site.
sheetName	sheetName		string	Name of the sheet.
viewName	viewName		string	Name of the view.
sheetId	sheetId		integer	Identifier for the sheet.
sequence	sequence		string	Sequence number of the header column.
columnValue	columnValue		string	Value of the header column.
columnTypeId	columnTypeId		string	Identifier for the column type.
columnId	columnId		string	Unique identifier for the column.
columnTypeAlias	columnTypeAlias		string	Alias name for the column type.
itemsequence	itemsequence		string	Sequence number of the item.
itemid	itemid		string	Unique identifier for the item.
externalid	externalid		string	External identifier associated with the item.
columnid	columnid		integer	Unique identifier for the column
name	name		string	Name of the column
type	type		integer	Data type of the column.
systemgeneratedtype	systemgeneratedtype		string	System-generated type information.
section	section		integer	Section number where the column is located.
description	description		string	Detailed description of the column.
addtodefaultview	addtodefaultview		string	Indicates if the column is added to the default view.
columnconditionstate	columnconditionstate		string	State of the column's condition.
rowid	rowid		integer	Identifier for the row.
columnid	columnid		integer	Identifier for the column.
operatorid	operatorid		integer	Identifier for the operator.
oprand	oprand		string	Operand value for the filter.
logicaltype	logicaltype		string	Logical type of the filter.
sheetfiltervaluetypeid	sheetfiltervaluetypeid		string	ID for the sheet filter value type.
displaytype	displaytype		string	Display type of the filter.
sourceColumnId	sourceColumnId		integer	Source column ID for the filter.
scoreConditionTypeid	scoreConditionTypeid		integer	ID for the score condition type.
defaultvalue	defaultvalue		string	Default value for the column.
columnwidth	columnwidth		string	Width of the column.
sheetname	sheetname		string	Name of the associated sheet.
sitename	sitename		string	Name of the site.
mandatory	mandatory		string	Indicates if the column is mandatory.
allowsearch	allowsearch		string	Specifies if search is allowed.
maxchars	maxchars		integer	Maximum number of characters.
allowfieldfromanotherisheet	allowfieldfromanotherisheet		string	Allows field from another sheet.
allowrichhtmltext	allowrichhtmltext		string	Specifies if rich HTML text is allowed.
numberoflines	numberoflines		integer	Number of lines in the column.
displaymethod	displaymethod		string	Method used to display the column.
includeotheroption	includeotheroption		string	Includes an 'Other' option.
singleormultileselectioninsearch	singleormultileselectioninsearch		string	Specifies selection type in search.
id	id		string	Unique identifier for the choice."
label	label		string	Label for the choice.
score	score		string	Score associated with the choice.
color	color		string	Color code for the choice.
imageid	imageid		integer	ID of the associated image.
includeinalertpreferences	includeinalertpreferences		string	Includes in alert preferences.
min	min		string	Minimum value for the column.
max	max		string	Maximum value for the column.
decimalplaces	decimalplaces		integer	Number of decimal places.
showthousandseparators	showthousandseparators		string	Displays thousand separators.
showaspercentage	showaspercentage		string	Displays value as percentage.
formattype	formattype		string	Specifies the format type of the column.
dateformat	dateformat		string	Defines the date format for the column.
defaultdateandtime	defaultdateandtime		string	Sets the default date and time value for the column.
sheetlookup	sheetlookup		string	Indicates if the column is a lookup to another sheet.
fielddisplay	fielddisplay		string	Determines how the field is displayed.
allowmultipleusers	allowmultipleusers		string	Specifies if multiple users can access the field.
methodtype	methodtype		string	Defines the method type for the column.
sheetids	sheetids		string	Lists the IDs of the sheets associated with the column.
allowuserstorenamelinks	allowuserstorenamelinks		string	Indicates if users can rename links in the column.
sheetid	sheetid		integer	Specifies the ID of the sheet.
columnids	columnids		string	Lists the IDs of the columns.
viewid	viewid		integer	Specifies the ID of the view.
allowmultiplevalues	allowmultiplevalues		string	Indicates if multiple values are allowed in the column.
restrictdelete	restrictdelete		string	Specifies if deletion is restricted for the column.
displaycolumnnameprefix	displaycolumnnameprefix		string	Sets the prefix for the column name display.
linkname	linkname		string	Defines the name of the link associated with the column.
donotcountweekendsonlycountmontofri	donotcountweekendsonlycountmontofri		string	Specifies if weekends are excluded in counting.
currentsheetcolumnid	currentsheetcolumnid		integer	ID of the current sheet column.
targetsheetcolumnid	targetsheetcolumnid		integer	ID of the target sheet column.
formula	formula		string	Specifies the formula applied to the column.
startvalue	startvalue		integer	Sets the starting value for the column.
prefix	prefix		string	Defines the prefix for the column values.
postfix	postfix		string	Defines the postfix for the column values.
minlength	minlength		integer	Specifies the minimum length of the column values.
lookupglossarysheetid	lookupglossarysheetid		integer	Specifies the ID of the lookup glossary sheet.
lookupglossarysheetviewid	lookupglossarysheetviewid		integer	Specifies the view ID of the lookup glossary sheet.
width	width		integer	Sets the width of the column.
otherscorevalue	otherscorevalue		string	Defines the other score value for the column.
importdatafromexternalsource	importdatafromexternalsource		string	Indicates if data is imported from an external source.
analysisengine	analysisengine		string	Specifies the analysis engine used for the column.
attachmentcustomfolderid	attachmentcustomfolderid		integer	Specifies the custom folder ID for attachments.
isattachmentfoldercurrentsite	isattachmentfoldercurrentsite		integer	Indicates if the attachment folder is in the current site.
singleLineEmailValidation	singleLineEmailValidation		string	Specifies if single-line email validation is applied.
readonly	readonly		string	Indicates if the column is read-only.
virtualColumn	virtualColumn		integer	Specifies if the column is virtual.
allowInlineEditing	allowInlineEditing		string	Indicates if inline editing is allowed for the column.
sequence	sequence		string	Sequence number of the column.
attributecolumnid	attributecolumnid		string	Attribute column identifier.
value	value		string	Value of raw data.
date	date		string	date of raw data.
time	time		string	Time of raw data.
linkdisplayname	linkdisplayname		string	Display link name.
linkdisplayurl	linkdisplayurl		string	Display URL link.
id	id		string	Lookup ID
email	email		string	Email address.
userlookuptype	userlookuptype		string	User lookup type.
folderid	folderid		string	Folder ID.
docid	docid		string	Document ID.
fromdate	fromdate		string	From date.
todate	todate		string	To date.
file	file		string	The file content.
name	name		string	The name of the attachment.
order	order		string	The order of the attachment.
id	id		integer	Unique identifier for the attachment.
extension	extension		string	File extension.
parentfolderid	parentfolderid		integer	ID of the parent folder.
filehttplink	filehttplink		string	HTTP link to access the file.
folderpath	folderpath		string	Path to the folder containing the file.
folderhttplink	folderhttplink		string	HTTP link to the folder.
filesize	filesize		integer	Size of the file in bytes.
redactionStatus	redactionStatus		boolean	Indicates if the file is redacted.
displayname	displayname		string	Display name of the attachment.
siteid	siteid		integer	ID of the site associated with the attachment.
recordid	recordid		string	Record ID.
linkname	linkname		string	Link name.
apilink	apilink		string	API Link.
httplink	httplink		string	HTTP Link.
colViewPosition	colViewPosition		integer	Position of the column in the view.
columntype	columntype		string	Type of the column.
createdDate	createdDate		date-time	Date and time when the column was created.
modifiedDate	modifiedDate		date-time	Date and time when the column was last modified.
injectReferenceColumn	injectReferenceColumn		integer	Reference to an injected column
parentColumnID	parentColumnID		integer	Identifier of the parent column.
reusecolumnidfromisheet	reusecolumnidfromisheet		integer	Column ID reused from an input sheet.
choicelistid	choicelistid		integer	Identifier for the choice list associated with the column.
alerteroption	alerteroption		string	Alert option setting for the item.
sheettypeid	sheettypeid		integer	Identifier for the sheet type.
enableSmartForm	enableSmartForm		string	Activates smart form features.
allowDeletedItemsView	allowDeletedItemsView		string	Allows viewing of deleted items.
allowAllColumnsInCustomView	allowAllColumnsInCustomView		string	Permits all columns in custom views.

Returns

Body: ProgressiveKeyDBO

Update site

Operation ID:: updateSite

Use this API endpoint to update the details of an existing site. The API supports the same fields used in Create site API.

This method supports multiple matter numbers to add into site using API version 10 onward. "matternos" tag indicates multiple matter numbers with readonly or not.

Version 18 onwards: a categories (site purpose) is required. If the site purpose is hidden, a message is displayed; otherwise, hidden site purposes are not added to the site.

Now site owner can be assigned other users as well, but they must be site participants and have a role higher than site admin.

Version 18 onwards: the site owner can add other users to the site.

From API version 19 onwards, a new module called customPages is introduced, which is tightly coupled with the home module. If the home module value is True, customPages has to be true and vice versa.

Please note, all the properties/elements in get site response are not updatable/insertable. See below table to know which are read only, updatable, or insertable.

Parameters

Name	Key	Required	Type	Description
The version of the API being requested	version	True	string	version of api
The unique identifier for the site	siteid	True	string	The ID for the site
id	id		integer	The site identifier.
sitename	sitename		string	The name of the site.
role	role		string	The role of the site.
sitedescription	sitedescription		string	The description of the site.
enabledmodules	enabledmodules		string	A list of modules enabled for the site.
sitefolderID	sitefolderID		string	The identifier for the site's folder.
sitefolderpermission	sitefolderpermission		string	The permission level for the site's folder.
enable	enable		string	Enable status for HomeDBO.
enable	enable		string	Enable status for ActivityDBO.
microblog	microblog		string	Microblog content associated with ActivityDBO.
docid	docid		string	Document ID.
blogTitle	blogTitle		string	Title of the blog post.
blogContent	blogContent		string	Content of the blog post.
showComment	showComment		integer	show the comment.
tagList	tagList		array of string	List of tags associated with the blog.
status	status		integer	status of the blog post.
siteID	siteID		integer	Identifier for the associated site.
author	author		string	Author of the blog.
categoryList	categoryList		array of string	Categories assigned to the blog post.
notificationTypeID	notificationTypeID		integer	Identifier for the notification type.
message	message		string	Message content related to the blog.
messageCode	messageCode		integer	Code associated with the message.
externalID	externalID		string	External identifier linked to the blog.
publishDate	publishDate		string	Publication date of the blog.
processtype	processtype		string	Process type associated with the blog.
enable	enable		string	Enable status for BlogDBO.
wikiid	wikiid		integer	Unique identifier for the wiki.
currentversionid	currentversionid		integer	Identifier for the current version of the wiki
parentwikiid	parentwikiid		integer	Identifier for the parent wiki.
wikititle	wikititle		string	Title of the wiki.
wikicontent	wikicontent		string	Content of the wiki.
showcomment	showcomment		integer	Indicating if comments are enabled.
createddate	createddate		string	Creation date of the wiki.
modifieddate	modifieddate		string	Last modification date of the wiki.
taglist	taglist		string	Comma-separated list of tags associated with the wiki.
wikipath	wikipath		string	Path to access the wiki.
wikidraftid	wikidraftid		integer	Identifier for the draft version of the wiki.
drafttype	drafttype		string	Type of draft associated with the wiki.
status	status		integer	Current status of the wiki.
wikiversionid	wikiversionid		integer	Version identifier of the wiki.
index	index		string	Index or identifier for the task.
parenttaskid	parenttaskid		integer	Identifier for the parent task.
taskid	taskid		integer	Unique identifier for the task.
title	title		string	Title of the task.
description	description		string	Detailed description of the task.
duedate	duedate		string	Due date for the task completion.
startdate	startdate		string	Start date when the task was initiated.
mattermaptaskid	mattermaptaskid		string	Identifier linking to the matter map task.
type	type		string	Type or category of the task.
dependenton	dependenton		string	Tasks that this task depends on.
daysfromdependent	daysfromdependent		string	Number of days from the dependent task.
ignoreweekend	ignoreweekend		integer	Indicates if weekends are ignored in scheduling.
duration	duration		integer	Duration to complete the task.
resource	resource		string	Resources assigned to the task.
eventTitle	eventTitle		string	Title of the event.
eventContent	eventContent		string	Content of the event.
showComment	showComment		integer	Indicating if comments are enabled for the event.
tagList	tagList		array of string	List of tags associated with the event.
status	status		integer	Current status of the event.
siteID	siteID		integer	Identifier for the site.
contact	contact		string	Contact information for the event.
categoryList	categoryList		array of string	Categories under which the event is listed.
notificationTypeID	notificationTypeID		integer	The notification type related to the event.
message	message		string	The message of the event.
messageCode	messageCode		integer	The message code of the event.
externalID	externalID		string	The external Identifier.
startDate	startDate		string	The start date of the event.
endDate	endDate		string	The end date of the event.
startTime	startTime		string	The start time of the event.
endTime	endTime		string	The end time of the event.
location	location		string	The location of the event.
author	author		string	The author of the event.
processtype	processtype		string	The process time of the event.
enable	enable		string	Enable's the event.
id	id		integer	Unique identifier for the iSheet.
title	title		string	Title of the iSheet.
description	description		string	Description of the isheet.
status	status		string	Status of the isheet.
accesstype	accesstype		string	Access type of the isheet.
type	type		string	Type of the isheet.
viewlink	viewlink		string	Link to view the iSheet.
allowsections	allowsections		string	Whether sections are allowed.
allowlookup	allowlookup		string	Whether lookup fields are enabled.
displayisheet	displayisheet		string	Display options for the iSheet.
searchasdefaultview	searchasdefaultview		string	Indicates if search is default view.
enableversion	enableversion		string	Versioning enabled flag.
enablesheetalerter	enablesheetalerter		string	Flag to enable sheet alerts.
alertercondition	alertercondition		string	Conditions for triggering alerts.
overrideitemmodifieddate	overrideitemmodifieddate		string	Override modified date flag.
enablebulkinsertupdate	enablebulkinsertupdate		string	Enable bulk insert/update.
fielddescriptions	fielddescriptions		string	Field descriptions for the iSheet.
enablerowlocking	enablerowlocking		string	Enable row-level locking.
setcharlimittruncatemultilinetextenabled	setcharlimittruncatemultilinetextenabled		string	Truncate multiline text flag.
setcharlimittruncatemultilinetextval	setcharlimittruncatemultilinetextval		string	Character limit for multiline truncation.
allowchoicelistvaluesforreuse	allowchoicelistvaluesforreuse		string	Allow reuse of choice list values.
allowscorelistvaluesforreuse	allowscorelistvaluesforreuse		string	Allow reuse of score list values.
allowIsheetComments	allowIsheetComments		string	Allow comments in iSheet.
shareRecordsLimit	shareRecordsLimit		integer	Limit of records allowed to share.
shareRecordsLimitEnabled	shareRecordsLimitEnabled		integer	Enabled records share limit.
enableIsheetAddRecordFormSharing	enableIsheetAddRecordFormSharing		string	Enable form sharing for adding records.
recordcount	recordcount		string	Current record count.
sheettypeid	sheettypeid		integer	Type ID of the iSheet
enable	enable		string	Enable QA functionality.
userid	userid		integer	User ID.
email	email		string	email address.
httpavatar	httpavatar		string	HTTP URL of avatar.
avatar	avatar		string	Avatar image.
userlink	userlink		string	Link to user profile.
httplink	httplink		string	HTTP link to user profile.
phone	phone		string	Phone Number.
mobile	mobile		string	Mobile Number.
department	department		string	User's department.
enable	enable		string	Enable Contract Express integration.
adminnote	adminnote		string	Administrative notes related to the site.
startdate	startdate		string	The start date of the site's operation.
enddate	enddate		string	The end date of the site's operation.
createddate	createddate		string	The date when the site was created.
archiveddate	archiveddate		string	The date when the site was archived.
clientno	clientno		string	The client number associated with the site.
matterno	matterno		string	The matter number associated with the site.
landingpage	landingpage		string	The landing page URL for the site.
link	link		string	A link related to the site.
status	status		string	The current status of the site.
statusid	statusid		integer	The identifier for the site's status.
size	size		string	The size of the site.
billingnotes	billingnotes		string	Notes related to billing for the site.
billingnextinvoicedate	billingnextinvoicedate		string	The date of the next invoice for the site.
billinglastinvoicedate	billinglastinvoicedate		string	The date of the last invoice for the site.
filepagecount	filepagecount		string	The total page count of files on the site.
maxpagecount	maxpagecount		string	The maximum allowed page count for files on the site.
sitehttplink	sitehttplink		string	The HTTP link to the site.
isSyncable	isSyncable		integer	Indicates if the site is syncable.
enforceusergroups	enforceusergroups		string	The user groups enforced for the site.
csvSiteCategory	csvSiteCategory		string	The category of the site in CSV format.
siteNameInDefaultLanguage	siteNameInDefaultLanguage		string	The name of the site in the default language.
visible	visible		integer	Indicates if the site is visible.
siteLogoName	siteLogoName		string	The name of the site's logo file.
siteLogoFileSize	siteLogoFileSize		integer	The file size of the site's logo.
siteLogoHeight	siteLogoHeight		integer	The height of the site's logo.
siteLogoWidth	siteLogoWidth		integer	The width of the site's logo.
siteStatus	siteStatus		integer	The status code of the site.
applySiteTerms	applySiteTerms		integer	Indicates if site terms are applied.
siteTerm	siteTerm		string	The terms applied to the site.
termType	termType		integer	The type of terms applied to the site.
nextLoginSiteTerms	nextLoginSiteTerms		integer	Indicates if site terms are required on next login.
defaultSiteTermsEnable	defaultSiteTermsEnable		integer	Indicates if default site terms are enabled.
advancedQAPermission	advancedQAPermission		integer	The advanced QA permission level for the site.
isInternal	isInternal		integer	Indicates if the site is internal.
psm	psm		integer	The Product Service Manager identifier.
siteLabelDisplay	siteLabelDisplay		string	The display label for the site.
allowSiteAdministration	allowSiteAdministration		integer	Indicating if site administration is allowed.
siteLevelPasswordEnable	siteLevelPasswordEnable		integer	To enable site-level password protection.
siteLevelPasscodeEnable	siteLevelPasscodeEnable		integer	To enable site-level passcode protection.
passcodeUsingAuthApp	passcodeUsingAuthApp		integer	Indicates if passcode authentication uses an authentication app.
sitePassword	sitePassword		string	The password associated with the site.
ipRestrictionEnable	ipRestrictionEnable		integer	To enable IP restrictions for site access.
availableIP	availableIP		string	Comma-separated list of IP addresses allowed to access the site.
highqDrive	highqDrive		integer	Indicates if HighQ Drive integration is enabled.
applySiteHomePage	applySiteHomePage		integer	To apply a custom home page for the site.
siteHomePage	siteHomePage		string	URL of the custom home page for the site.
siteHomePageType	siteHomePageType		integer	Type of the home page.
nextLoginSiteHomePage	nextLoginSiteHomePage		integer	To set the next login to the site home page.
applyDisplayContent	applyDisplayContent		integer	To apply display content settings.
displayContent	displayContent		string	Content to display on the site.
rssSecurity	rssSecurity		integer	RSS feed security level.
encryptedPassword	encryptedPassword		integer	Indicates if the site password is encrypted.
availableIPRangeCSV	availableIPRangeCSV		string	Comma-separated list of IP address ranges allowed to access the site.
siteModuleID	siteModuleID		integer	Identifier for the site module.
icalSecurity	icalSecurity		integer	iCal feed security level.
defaultDisplayContent	defaultDisplayContent		string	Default content to display on the site.
defaultEmailAlert	defaultEmailAlert		integer	To enable default email alerts.
excelReportFooter	excelReportFooter		integer	Includes a footer in Excel reports.
excelReportFooterText	excelReportFooterText		string	Text to display in the footer of Excel reports.
announcementMLJSON	announcementMLJSON		string	JSON-formatted announcements for the site.
templateType	templateType		integer	Type of template used for the site.
templateLicence	templateLicence		integer	License type for the site template.
openChannelAppID	openChannelAppID		string	Application ID for the open channel integration.
itemid	itemid		integer	Identifier for the item associated with the site.
sitemetadatasheetid	sitemetadatasheetid		integer	ID of the metadata sheet associated with the site.
mysite	mysite		boolean	Indicates if this is the user's personal site.
lastaccesseddate	lastaccesseddate		string	Date and time when the site was last accessed.
defaultViewerMetaDataTab	defaultViewerMetaDataTab		integer	Default metadata tab for the site viewer.
documentMetadataViewId	documentMetadataViewId		integer	document metadata for view identifier.
folderMetadataViewId	folderMetadataViewId		integer	folder metadata for view identifier.
docSort	docSort		integer	The sorting order of documents.
folderSort	folderSort		integer	The sorting order of folders.
defaultFolderRenderView	defaultFolderRenderView		integer	Determines the default view mode for folders.
isTaskAttachmentDefault	isTaskAttachmentDefault		integer	The default location for task attachments.
taskAttachmentDefaultFolderId	taskAttachmentDefaultFolderId		integer	The unique identifier of the folder designated as the default location for task attachments.
favourite	favourite		string	favourite status.
enabledocumentredaction	enabledocumentredaction		boolean	Specifies whether document redaction is enabled for the site.
mentiongroups	mentiongroups		integer	The mentioned groups.
enablefilerelationships	enablefilerelationships		boolean	Indicates whether file relationships are enabled.
filerelationshipsitepermissionlevel	filerelationshipsitepermissionlevel		integer	The permission level required to manage file relationships.

Update site group

Operation ID:: updateSiteGroup

This API method updates the name of an existing group in a site.
This API has been extended to update the name of an existing basic user group in a site.

Parameters

Name	Key	Required	Type	Description
API Version	version	True	string	version
The ID of the site	siteid	True	string	The ID of the site.
API Version	groupid	True	string	`The ID of the site group.`
name	name		string
id	id		integer
copypermissionsfrom	copypermissionsfrom		string
message	message		string
typeID	typeID		integer
type	type		string
numberofusers	numberofusers		string
created	created		string
modified	modified		string
systemGroupID	systemGroupID		integer
description	description		string
basicusergroup	basicusergroup		integer

Returns

Body: sitegroup

Upload a file

Operation ID:: insertDocument

This API call uploads a file to a specified folder on the HighQ Collaborate platform. It supports chunked uploads when the Content-Range header is provided.

Parameters

Name	Key	Required	Type	Description
API Version	version	True	string	Specifies the version of the API being used.
File to Upload	file	True	file	Specifies the file to be uploaded.
Parent Folder ID	parentfolderid	True	string	Specifies the unique ID of the parent folder where the file will be uploaded.
Override Duplicate Flag	overrideduplicate		boolean	Indicates whether duplicate file uploads should be overridden.
Document Name	filename	True	string	Specifies the name of the document.
Version Note	versionnote		string	Provides a note describing the version of the file.
Progressive Operation Key	progressiveoperkey		string	Specifies the key used for progressive operations during the file upload.
DMS Database Name	dmsdatabasename		string	Specifies the name of the Document Management System database.
DMS Edit Date	dmseditdate		string	Specifies the edit date recorded in the Document Management System.
DMS Parent Folder ID	dmsparentfolderid		string	Specifies the unique ID of the parent folder in the Document Management System.
DMS Document ID	dmsdocid		string	Specifies the unique ID of the document in the Document Management System.
DMS Document Version	dmsversion		string	Specifies the version of the document recorded in the Document Management System.
Notification Details	notification		string	Provides details regarding any notifications to be sent upon file upload.
Batch ID	batchid		string	Specifies the unique ID of the batch operation.
Root Folder ID	rootfolderid		string	Specifies the unique ID of the root folder.

Definitions

ErrorDBO

Name	Path	Type
summary	summary	string
ref	ref	string
link	link	string

DocumentDBO

Name	Path	Type	Description
docid	docid	string	Document ID.

columns

Name	Path	Type	Description
column	column	array of object
items	column	object

LocationDBO

Name	Path	Type	Description
addressline1	addressline1	string	First line of the address.
addressline2	addressline2	string	Second line of the address.
addressline3	addressline3	string	Third line of the address.
city	city	string	City of the address.
state	state	string	State of the address.
country	country	string	Country of the address.
postcode	postcode	string	Postal code of the address.

UserName

Name	Path	Type	Description
title	title	string	Title of the user.
firstname	firstname	string	First name of the user.
lastname	lastname	string	Last name of the user.
goesby	goesby	string	preferred name of the user.

MetadataListDBO

Name	Path	Type	Description
metadataname	metadataname	array of string
metadatavalue	metadatavalue	array of string

NameValueLink

Name	Path	Type	Description
id	id	string	Link ID
name	name	string	Link Name.
value	value	string	Link Value.

Link

Name	Path	Type	Description
link	link	array of NameValueLink

ExperiencesDBO

Name	Path	Type	Description
experience	experience	array of string

GroupsDBO

Name	Path	Type	Description
group	group	array of string

user

Name	Path	Type	Description
userid	userid	integer	User ID.
following	following	boolean	Following.
email	email	string	Email Address.
name	name	UserName
userlink	userlink	string	User Link.
httplink	httplink	string	HTTP Link.
httpavatar	httpavatar	string	HTTP Avatar.
avatar	avatar	integer	Avatar of user.
externalid	externalid	string	External ID.
dateofbirth	dateofbirth	string	Date Of Birth.
phone	phone	string	Phone Number.
jobtitle	jobtitle	string	Job Title.
mobile	mobile	string	Mobile Number.
department	department	string	Deparment.
status	status	string	Status.
org	org	string	Organization.
orgName	orgName	string	Organization Name.
location	location	LocationDBO
img	img	string	Image.
experiences	experiences	ExperiencesDBO
sociallinks	sociallinks	Link
customlink	customlink	Link
messaginglink	messaginglink	Link
secretaryname	secretaryname	string	Secretary Name.
secretarymail	secretarymail	string	Secretary Mail.
bio	bio	string	Biography of the user.
sourcetype	sourcetype	string	Source Type.
specialities	specialities	string	Specialities.
reportsto	reportsto	string	User the current user reports to.
metadata	metadata	MetadataListDBO
groups	groups	GroupsDBO
suffix	suffix	string	Suffix of the user's name.
atomlink	atomlink	string	Atom link associated with the user.
link	link	string	Link associated with the user.
loggeduserlike	loggeduserlike	integer	Count of likes from the logged-in user.
userName	userName	string	User Name.

users

Name	Path	Type	Description
user	user	array of user

FolderDBOV1

Name	Path	Type	Description
folderid	folderid	string	The unique identifier of the created folder.

DmsDBO

Name	Path	Type	Description
dmsfolderid	dmsfolderid	string	The DMS folder identifier.
dmsParentFolderID	dmsParentFolderID	string	The DMS parent folder identifier.
dmscreateddate	dmscreateddate	date-time	The date the DMS folder was created.
dmsmodifiedBy	dmsmodifiedBy	string	The user who last modified the DMS folder.
dmsdatabasename	dmsdatabasename	string	The name of the DMS database.
dmslink	dmslink	boolean	Indicates whether a DMS link is available.
dmslinkby	dmslinkby	string	The user who linked the DMS folder.

sitegroup

Name	Path	Type
name	name	string
id	id	integer
copypermissionsfrom	copypermissionsfrom	string
message	message	string
typeID	typeID	integer
type	type	string
numberofusers	numberofusers	string
created	created	string
modified	modified	string
systemGroupID	systemGroupID	integer
description	description	string
basicusergroup	basicusergroup	integer

Address

Name	Path	Type	Description
addressid	addressid	string	Unique identifier for the address.
addressline1	addressline1	string	First line of the address.
addressline2	addressline2	string	Second line of the address.
addressline3	addressline3	string	Third line of the address.
city	city	string	City of the address.
state	state	string	State of the address.
country	country	string	Country of the address.
postCode	postCode	string	Postal code of the address.
knownas	knownas	string	Alternative name or nickname for the address.

IntegrationUserDBO

Name	Path	Type	Description
index	index	integer	Unique index for the user.
userid	userid	integer	Unique identifier for the user.
firstname	firstname	string	First name of the user.
lastname	lastname	string	Last name of the user.
practicegroup	practicegroup	string	Practice group the user belongs to.
langcode	langcode	string	Language code of the user.
localeID	localeID	string	Locale ID of the user.
publicprofile	publicprofile	string	Public profile of the user.
pwpid	pwpid	string	PWP ID of the user.
usertypeid	usertypeid	string	User type ID.
systemuser	systemuser	string	System user flag.
email	email	string	Email address of the user.
phone	phone	string	Phone number of the user.
mobile	mobile	string	Mobile number of the user.
department	department	string	Department of the user.
org	org	string	Organization the user belongs to.
location	location	LocationDBO
address	address	Address
experiences	experiences	ExperiencesDBO
sociallinks	sociallinks	Link
messaginglink	messaginglink	Link
customlink	customlink	Link
img	img	string
reportsto	reportsto	string
metadata	metadata	MetadataListDBO
groups	groups	GroupsDBO
externalid	externalid	string	External ID of the user.
jobtitle	jobtitle	string	Job title of the user.
secretaryname	secretaryname	string	Name of the user's secretary.
secretarymail	secretarymail	string	Email of the user's secretary.
specialities	specialities	string	Specialities of the user.
title	title	string	Title of the user.
goesby	goesby	string	preferred name of the user.
suffix	suffix	string	Suffix of the user's name.
atomlink	atomlink	string	Atom link associated with the user.
bio	bio	string	Biography of the user.
dateOfBirth	dateOfBirth	string	Date of birth of the user.
link	link	string	Link associated with the user.
status	status	string	Status of the user.
statuscode	statuscode	string	Status code of the user.
message	message	string	Message associated with the user.
sourcetype	sourcetype	string	Source type of the user.
orgid	orgid	string	Organization ID.
ifpartner	ifpartner	string	Partner flag.
emaildomain	emaildomain	string	Email domain of the user.
invitationsent	invitationsent	string	Invitation sent flag.
createdby	createdby	string	User who created the record.
createddate	createddate	string	Date the record was created.
modifiedby	modifiedby	string	User who modified the record.
modifieddate	modifieddate	string	Date the record was modified.
lastlogindate	lastlogindate	string	Date of the last login.
invalidlogins	invalidlogins	string	Count of invalid login attempts.
publicwebsiteprofileid	publicwebsiteprofileid	string	Public website profile ID.
resetpassworddate	resetpassworddate	string	Date the password was reset.
avatar	avatar	string	Avatar image URL.
followingcount	followingcount	integer	Count of users being followed.
followercount	followercount	integer	Count of followers.
following	following	boolean	Following flag.
role	role	string	Role of the user.
isbasicuser	isbasicuser	string	Basic user flag.
encryptedUserId	encryptedUserId	string	Encrypted user ID.
selfregistered	selfregistered	integer	Self-registered flag.
registeredWith2FA	registeredWith2FA	string	Two-factor authentication registration flag.
isInternal	isInternal	integer	Internal user flag.
orgName	orgName	string	Name of the organization.

site

Name	Path	Type	Description
id	id	integer	The site identifier.
sitename	sitename	string	The name of the site.
role	role	string	The role of the site.
sitedescription	sitedescription	string	The description of the site.
enabledmodules	enabledmodules	string	A list of modules enabled for the site.
sitefolderID	sitefolderID	string	The identifier for the site's folder.
sitefolderpermission	sitefolderpermission	string	The permission level for the site's folder.
module	module	ModuleDBO
adminnote	adminnote	string	Administrative notes related to the site.
startdate	startdate	string	The start date of the site's operation.
enddate	enddate	string	The end date of the site's operation.
createddate	createddate	string	The date when the site was created.
archiveddate	archiveddate	string	The date when the site was archived.
clientno	clientno	string	The client number associated with the site.
matterno	matterno	string	The matter number associated with the site.
landingpage	landingpage	string	The landing page URL for the site.
link	link	string	A link related to the site.
status	status	string	The current status of the site.
statusid	statusid	integer	The identifier for the site's status.
size	size	string	The size of the site.
billingnotes	billingnotes	string	Notes related to billing for the site.
billingnextinvoicedate	billingnextinvoicedate	string	The date of the next invoice for the site.
billinglastinvoicedate	billinglastinvoicedate	string	The date of the last invoice for the site.
filepagecount	filepagecount	string	The total page count of files on the site.
maxpagecount	maxpagecount	string	The maximum allowed page count for files on the site.
sitehttplink	sitehttplink	string	The HTTP link to the site.
isSyncable	isSyncable	integer	Indicates if the site is syncable.
enforceusergroups	enforceusergroups	string	The user groups enforced for the site.
csvSiteCategory	csvSiteCategory	string	The category of the site in CSV format.
siteNameInDefaultLanguage	siteNameInDefaultLanguage	string	The name of the site in the default language.
visible	visible	integer	Indicates if the site is visible.
siteLogoName	siteLogoName	string	The name of the site's logo file.
siteLogoFileSize	siteLogoFileSize	integer	The file size of the site's logo.
siteLogoHeight	siteLogoHeight	integer	The height of the site's logo.
siteLogoWidth	siteLogoWidth	integer	The width of the site's logo.
siteStatus	siteStatus	integer	The status code of the site.
applySiteTerms	applySiteTerms	integer	Indicates if site terms are applied.
siteTerm	siteTerm	string	The terms applied to the site.
termType	termType	integer	The type of terms applied to the site.
nextLoginSiteTerms	nextLoginSiteTerms	integer	Indicates if site terms are required on next login.
defaultSiteTermsEnable	defaultSiteTermsEnable	integer	Indicates if default site terms are enabled.
advancedQAPermission	advancedQAPermission	integer	The advanced QA permission level for the site.
isInternal	isInternal	integer	Indicates if the site is internal.
psm	psm	integer	The Product Service Manager identifier.
siteLabelDisplay	siteLabelDisplay	string	The display label for the site.
allowSiteAdministration	allowSiteAdministration	integer	Indicating if site administration is allowed.
siteLevelPasswordEnable	siteLevelPasswordEnable	integer	To enable site-level password protection.
siteLevelPasscodeEnable	siteLevelPasscodeEnable	integer	To enable site-level passcode protection.
passcodeUsingAuthApp	passcodeUsingAuthApp	integer	Indicates if passcode authentication uses an authentication app.
sitePassword	sitePassword	string	The password associated with the site.
ipRestrictionEnable	ipRestrictionEnable	integer	To enable IP restrictions for site access.
availableIP	availableIP	string	Comma-separated list of IP addresses allowed to access the site.
highqDrive	highqDrive	integer	Indicates if HighQ Drive integration is enabled.
applySiteHomePage	applySiteHomePage	integer	To apply a custom home page for the site.
siteHomePage	siteHomePage	string	URL of the custom home page for the site.
siteHomePageType	siteHomePageType	integer	Type of the home page.
nextLoginSiteHomePage	nextLoginSiteHomePage	integer	To set the next login to the site home page.
applyDisplayContent	applyDisplayContent	integer	To apply display content settings.
displayContent	displayContent	string	Content to display on the site.
rssSecurity	rssSecurity	integer	RSS feed security level.
encryptedPassword	encryptedPassword	integer	Indicates if the site password is encrypted.
availableIPRangeCSV	availableIPRangeCSV	string	Comma-separated list of IP address ranges allowed to access the site.
siteModuleID	siteModuleID	integer	Identifier for the site module.
icalSecurity	icalSecurity	integer	iCal feed security level.
defaultDisplayContent	defaultDisplayContent	string	Default content to display on the site.
defaultEmailAlert	defaultEmailAlert	integer	To enable default email alerts.
excelReportFooter	excelReportFooter	integer	Includes a footer in Excel reports.
excelReportFooterText	excelReportFooterText	string	Text to display in the footer of Excel reports.
announcementMLJSON	announcementMLJSON	string	JSON-formatted announcements for the site.
templateType	templateType	integer	Type of template used for the site.
templateLicence	templateLicence	integer	License type for the site template.
openChannelAppID	openChannelAppID	string	Application ID for the open channel integration.
itemid	itemid	integer	Identifier for the item associated with the site.
sitemetadatasheetid	sitemetadatasheetid	integer	ID of the metadata sheet associated with the site.
mysite	mysite	boolean	Indicates if this is the user's personal site.
lastaccesseddate	lastaccesseddate	string	Date and time when the site was last accessed.
defaultViewerMetaDataTab	defaultViewerMetaDataTab	integer	Default metadata tab for the site viewer.
documentMetadataViewId	documentMetadataViewId	integer	document metadata for view identifier.
folderMetadataViewId	folderMetadataViewId	integer	folder metadata for view identifier.
docSort	docSort	integer	The sorting order of documents.
folderSort	folderSort	integer	The sorting order of folders.
defaultFolderRenderView	defaultFolderRenderView	integer	Determines the default view mode for folders.
isTaskAttachmentDefault	isTaskAttachmentDefault	integer	The default location for task attachments.
taskAttachmentDefaultFolderId	taskAttachmentDefaultFolderId	integer	The unique identifier of the folder designated as the default location for task attachments.
favourite	favourite	string	favourite status.
enabledocumentredaction	enabledocumentredaction	boolean	Specifies whether document redaction is enabled for the site.
mentiongroups	mentiongroups	integer	The mentioned groups.
enablefilerelationships	enablefilerelationships	boolean	Indicates whether file relationships are enabled.
filerelationshipsitepermissionlevel	filerelationshipsitepermissionlevel	integer	The permission level required to manage file relationships.

ModuleDBO

Name	Path	Type
home	home	HomeDBO
activity	activity	ActivityDBO
document	document	DocumentDBO
blog	blog	BlogDBO
wiki	wiki	WikiDBO
task	task	TaskDBO
event	event	EventDBO
isheet	isheet	ISheetDBO
qa	qa	QaDBO
people	people	PeopleDBO
contractexpress	contractexpress	ContractExpressDBO

HomeDBO

Name	Path	Type	Description
enable	enable	string	Enable status for HomeDBO.

ActivityDBO

Name	Path	Type	Description
enable	enable	string	Enable status for ActivityDBO.
microblog	microblog	string	Microblog content associated with ActivityDBO.

BlogDBO

Name	Path	Type	Description
blogTitle	blogTitle	string	Title of the blog post.
blogContent	blogContent	string	Content of the blog post.
showComment	showComment	integer	show the comment.
tagList	tagList	array of string	List of tags associated with the blog.
status	status	integer	status of the blog post.
siteID	siteID	integer	Identifier for the associated site.
author	author	string	Author of the blog.
categoryList	categoryList	array of string	Categories assigned to the blog post.
notificationTypeID	notificationTypeID	integer	Identifier for the notification type.
message	message	string	Message content related to the blog.
messageCode	messageCode	integer	Code associated with the message.
externalID	externalID	string	External identifier linked to the blog.
publishDate	publishDate	string	Publication date of the blog.
processtype	processtype	string	Process type associated with the blog.
enable	enable	string	Enable status for BlogDBO.

WikiDBO

Name	Path	Type	Description
wikiid	wikiid	integer	Unique identifier for the wiki.
currentversionid	currentversionid	integer	Identifier for the current version of the wiki
parentwikiid	parentwikiid	integer	Identifier for the parent wiki.
wikititle	wikititle	string	Title of the wiki.
wikicontent	wikicontent	string	Content of the wiki.
showcomment	showcomment	integer	Indicating if comments are enabled.
createddate	createddate	string	Creation date of the wiki.
modifieddate	modifieddate	string	Last modification date of the wiki.
taglist	taglist	string	Comma-separated list of tags associated with the wiki.
wikipath	wikipath	string	Path to access the wiki.
wikidraftid	wikidraftid	integer	Identifier for the draft version of the wiki.
drafttype	drafttype	string	Type of draft associated with the wiki.
status	status	integer	Current status of the wiki.
wikiversionid	wikiversionid	integer	Version identifier of the wiki.

TaskDBO

Name	Path	Type	Description
index	index	string	Index or identifier for the task.
parenttaskid	parenttaskid	integer	Identifier for the parent task.
taskid	taskid	integer	Unique identifier for the task.
title	title	string	Title of the task.
description	description	string	Detailed description of the task.
duedate	duedate	string	Due date for the task completion.
startdate	startdate	string	Start date when the task was initiated.
mattermaptaskid	mattermaptaskid	string	Identifier linking to the matter map task.
type	type	string	Type or category of the task.
dependenton	dependenton	string	Tasks that this task depends on.
daysfromdependent	daysfromdependent	string	Number of days from the dependent task.
ignoreweekend	ignoreweekend	integer	Indicates if weekends are ignored in scheduling.
duration	duration	integer	Duration to complete the task.
resource	resource	string	Resources assigned to the task.

EventDBO

Name	Path	Type	Description
eventTitle	eventTitle	string	Title of the event.
eventContent	eventContent	string	Content of the event.
showComment	showComment	integer	Indicating if comments are enabled for the event.
tagList	tagList	array of string	List of tags associated with the event.
status	status	integer	Current status of the event.
siteID	siteID	integer	Identifier for the site.
contact	contact	string	Contact information for the event.
categoryList	categoryList	array of string	Categories under which the event is listed.
notificationTypeID	notificationTypeID	integer	The notification type related to the event.
message	message	string	The message of the event.
messageCode	messageCode	integer	The message code of the event.
externalID	externalID	string	The external Identifier.
startDate	startDate	string	The start date of the event.
endDate	endDate	string	The end date of the event.
startTime	startTime	string	The start time of the event.
endTime	endTime	string	The end time of the event.
location	location	string	The location of the event.
author	author	string	The author of the event.
processtype	processtype	string	The process time of the event.
enable	enable	string	Enable's the event.

ISheetDBO

Name	Path	Type	Description
id	id	integer	Unique identifier for the iSheet.
title	title	string	Title of the iSheet.
description	description	string	Description of the isheet.
status	status	string	Status of the isheet.
accesstype	accesstype	string	Access type of the isheet.
type	type	string	Type of the isheet.
viewlink	viewlink	string	Link to view the iSheet.
allowsections	allowsections	string	Whether sections are allowed.
allowlookup	allowlookup	string	Whether lookup fields are enabled.
displayisheet	displayisheet	string	Display options for the iSheet.
searchasdefaultview	searchasdefaultview	string	Indicates if search is default view.
enableversion	enableversion	string	Versioning enabled flag.
enablesheetalerter	enablesheetalerter	string	Flag to enable sheet alerts.
alertercondition	alertercondition	string	Conditions for triggering alerts.
overrideitemmodifieddate	overrideitemmodifieddate	string	Override modified date flag.
enablebulkinsertupdate	enablebulkinsertupdate	string	Enable bulk insert/update.
fielddescriptions	fielddescriptions	string	Field descriptions for the iSheet.
enablerowlocking	enablerowlocking	string	Enable row-level locking.
setcharlimittruncatemultilinetextenabled	setcharlimittruncatemultilinetextenabled	string	Truncate multiline text flag.
setcharlimittruncatemultilinetextval	setcharlimittruncatemultilinetextval	string	Character limit for multiline truncation.
allowchoicelistvaluesforreuse	allowchoicelistvaluesforreuse	string	Allow reuse of choice list values.
allowscorelistvaluesforreuse	allowscorelistvaluesforreuse	string	Allow reuse of score list values.
allowIsheetComments	allowIsheetComments	string	Allow comments in iSheet.
shareRecordsLimit	shareRecordsLimit	integer	Limit of records allowed to share.
shareRecordsLimitEnabled	shareRecordsLimitEnabled	integer	Enabled records share limit.
enableIsheetAddRecordFormSharing	enableIsheetAddRecordFormSharing	string	Enable form sharing for adding records.
recordcount	recordcount	string	Current record count.
sheettypeid	sheettypeid	integer	Type ID of the iSheet

QaDBO

Name	Path	Type	Description
enable	enable	string	Enable QA functionality.

PeopleDBO

Name	Path	Type	Description
person	person	array of PersonDBO

PersonDBO

Name	Path	Type	Description
userid	userid	integer	User ID.
email	email	string	email address.
httpavatar	httpavatar	string	HTTP URL of avatar.
avatar	avatar	string	Avatar image.
userlink	userlink	string	Link to user profile.
httplink	httplink	string	HTTP link to user profile.
phone	phone	string	Phone Number.
mobile	mobile	string	Mobile Number.
department	department	string	User's department.

ContractExpressDBO

Name	Path	Type	Description
enable	enable	string	Enable Contract Express integration.

FolderDBOV2

Name	Path	Type	Description
name	name	string	Folder name.
description	description	string	Folder description.
parentFolderID	parentFolderID	integer	Parent folder ID.
accessInherited	accessInherited	integer	Access Inheritance status.
batchID	batchID	string	Batch Identifier
dms	dms	DmsDBO
id	id	integer	Folder ID.
link	link	string	Folder Link.
createddate	createddate	string	Creation date.
modifieddate	modifieddate	string	Modified date.
child	child	integer	Child folders.
filecount	filecount	integer	Number of files.
createdby	createdby	UserDBO
modifiedby	modifiedby	UserDBO
folderid	folderid	integer	Folder ID.
dmsfolderid	dmsfolderid	string	DMS folder Identifier.
siteid	siteid	integer	Site ID
location	location	string	Folder location.
permission	permission	PermissionDBO
contentstatus	contentstatus	integer	Content status.
autonumbering	autonumbering	string	Auto numbering configuration.
foldersize	foldersize	string	Folder size.
sharedstatus	sharedstatus	integer	Sharing status.
favouritestatus	favouritestatus	integer	Favourite status.
foldertype	foldertype	string	Folder type.
itemId	itemId	integer	Item ID.
folderMetadataSheetId	folderMetadataSheetId	integer	Folder metadata of sheet ID.

UserDBO

Name	Path	Type	Description
firstname	firstname	string	First name.
lastname	lastname	string	Last name.
email	email	string	Email address.
userid	userid	integer	User ID.

PermissionDBO

Name	Path	Type	Description
view	view	integer	View Permission.
edit	edit	integer	Edit Permission.
delete	delete	integer	Delete Permission.
addEditAllFiles	addEditAllFiles	integer	Add/Edit All Files Permission.
admin	admin	integer	Admin Permission.
viewAllFiles	viewAllFiles	integer	View all files Permission.
disableSave	disableSave	integer	disable save Permission.
uploadFile	uploadFile	integer	upload file Permission.
updateFile	updateFile	integer	update file Permission.
deleteFile	deleteFile	integer	Delete file Permission.

ProgressiveKeyDBO

Name	Path	Type	Description
progressivekey	progressivekey	string	Key for progressive operations.
siteid	siteid	integer	Identifier for the site.
progressivekeystatus	progressivekeystatus	string	Status of the progressive key.
userid	userid	integer	Identifier for the user.
responsebody	responsebody	string	Body of the response.
message	message	string	Message content.
messagecode	messagecode	string	Code associated with the message.
integrationResponseDBO	integrationResponseDBO	IntegrationResponseDBO
columns	columns	ColumnErrorsDBO
items	items	ItemErrorsDBO
importisheettemplate	importisheettemplate	importISheetTemplateDBO
error	error	ErrorDBO
contentType	contentType	string	Type of content.
failedEntities	failedEntities	integer	Number of failed entities.
downloadlink	downloadlink	string	Link to download content.
attachment	attachment	Attachment
link	link	string	Associated link.
documentid	documentid	integer	Identifier for the document.
progresskey	progresskey	string	Progress key for tracking.
progresskeystatus	progresskeystatus	string	Status of the progress key.

IntegrationResponseDBO

Name	Path	Type	Description
integrationResponseUsersObject	integrationResponseUsersObject	IntegrationResponseUsersObject
failedEntities	failedEntities	integer	Number of entities that failed processing.
successEntities	successEntities	integer	Number of entities that were successfully processed.

IntegrationResponseUsersObject

Name	Path	Type	Description
user	user	array of IntegrationUserDBO

ColumnErrorsDBO

Name	Path	Type	Description
column	column	array of ColumnErrorDBO
failedEntities	failedEntities	integer	Number of entities that failed due to column errors.
successEntities	successEntities	integer	Number of entities that were successfully processed.

ColumnErrorDBO

Name	Path	Type	Description
index	index	integer	Index position of the column with error.
columnid	columnid	integer	Unique identifier of the column with error.
name	name	string	Name of the column with error.
status	status	string	Status indicating the error condition.
statuscode	statuscode	string	Code representing the error status.
message	message	string	Detailed error message.

ItemErrorsDBO

Name	Path	Type	Description
item	item	array of ItemErrorDBO
failedEntities	failedEntities	integer	Number of entities that failed due to item errors.
successEntities	successEntities	integer	Number of entities that were successfully processed despite item errors.

ItemErrorDBO

Name	Path	Type	Description
index	index	integer	Index position of the item with error.
columns	columns	ColumnErrorsDBO
itemid	itemid	string	Unique identifier of the item with error.
externalid	externalid	string	External identifier associated with the item.
id	id	string	Internal identifier of the item.
name	name	string	Name of the item with error.
status	status	string	Status indicating the error condition.
statuscode	statuscode	string	Code representing the error status.
message	message	string	Detailed error message.
successdeletedcount	successdeletedcount	integer	Count of successfully deleted entities.
failurecount	failurecount	integer	Count of entities that failed processing.
failedEntities	failedEntities	integer	Number of entities that failed due to item errors.
successEntities	successEntities	integer	Number of entities that were successfully processed.

importISheetTemplateDBO

Name	Path	Type	Description
linkedtemplateid	linkedtemplateid	integer	Identifier of the linked template.
aliasname	aliasname	string	Alias name for the template.
linkedisheet	linkedisheet	string	Identifier of the linked input sheet.
importdata	importdata	string	Data to be imported from the template.
appendisheetname	appendisheetname	string	Name of the sheet to append data to.
templateparametergroups	templateparametergroups	ISheetTemplateParameterGroups
templateSheetIdMap	templateSheetIdMap	object
templateId	templateId	integer	Identifier of the template.
templateTitle	templateTitle	string	Title of the template.
viewIDs	viewIDs	string	Comma-separated list of view IDs.

ISheetTemplateParameterGroups

Name	Path	Type	Description
templateparametergroup	templateparametergroup	array of ISheetTemplateParameterGroup

ISheetTemplateParameterGroup

Name	Path	Type	Description
templateruleid	templateruleid	integer	Isheet Template Parameter Group.
templateparameter	templateparameter	array of ISheetTemplateParameter

ISheetTemplateParameter

Name	Path	Type	Description
id	id	integer	Identifier of the isheet template parameter.
name	name	string	Name of the isheet template parameter.
data	data	string	data of the isheet template parameter.

Attachment

Name	Path	Type	Description
file	file	string	The file content.
name	name	string	The name of the attachment.
order	order	string	The order of the attachment.
id	id	integer	Unique identifier for the attachment.
extension	extension	string	File extension.
parentfolderid	parentfolderid	integer	ID of the parent folder.
filehttplink	filehttplink	string	HTTP link to access the file.
folderpath	folderpath	string	Path to the folder containing the file.
folderhttplink	folderhttplink	string	HTTP link to the folder.
filesize	filesize	integer	Size of the file in bytes.
redactionStatus	redactionStatus	boolean	Indicates if the file is redacted.
displayname	displayname	string	Display name of the attachment.
siteid	siteid	integer	ID of the site associated with the attachment.

Share via

HighQ (Preview)

HighQ

Overview

Authentication

Connector Operations

ISheet Module

Document Resource APIs

ISheet Admin API

User Operations

Document and Site Management

Getting Started

Parameters and Settings

Troubleshooting and Limitations

Additional Resources

Licensing and Support

Throttling Limits

Actions

Add existing group to site

Parameters

Returns

Add site

Parameters

Returns

Add User

Parameters

Returns

Archive User

Parameters

Create Folder

Parameters

Returns

Get folder info

Parameters

Returns

Move Documents

Parameters

Retrieve a list of folders

Parameters

Returns

Retrieve a list of iSheet items

Parameters

Returns

Retrieve file information

Parameters

Returns

Retrieve iSheet columns

Parameters

Returns

Retrieve user list

Parameters

Returns

To create the iSheet item

Parameters

Returns

Update site

Parameters

Update site group

Parameters

Returns

Upload a file

Parameters

Definitions

ErrorDBO

DocumentDBO

columns

LocationDBO

UserName

MetadataListDBO

NameValueLink

Link

ExperiencesDBO

GroupsDBO

user

users

FolderDBOV1

DmsDBO

sitegroup

Address

IntegrationUserDBO