This API method can be used to obtain a collection of activity items. The activity is based on a specific filter.
\r\nBy default the activity of the authenticated OAuth token are used to provide the activity, however if the OAuth token user has got administrative rights they are able to obtain activity on behalf of other users.
\r\nThe type of activity returned can be altered by the filter parameters.
\r\nActor: A person that performs the activity (user object)
\r\nVerb : The activities verb, which indicates what action was performed
\r\nObject: The object of the activity
\r\nIn the above activity description, \"Mark\" is the actor, \"posted\" is the verb and \"wiki page\" is the object.
\r\nFor System Admin (scope can be all or it can be the sites they are a member of)
The API supports filtering by multiple content types from Collaborate 4.1.4 onwards.
\r\nfor example, to get activity by three content types use the following syntax.
\r\ncontenttype=files,events,tasks
","required":false,"type":"string"},{"name":"groupsupport","in":"query","description":"groupsupport flag for share with groups.","required":false,"type":"string","default":"0"},{"name":"offset","in":"query","description":"The no of the last activity fetched","required":false,"type":"string"},{"name":"limit","in":"query","description":"No of items to return. Default is 20 (Max is 100 , Activity up to a maximum of 3 months can be provided)","required":false,"type":"string"}],"responses":{"201":{"description":"Activity returned successfully","schema":{"$ref":"#/definitions/Activities"}},"400":{"description":"Problem with parameters"},"401":{"description":"Unauthorised"},"403":{"description":"Validation failed | Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"500":{"description":"Internal error occurred while getting activity list"}},"security":[{"OAuth":[]}]}},"/{version}/attachments":{"get":{"tags":["Attachment API"],"summary":"Get all attachments","description":"This method is used to get a list of attachment of a Collaborate content item. Please note this method does not apply to iSheet attachments and Q&A attachments, as attachments to those modules are managed separately within the context of those modules.","operationId":"getAllAttachments","produces":["application/xml","application/json","text/xml"],"parameters":[{"name":"version","in":"path","description":"version of api","required":true,"type":"string","default":"4"},{"name":"contenttype","in":"query","description":"Content type allows below options: \r\n- Microblogs\r\n- Wiki\r\n- Blog\r\n- Tasks\r\n- Events\r\n- Comments\r\n- Messages","required":true,"type":"string"},{"name":"contentid","in":"query","description":"This the content id of the required content.| Name | Type | Description |
|---|---|---|
| progressive_key | String | Key to check the status of your action. |
<attachment>
<id>101</id>
</attachment>Copy a file from one location to another. In case of a copy operation the target folder can be a folder in another site.
While copying the file, the version history and permissions will not be copied over, but the permissions for the new folder to which the file is being moved is going to be applied to the copied file.
API method to get a single file info from Collaborate.","operationId":"getDocumentInfo","produces":["application/xml","application/json"],"parameters":[{"name":"version","in":"path","description":"version of api","required":true,"type":"string","default":"1"},{"name":"fileid","in":"path","description":"The ID of file to get Info","required":true,"type":"string"},{"name":"lastdmsinfo","in":"query","description":"Last DMS info (true/false)","required":false,"type":"boolean"},{"name":"foldertype","in":"query","description":"Folder type","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DocumentDBO"}},"401":{"description":"Unauthorized"},"403":{"description":"Validation failed/ Forbidden"},"405":{"description":"Method not allowed (calling api with wrong method)"},"500":{"description":"Internal error","schema":{"$ref":"#/definitions/ErrorDBO"}}},"security":[{"OAuth":[]}]},"put":{"tags":["Document Resource APIs"],"summary":"Update file","description":"This api is used for update file.","operationId":"updateDocument","consumes":["text/plain","application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"version","in":"path","description":"version of api","required":true,"type":"string","default":"1"},{"name":"fileid","in":"path","description":"file ID","required":true,"type":"string"},{"name":"rootfolderid","in":"query","description":"Root folder ID","required":false,"type":"string"},{"name":"batchid","in":"query","description":"Batch ID","required":false,"type":"string"},{"name":"foldertype","in":"query","description":"Folder type","required":false,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/DocumentDBO"}}],"responses":{"200":{"description":"Document updated successfully."},"401":{"description":"Unauthorized"},"403":{"description":"Validation failed/ Forbidden"},"405":{"description":"Method not allowed (calling api with wrong method)"},"500":{"description":"Internal error occured while updating document","schema":{"$ref":"#/definitions/ErrorDBO"}}},"security":[{"OAuth":[]}]},"delete":{"tags":["Document Resource APIs"],"summary":"Delete file","description":"This API deletes a file from a Collaborate Site and places it in the recycle bin. The documents being deleted should be an active document in a site.","operationId":"deleteDocument","produces":["application/xml","application/json"],"parameters":[{"name":"version","in":"path","description":"version of api","required":true,"type":"string","default":"1"},{"name":"fileid","in":"path","description":"The {fileid} is the Id of the file which is to be deleted.","required":true,"type":"string"},{"name":"foldertype","in":"query","description":"Folder type","required":false,"type":"string"}],"responses":{"200":{"description":"File/Document deleted successfully."},"204":{"description":"File/Document deleted successfully."},"401":{"description":"Unauthorized"},"405":{"description":"Method not allowed (calling api with wrong method)"}},"security":[{"OAuth":[]}]}},"/{version}/sites/{siteid}/batchid":{"get":{"tags":["Document Resource APIs"],"summary":"Gets the batch id","description":"This API is used to get batchId for the specified site.","operationId":"getBatchID","produces":["application/xml","text/plain"],"parameters":[{"name":"version","in":"path","description":"version of api","required":true,"type":"string","default":"1"},{"name":"siteid","in":"path","description":"siteID","required":true,"type":"string"}],"responses":{"200":{"description":"OK"},"403":{"description":"Validation failed/ Forbidden"}},"security":[{"OAuth":[]}]}},"/{version}/files/{fileid}/activity":{"post":{"tags":["Document Resource APIs"],"summary":"Register view activity for a file","description":"This API is used to add 'view' activity on file","operationId":"addActivity","produces":["application/xml","application/json"],"parameters":[{"name":"version","in":"path","description":"version of api","required":true,"type":"string","default":"1"},{"name":"fileid","in":"path","description":"The id of the file in which activity to be added","required":true,"type":"string"},{"name":"type","in":"query","description":"The type of activity which is always 'view'","required":true,"type":"string"},{"name":"foldertype","in":"query","description":"Folder type","required":false,"type":"string"}],"responses":{"200":{"description":"OK"},"403":{"description":"Validation failed/ Forbidden"}},"security":[{"OAuth":[]}]}},"/{version}/shares/link":{"post":{"tags":["Document Resource APIs"],"summary":"Share via link","description":"
This api used to share content from my files or shared items
Note :
- resourcetype tag : {folder/file}.
- resourceid tag : (the folder/file id can be any from my files or shared items).
- Integer value for the shareoption tag : {1(anyone) / 2(my organisation user) / 3(system users)/ 4(Can be accessed by anyone who has the password) this 4th option is introduced from api version 6 onwards for sharing
password protected files}.
- password tag option is only used from api version 6 onwards when shareoption value is 4.
- expiry tag format is 'UTC date and time(dd MMM yyyy HH:mm)'.
To Remove registered folder for Changes API based on sourceclient.","operationId":"removeRegisteredFolder","produces":["application/xml","application/json"],"parameters":[{"name":"version","in":"path","description":"version of api","required":true,"type":"string","default":"1"},{"name":"folderid","in":"path","description":"Folder ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK"},"400":{"description":"Problem with parsing XML or JSON object (Bad Request)"},"401":{"description":"Unauthorized"},"403":{"description":"Validation failed/ Forbidden"},"404":{"description":"Document doesn't exists in the system"},"405":{"description":"Method not allowed (calling api with wrong method)"},"500":{"description":"Internal error occurred while getting document content"}},"security":[{"OAuth":[]}]}},"/{version}/folders/{folderid}":{"get":{"tags":["Document Resource APIs"],"summary":"Gets the folder info","description":"
The method provides folder detail of given folder id.","operationId":"getFolderInfo","produces":["application/xml","application/json"],"parameters":[{"name":"version","in":"path","description":"version of api","required":true,"type":"string","default":"1"},{"name":"folderid","in":"path","description":"folderID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FolderDBOV2"}},"401":{"description":"Unauthorized"},"403":{"description":"Validation failed/ Forbidden"},"405":{"description":"Method not allowed (calling api with wrong method)"},"500":{"description":"Internal error","schema":{"$ref":"#/definitions/ErrorDBO"}}},"security":[{"OAuth":[]}]},"put":{"tags":["Document Resource APIs"],"summary":"Update folder","description":"This api will allow you to update folder.","operationId":"updateFolder","consumes":["text/plain","application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"version","in":"path","description":"Version of api","required":true,"type":"string","default":"1"},{"name":"batchid","in":"query","description":"Batch ID","required":false,"type":"string"},{"name":"rootfolderid","in":"query","description":"Root folder ID","required":false,"type":"string"},{"name":"folderid","in":"path","description":"folderID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/FolderDBO"}}],"responses":{"200":{"description":"Folder updated successfully"},"400":{"description":"Problem with parsing XML or JSON object (Bad Request)"},"401":{"description":"Unauthorized"},"403":{"description":"Validation failed/ Forbidden"},"405":{"description":"Method not allowed (calling api with wrong method)"},"500":{"description":"Internal error occured while updating folder","schema":{"$ref":"#/definitions/ErrorDBO"}}},"security":[{"OAuth":[]}]},"delete":{"tags":["Document Resource APIs"],"summary":"Delete folder","description":"This api going to delete active folder from to the site, one's folder deleted it goes to recycle bin (Deleted items folder).","operationId":"deleteFolder","produces":["application/xml","application/json"],"parameters":[{"name":"version","in":"path","description":"version of api","required":true,"type":"string","default":"1"},{"name":"folderid","in":"path","description":"Folder ID","required":true,"type":"string"}],"responses":{"200":{"description":"Folder deleted successfully."},"204":{"description":"Folder deleted successfully."},"401":{"description":"Unauthorized"},"405":{"description":"Method not allowed (calling api with wrong method)"}},"security":[{"OAuth":[]}]}},"/{version}/shares/{shareid}":{"delete":{"tags":["Document Resource APIs"],"summary":"Delete share/Remove share","description":"
The \"Remove a share\" API endpoint deletes only single share link.
Note :
- The share link being deleted should be an active share link.
- This API will remove only single share link.
- If provided {shareid} not exists in system, then 'Access denied' response will be produced.
API method to get a list of files from Collaborate.
The representation of q parameter works as under\r\n\r\nq = \"folderid=1\"","operationId":"getFileList","produces":["application/xml","application/json"],"parameters":[{"name":"version","in":"path","description":"version of api","required":true,"type":"string","default":"1"},{"name":"q","in":"query","description":"query to filter out results","required":false,"type":"string"},{"name":"limit","in":"query","description":"No of items to returned","required":false,"type":"string"},{"name":"offset","in":"query","description":"Starting point of the returned items. This should be the item ID.","required":false,"type":"string"},{"name":"orderby","in":"query","description":"This is the order of the items returned. Possible values are \"Asc\" , \"desc\" , Default is Desc, which means that the latest items are returned first.","required":false,"type":"string"},{"name":"ordertype","in":"query","description":"can be one of name, size, author, lastModified, filetype","required":false,"type":"string"},{"name":"filelist","in":"query","description":"fileID CSV","required":false,"type":"string"}],"responses":{"200":{"description":"Get File List successfully","schema":{"$ref":"#/definitions/DocumentDBO"}},"400":{"description":"Problem with parsing XML or JSON object (Bad Request)"},"401":{"description":"Unauthorized"},"403":{"description":"Validation failed/ Forbidden"},"405":{"description":"Method not allowed (calling api with wrong method)"},"500":{"description":"Internal error occurred","schema":{"$ref":"#/definitions/ErrorDBO"}}},"security":[{"OAuth":[]}]}},"/{version}/folders/{folderid}/parent":{"post":{"tags":["Document Resource APIs"],"summary":"Copy folder","description":"The method allows a given folder to be copied from one folder location to another folder location. The target folder location can be in a different site.","operationId":"copyFolder","produces":["application/xml","application/json"],"parameters":[{"name":"version","in":"path","description":"version of api","required":true,"type":"string","default":"1"},{"name":"folderid","in":"path","description":"The id of the folder which needs to be copied","required":true,"type":"string"},{"name":"targetfolder","in":"query","description":"\tThe target folder id of the folder under which the folder will be copied","required":true,"type":"string"}],"responses":{"200":{"description":"Your content is copied successfull..."},"400":{"description":"Request resource or xml is not valid"},"403":{"description":"Validation failed/ Forbidden"}},"security":[{"OAuth":[]}]},"put":{"tags":["Document Resource APIs"],"summary":"Move folder","description":"The method allows a given folder to be moved from one folder location to another folder location within a site.","operationId":"moveFolder","produces":["application/xml","application/json"],"parameters":[{"name":"version","in":"path","description":"version of api","required":true,"type":"string","default":"1"},{"name":"folderid","in":"path","description":"The id of the folder which is to be moved ","required":true,"type":"string"},{"name":"targetfolder","in":"query","description":"The target folder id of the folder under which the folder is to be moved","required":true,"type":"string"}],"responses":{"200":{"description":"Successfully moved"},"400":{"description":"Request resource or xml is not valid"},"403":{"description":"Validation failed/ Forbidden"}},"security":[{"OAuth":[]}]}},"/{version}/folders/{folderid}/foldersize":{"get":{"tags":["Document Resource APIs"],"summary":"Gets the folder size","description":"Get a folder size by folder ID.","operationId":"getFolderSize","produces":["application/xml","application/json"],"parameters":[{"name":"version","in":"path","description":"version of api","required":true,"type":"string","default":"1"},{"name":"folderid","in":"path","description":"folderID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FolderDBOV2"}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/ErrorDBO"}},"403":{"description":"Validation failed/ Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling api with wrong method)","schema":{"$ref":"#/definitions/ErrorDBO"}},"500":{"description":"Internal error","schema":{"$ref":"#/definitions/ErrorDBO"}}},"security":[{"OAuth":[]}]}},"/{version}/folders/{folderid}/items":{"get":{"tags":["Document Resource APIs"],"summary":"Gets the folder list","description":"
This API method provides a list of folders under a given folder.
Note :
The value of limit parameter behaves as following
- limit =100 is the default value
- if limit>0 then (number of items returned is equal to limit)
- if limit=-1 then return all records
- if limit <-1 then the system returns the default no of items i.e 100
The value of Offset parameter behaves as under
- (Default) offset =0
- if offset > 0 then the records are returned from the offset value
- if offset < 0 then offset value of 0 is set
Defalut value for orderby parameter is asc and for ordertype is creation date.
This api will allow you to create folder into site.","operationId":"addFolder","consumes":["text/plain","application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"version","in":"path","description":"Version of api","required":true,"type":"string","default":"1"},{"name":"batchid","in":"query","description":"Batch ID","required":false,"type":"string"},{"name":"rootfolderid","in":"query","description":"Root folder ID","required":false,"type":"string"},{"name":"parentfolderid","in":"query","description":"ID of the parent folder in which want to add folder","required":true,"type":"string"},{"name":"allowduplicatefolder","in":"query","description":"Allow/Disallow duplicate folder in given parent folder","required":false,"type":"boolean","default":true,"enum":["true","false"]},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/FolderDBO"}}],"responses":{"201":{"description":"Folder created successfully","schema":{"$ref":"#/definitions/FolderDBO"}},"400":{"description":"Problem with parsing XML or JSON object (Bad Request)"},"401":{"description":"Unauthorized"},"403":{"description":"Validation failed/ Forbidden"},"405":{"description":"Method not allowed (calling api with wrong method)"},"409":{"description":"Folder already exists","schema":{"$ref":"#/definitions/FolderDBO"}},"500":{"description":"Internal error occured while creating folder","schema":{"$ref":"#/definitions/ErrorDBO"}}},"security":[{"OAuth":[]}]}},"/{version}/folders/{folderid}/dmsaddrequest":{"get":{"tags":["Document Resource APIs"],"summary":"Gets the collab folders and documents structure","description":"An API method that provides a list of files and folders has been added to the synced folder in Collaborate and can be synced from Collaborate to Worksite. An API client can call this method at regular intervals to find out if there are any changes at the Collaborate end, and then based on that, can sync the changes back to DMS.","operationId":"getCollabFoldersAndDocumentsStructure","produces":["application/xml","application/json"],"parameters":[{"name":"version","in":"path","description":"version of api","required":true,"type":"string","default":"1"},{"name":"folderid","in":"path","description":"Folderid is the ID of the synced folder","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DMSAddRequestDBO"}}},"security":[{"OAuth":[]}]},"put":{"tags":["Document Resource APIs"],"summary":"Update details of job by dms add request info","description":"An API method which helps update a Collaborate document's sync status when uploading the content to external DMS system. This method helps to toggle the Collaborate document or folder status from inSync to synced or error, depending on the success or failure of the operation. This status change will change the icon colour from blue to green or red, depending on the final status.","operationId":"updateDetailsOfJobByDMSAddRequestInfo","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"version","in":"path","description":"version of api","required":true,"type":"string","default":"1"},{"name":"folderid","in":"path","description":"folderid is the ID of the synced folder","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/DMSAddRequestDBO"}}],"responses":{"200":{"description":"OK"}},"security":[{"OAuth":[]}]}},"/{version}/folders/{folderid}/permissions":{"get":{"tags":["Document Resource APIs"],"summary":"To get folder permissions for groups","description":"
Use this method to return a list of the groups/users that have permissions to the folder and their permission details.
In the response for inherited
This API method adds or updates folder permissions for a group/user. This can only be used when the inheritance has been broken for the specific folder. Please use the change inheritance method for a folder to break the inheritance.
usergrouptype In request xml are 1 for user based site and 2 for group based site.
This api is used for add new file version.
Note :
- Optional form data param called \"notification\" which is used for \"notification\" preference.
- 1= Respect user preference.
- 2= Force email notification.
- 3= Suppress all notifications.
This notification form data param is not mandatory and when user does not provide it then default value = 3 = Suppress all notifications.
This api used to share content from my files or shared items via microblog.
Note :
- resourcetype tag : {folder/file}.
- resourceid tag : (the folder/file id can be any from my files or shared items).
- Integer value for the permission tag : {1(download_view_print) / 2(view_only)}
- sharegroup tag : List of sites to share with.
- microblogmessage tag : {The microblog can accept # and @ mention}.
- expiry tag format is 'UTC date and time(dd MMM yyyy HH:mm)'.
This api used to share content from my files or shared items via private message.
Note :
- resourcetype tag : {folder/file}.
- resourceid tag : (the folder/file id can be any from my files or shared items).
- share_with tag : list of email addresses to share with {these should be valid existing Collaborate users, please see he response to see how error messages are going to be returned}.
- private_message tag : {The message can accept # and @ mention}.
- expiry tag format is 'UTC date and time(dd MMM yyyy HH:mm)'.
- Integer value for the permission tag : {1(download_view_print) / 2(view_only)}.","operationId":"shareViaPrivateMessage","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"version","in":"path","description":"version of api","required":true,"type":"string","default":"1"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/Share"}}],"responses":{"200":{"description":"Share via private message successfully","schema":{"$ref":"#/definitions/Share"}},"400":{"description":"Problem with parsing XML or JSON object (Bad Request)"},"401":{"description":"Unauthorized"},"403":{"description":"Validation failed/ Forbidden"},"405":{"description":"Method not allowed (calling api with wrong method)"},"500":{"description":"Internal error occured"}},"security":[{"OAuth":[]}]}},"/{version}/changes":{"get":{"tags":["Document Resource APIs"],"summary":"Gets the changes for sync","description":"The purpose of this API is to provide changes to the system. This will get the sync changes detail.
Note :
- In the response nextsyncposition means the next sync position the client should use to obtain changes.
- syncpositionid : If the next sync position id is provided, then changes following that sync position will be returned. Otherwise a response with a current sync position ID is given (without activities).If syncpositionid=0 then first 500 top activities will be given in response.
- limit : This parameter can be used to limit the number of changes returned otherwise 500 changes are returned.
- contenttype : To filter the result set by a specific content type like 'Files'. If this parameter is set then it will return specific type of changes, otherwise all types of content will be returned. \"contenttype=files\" will return both file and folder contents.
- siteid : to get changes by sourceclient basis. If provided, then it will give site specific sync changes otherwise not.
This API method adds or updates file permissions for a group/user.
Please note the permissions can only be added to the existing permissions inherited from the parent folder and does not allow the removal of the inherited permissions from the parent folder in which the file exists.
usergrouptype In request xml are 1 for user based site and 2 for group based site.
This api used for to add placeholder file.
Note :
- Optional form data param called \"notification\" which is used for \"notification\" preference.
- 1= Respect user preference.
- 2= Force email notification.
- 3= Suppress all notifications.
This notification form data param is not mandatory and when user does not provide it then default value = 3 = Suppress all notifications.
This api used for insert file in specified folder in site.
Note :
Optional form data param called \"notification\" which is used for \"notification\" preference.
- 1= Respect user preference.
- 2= Force email notification.
- 3= Suppress all notifications.
This notification form data param is not mandatory and when user does not provide it then default value = 3 = Suppress all notifications.
This API call is used to get a list of iSheet of the site.
This method includes the iSheet structure as seen in the iSheet admin interface. Please note that this method is only available to site and content admins.
","operationId":"getISheets","produces":["application/xml","application/json","text/xml"],"parameters":[{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"3"},{"name":"siteid","in":"query","description":"Id of the iSheet site for which the iSheets are to be obtained","required":true,"type":"string"},{"name":"type","in":"query","description":"Type parameter is not mandatory. Blank or Null will return all iSheets including metadata iSheets. Other values are documentmetadata, foldermetadata, taskmetadata, normal","required":false,"type":"string"}],"responses":{"200":{"description":"API will return the list of iSheets of the site","schema":{"$ref":"#/definitions/ISheetDocTemplatesDBO"}},"403":{"description":"Validation failed | Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"400":{"description":"Problem with parameters"},"401":{"description":"Unauthorised"},"500":{"description":"Internal server error"}},"security":[{"OAuth":[]}]},"post":{"tags":["ISheet Admin API"],"summary":"To create an iSheet","description":"Method to add a new iSheet to the site.
The method only allows you to define the details of an iSheet, and does not provide the capability to add columns to the iSheet.
Add columns to iSheet record method should be used to add columns to the iSheet.
To Add an iSheet call API: POST : /api/3/isheets/admin?siteid={siteid}
Parameters:
| Name | Type | Description |
|---|---|---|
| siteid | number | The of the site to create the iSheet in |
If successful, the API returns the 200 http message If the operation fails, the API will return one of the following error codes.
| Code | Meaning |
|---|---|
| 200 | iSheet created successfully |
| 401 | Unauthorised |
| 403 | Validation failed/ Forbidden |
| 405 | Method not allowed (calling api with wrong method) |
| 500 | Internal error occurred |
This method is supported in version 3 of the API and above.
This API call is used to get list of sections for an iSheet of the site.
This method is supported in version 3 of the API and above.
This API will add a new section to the iSheet.
This method is supported in version 3 of the API and above.
This method returns the allowed column types and should be used when creating a new column in an iSheet.
This method is supported in version 3 of the API and above.
API method to edit an existing iSheet.
","operationId":"updateIsheet","consumes":["application/xml","application/json","text/xml"],"produces":["application/xml","application/json","text/xml"],"parameters":[{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"3"},{"name":"isheetid","in":"path","description":"Id of the iSheet which is being edited","required":true,"type":"integer","format":"int32"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/isheetDBO"}}],"responses":{"200":{"description":"The API will return the 200 response code without any message"},"401":{"description":"Unauthorised"},"403":{"description":"Validation failed/ Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling API endpoint with the wrong method)"},"500":{"description":"Internal error occurred"}},"security":[{"OAuth":[]}]},"delete":{"tags":["ISheet Admin API"],"summary":"To delete the iSheet","description":"This API will delete the existing iSheet.
To delete an iSheet call API: DELETE /api/{version}/isheets/admin/{isheetid}
Parameters:
| Name | Type | Description |
|---|---|---|
| isheetId | number | Id of the iSheet for which the column is to be deleted |
To get the status of an iSheet columns 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 | This key is returned when a long-running operation is called and can be used to find the final status of the operation |
If the operation is successful, the API returns a progressive key resource object. The possible status values are \"INPROGRESS\", \"DONE\" or \"FAIL\".
In the case of a failure, an error object is returned with the appropriate error code.
This method is supported in version 3 of the API and above.
Get the list of views for an iSheet.
Add a new view to the iSheet
The methods returns a 200 http response in case of a successful request, otherwise an error object is returned.
","operationId":"createIsheetView","consumes":["application/xml","application/json","text/xml"],"produces":["application/xml","application/json","text/xml"],"parameters":[{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"3"},{"name":"isheetid","in":"path","description":"Id of the iSheet","required":true,"type":"integer","format":"int32"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/iSheetView"}}],"responses":{"200":{"description":"API will return the newly created iSheet view","schema":{"$ref":"#/definitions/iSheetView"}},"401":{"description":"Unauthorised"},"403":{"description":"Validation failed | Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling API endpoint with the wrong method)"},"500":{"description":"Internal error occurred"}},"security":[{"OAuth":[]}]}},"/{version}/isheets/admin/sortisheets":{"get":{"tags":["ISheet Admin API"],"summary":"To get the list of the iSheets sorted based on the position in ascending order","description":"This method is used to get the iSheets sorted based on the position in ascending order.
GET /api/3/isheets/admin/sortisheets?siteid=${siteid}
Parameter Name | \r\n\t\t\tParameter Value | \r\n\t\t\tDescription | \r\n\t\t
| \r\n\t\t\t siteid \r\n\t\t\t | \r\n\t\t\tnumber | \r\n\t\t\tThe id of the site | \r\n\t\t
Note : As seen in the UI, the response will display the iSheets in their correct sequence.
","operationId":"getSortIsheets","produces":["application/xml","application/json","text/xml"],"parameters":[{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"3"},{"name":"siteid","in":"query","description":"Id of the site","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"API will return the list of iSheets sorted based on the position in ascending order","schema":{"$ref":"#/definitions/ISheetsDBO"}},"401":{"description":"Unauthorised"},"403":{"description":"Validation failed/ Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling API endpoint with the wrong method)"},"500":{"description":"Internal error occurred"}},"security":[{"OAuth":[]}]},"put":{"tags":["ISheet Admin API"],"summary":"To update iSheets in order","description":"This method is used to update iSheets into a sort order
PUT /api/3/isheets/admin/sortisheets?siteid=${siteid}
Parameter Name | \r\n\t\t\tParameter Value | \r\n\t\t\tDescription | \r\n\t\t
| \r\n\t\t\t siteid \r\n\t\t\t | \r\n\t\t\tnumber | \r\n\t\t\tThe id of the site for isheet sorts | \r\n\t\t
Note : Need to manage sequences in the request xml. We will refer this sequence for update. First iSheet will be set as first and second will be set for second iSheet.
","operationId":"updateSortIsheets","consumes":["application/xml","application/json","text/xml"],"produces":["application/xml","application/json","text/xml"],"parameters":[{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"3"},{"name":"siteid","in":"query","description":"Id of the site","required":true,"type":"integer","format":"int32"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ISheetsDBO"}}],"responses":{"200":{"description":"The API will return the 200 response code without any message"},"401":{"description":"Unauthorised"},"403":{"description":"Validation failed | Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling API endpoint with the wrong method)"},"500":{"description":"Internal error occurred"}},"security":[{"OAuth":[]}]}},"/{version}/isheets/admin/doctemplate":{"get":{"tags":["ISheet Admin API"],"summary":"To get the iSheet document template","description":"This API call is used to get a list of iSheet document templates.
This method is supported in version 3 of the API and above.
This method shows you how to add a new iSheet document report
POST /api/{version}/isheets/admin/doctemplate?siteid=${siteid}
Parameter Name | \r\n\t\t\tParameter Value | \r\n\t\t\tDescription | \r\n\t\t
| \r\n\t\t\t siteid \r\n\t\t\t | \r\n\t\t\tA numeric value representing the site id | \r\n\t\t\tThe id of the site for iSheet document templates. | \r\n\t\t
Method to Get columns of an existing iSheet.
This method is supported in version 3 of the API and above.
Method to add a column to an existing iSheet.
To get the status of an iSheet columns 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 | This key is returned when a long-running operation is called and can be used to find the final status of the operation |
If the operation is successful, the API returns a progressive key resource object. The possible status values are \"INPROGRESS\", \"DONE\" or \"FAIL\".
In the case of a failure, an error object is returned with the appropriate error code.
This method is supported in version 3 of the API and above.
Edit view to the iSheet
The methods returns a 200 http response in case of a successful request, otherwise an error object is returned.
","operationId":"updateIsheetView","consumes":["application/xml","application/json","text/xml"],"produces":["application/xml","application/json","text/xml"],"parameters":[{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"3"},{"name":"isheetid","in":"path","description":"Id of the iSheet","required":true,"type":"integer","format":"int32"},{"name":"viewid","in":"path","description":"Id of the view","required":true,"type":"integer","format":"int32"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/iSheetView"}}],"responses":{"200":{"description":"The API will return the 200 response code without any message"},"401":{"description":"Unauthorised"},"403":{"description":"Validation failed/ Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling API endpoint with the wrong method)"},"500":{"description":"Internal error occurred"}},"security":[{"OAuth":[]}]},"delete":{"tags":["ISheet Admin API"],"summary":"To delete the iSheet view","description":"Delete an iSheet view.
The method returns a 200 http response if the section is deleted successfully, otherwise an error response is returned.
","operationId":"deleteIsheetView","produces":["application/xml","application/json","text/xml"],"parameters":[{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"3"},{"name":"isheetid","in":"path","description":"Id of the iSheet","required":true,"type":"integer","format":"int32"},{"name":"viewid","in":"path","description":"Id of the iSheet view","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"The API will return the 200 response code without any message"},"401":{"description":"Unauthorised"},"403":{"description":"Validation failed/ Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling API endpoint with the wrong method)"},"500":{"description":"Internal error occurred"}},"security":[{"OAuth":[]}]}},"/{version}/isheets/admin/{isheetid}/columns/{columnid}/permissions/status":{"put":{"tags":["ISheet Admin API"],"summary":"To enable or disable iSheet column permission","description":"This method is use to enable or disable permissions at the iSheet column level.
This method is supported in version 3 of the API and above.
Method used to Edit section to the iSheet.
This method is supported in version 3 of the API and above.
Method used to delete a section. A section can only be deleted if there are no columns associated with it.
This method is supported in version 3 of the API and above.
This method is used to enable/disable permissions at an iSheet view level.
This method is supported in version 3 of the API and above.
Method to Get Choice And Score columns of an existing iSheet.
This method is supported in version 8 of the API and above.
Method used to get the list of isheet permissions.
This method is supported in version 3 of the API and above.
This method is used to Sets the values based on the information provided at the iSheet level.
This method is supported in version 3 of the API and above.
This method returns the list of iSheet-view permissions.
This method is supported in version 3 of the API and above.
This method set the values based on the information provided.
This method is supported in version 3 of the API and above.
This method is used to enable/disable a permission at the iSheet level.
This method is supported in version 3 of the API and above.
This method returns the list of iSheet column permissions.
This method is supported in version 3 of the API and above.
This method set the values based on the information provided.
This method is supported in version 3 of the API and above.
This method is used to get iSheet settings.
This method is supported in version 3 of the API and above.
This method is used to update the iSheet settings.
This method is supported in version 3 of the API and above.
This method lets you edit an iSheet document template.
","operationId":"updateSheetDocReport","consumes":["multipart/form-data"],"produces":["application/xml","application/json","text/xml"],"parameters":[{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"3"},{"name":"doctemplateid","in":"path","description":"Id of doctemplate which is to be update","required":true,"type":"integer","format":"int32"},{"name":"reportfile","in":"formData","description":"Parameter name should be called reportfile and the value for it is the file to be uploaded","required":true,"type":"file"},{"name":"templatename","in":"formData","description":"Template name","required":false,"type":"string"},{"name":"templatetype","in":"formData","description":"Template type","required":false,"type":"string","enum":["SITE_WIDE","SINGLE_RECORD"]},{"name":"linkedisheet","in":"formData","description":"Id of the iSheet - only applicable for templatetype=SINGLE_RECORD","required":false,"type":"string"},{"name":"linkedviewtype","in":"formData","description":"Linked view type - only applicable for templatetype=SINGLE_RECORD","required":false,"type":"string","enum":["0","1"]},{"name":"linkedviewid","in":"formData","description":"CSV of isheet view id (multiple view id with ',' separated ). Only applicable for templatetype=SINGLE_RECORD and 0 : All isheet views","required":false,"type":"string"},{"name":"generatedocument","in":"formData","description":"Generate document","required":false,"type":"string","enum":["WORD","PDF"]},{"name":"downloaddocument","in":"formData","description":"Download document","required":false,"type":"string","enum":["0","1"]},{"name":"savetofolder","in":"formData","description":"Save to folder","required":false,"type":"string","enum":["0","1"]},{"name":"savetospecificfolder","in":"formData","description":"Id of the folder","required":false,"type":"string"},{"name":"savetospecificisheetcolumn","in":"formData","description":"Id of the column. This field only applicable for templatetype=SINGLE_RECORD","required":false,"type":"string"}],"responses":{"200":{"description":"The API will return the 200 response code without any message"},"403":{"description":"Validation failed | Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"400":{"description":"Problem with parameters"},"401":{"description":"Unauthorised"},"500":{"description":"Internal server error"}},"security":[{"OAuth":[]}]},"delete":{"tags":["ISheet Admin API"],"summary":"To delete an iSheet document template","description":"This API call is used to delete the iSheet document template.
The method has no request parameters or body.
","operationId":"deleteIsheetDocTemplate","produces":["application/xml","application/json","text/xml"],"parameters":[{"name":"doctemplateid","in":"path","description":"Id of the iSheet document template","required":true,"type":"integer","format":"int32"},{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"3"}],"responses":{"200":{"description":"The API will return the 200 response code without any message"},"403":{"description":"Validation failed | Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"400":{"description":"Problem with parameters"},"401":{"description":"Unauthorised"},"500":{"description":"Internal server error"}},"security":[{"OAuth":[]}]}},"/{version}/isheets/admin/{isheetid}/columns/{columnid}":{"put":{"tags":["ISheet Admin API"],"summary":"To update the iSheet column","description":"Method to edit a column to an existing iSheet.
This method is supported in version 3 of the API and above.
API method to delete an individual column.
DELETE /api/3/isheets/admin/{isheetid}/columns/{columnid}
Name | \r\n\t\t\tType | \r\n\t\t\tDescription | \r\n\t\t
| \r\n\t\t\t isheetId \r\n\t\t\t | \r\n\t\t\tnumber | \r\n\t\t\tId of the iSheet for which the column is to be deleted | \r\n\t\t
| \r\n\t\t\t columnid \r\n\t\t\t | \r\n\t\t\tnumber | \r\n\t\t\tId of the column to be deleted | \r\n\t\t
To get the status of an iSheet column based on a progressive key
POST /api/3/progressivekeystatus/{progressive_key}
Name | \r\n\t\t\tType | \r\n\t\t\tDescription | \r\n\t\t
| \r\n\t\t\t progressive_key \r\n\t\t\t | \r\n\t\t\tString | \r\n\t\t\tUse this key to check the status of your progress. When you first send a delete request, a progressive key is returned in response. | \r\n\t\t
If the operation is successful, the API returns a progressive key resource object with a status of either 'INPROGRESS', 'DONE' or 'FAIL'.If there is a failure, an error object is returned with the appropriate error code.
","operationId":"deleteISheetColumn","produces":["application/xml","application/json"],"parameters":[{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"3"},{"name":"isheetid","in":"path","description":"Id of the iSheet for which the column is to be deleted","required":true,"type":"integer","format":"int32"},{"name":"columnid","in":"path","description":"Id of the column to be deleted","required":true,"type":"integer","format":"int32"}],"responses":{"201":{"description":"This key is returned when a long-running operation is called and can be used to find the final status of the operation.","schema":{"$ref":"#/definitions/ProgressiveKeyDBO"}},"401":{"description":"Unauthorised"},"403":{"description":"Validation failed/ Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling API endpoint with the wrong method)"},"500":{"description":"Internal error occurred"}},"security":[{"OAuth":[]}]}},"/{version}/isheets/admin/choicelists":{"get":{"tags":["ISheet Admin API"],"summary":"To get a list of choice list templates","description":"This method returns list of choice list templates.
This method is supported in version 8 of the API and above.
API Error code | \r\n\t\t\tError message | \r\n\t\t\tDescription | \r\n\t\t
| \r\n\t\t\t 137 \r\n\t\t\t | \r\n\t\t\tThe limit value is invalid. | \r\n\t\t\tLimit value should be a positive integer, -1 for all items | \r\n\t\t
| \r\n\t\t\t 138 \r\n\t\t\t | \r\n\t\t\tThe offset value is invalid. | \r\n\t\t\tOffset value should be a positive integer, 0 is default value | \r\n\t\t
| \r\n\t\t\t 167 \r\n\t\t\t | \r\n\t\t\tcolumntype parameter is invalid | \r\n\t\t\tColumn type values can be choice or 3 or score or 17 | \r\n\t\t
| \r\n\t\t\t 168 \r\n\t\t\t | \r\n\t\t\tcolumntype parameter is required | \r\n\t\t\tColumn type is required parameter and can't be empty | \r\n\t\t
| \r\n\t\t\t 169 \r\n\t\t\t | \r\n\t\t\tcreator parameter is invalid | \r\n\t\t\tCreator parameter can be a single user id or multiple user ids separated by a comma e.g. 6 or 3,4,5 | \r\n\t\t
The add choice list API is used to add a choice list along with its items/values.
API Version: 8
Collaborate Branch: 5.3
Request URI: POST /api/8/isheets/admin/choicelists
API Error code | \r\n\t\t\tError message | \r\n\t\t\tDescription | \r\n\t\t
167 | \r\n\t\t\tcolumntype parameter is invalid | \r\n\t\t\tColumn type values can be choice or 3 or score or 17. | \r\n\t\t
168 | \r\n\t\t\tcolumntype parameter is required | \r\n\t\t\tIf the choice list column type is empty. | \r\n\t\t
171 | \r\n\t\t\tThe name cannot be blank | \r\n\t\t\tIf the choice list name is empty. | \r\n\t\t
172 | \r\n\t\t\tThe name cannot be more than 256 characters | \r\n\t\t\tIf the choice list name exceeds 256 characters. | \r\n\t\t
173 | \r\n\t\t\tChoice list item(s) or its label should not be empty | \r\n\t\t\tIf the choice list item(s) is not provided. | \r\n\t\t
174 | \r\n\t\t\tThe name 'Dummy choice' already exists in the system | \r\n\t\t\tIf the duplicate choice list name found. | \r\n\t\t
175 | \r\n\t\t\tThe choice option value size must be less than 256 characters | \r\n\t\t\tIf the choice list item label exceeds 255 chars. | \r\n\t\t
176 | \r\n\t\t\tInvalid score value ' | \r\n\t\t\tIf the score value is not within the range -9999.9999 to 9999.9999 | \r\n\t\t
This method is used to get the list of sorted iSheet columns based on column position in ascending order
Note : As we can see in the UI, the response will display with columns in the correct sequences.
","operationId":"getSortIsheetColumns","produces":["application/xml","application/json","text/xml"],"parameters":[{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"3"},{"name":"isheetid","in":"path","description":"Id of the iSheet","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"API will return the list of sorted iSheet columns based on column position in ascending order.","schema":{"$ref":"#/definitions/columns"}},"401":{"description":"Unauthorised"},"403":{"description":"Validation failed | Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling API endpoint with the wrong method)"},"500":{"description":"Internal error occurred"}},"security":[{"OAuth":[]}]},"put":{"tags":["ISheet Admin API"],"summary":"To update iSheet columns' position in sorted order","description":"This method is used to update iSheet columns' position in sorted order.
Parameter Name | \r\n\t\t\tParameter Value | \r\n\t\t\tDescription | \r\n\t\t
| \r\n\t\t\t sectionid \r\n\t\t\t | \r\n\t\t\tnumber | \r\n\t\t\tThis parameter query is only applicable if the section is enabled in the iSheet. Once the section is enabled, the columns associated to the section can be re-ordered. Columns that are not associated, cannot be re-ordered. | \r\n\t\t
PUT /api/3/isheets/admin/{isheetid}/sortcolumns?sectionid={sectionid}
Note : The order of the columns in the request API determines the order of the columns in iSheet.","operationId":"updateSortIsheetColumns","consumes":["application/xml","application/json","text/xml"],"produces":["application/xml","application/json","text/xml"],"parameters":[{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"3"},{"name":"isheetid","in":"path","description":"Id of the iSheet","required":true,"type":"integer","format":"int32"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/columns"}},{"name":"sectionid","in":"query","description":"Id of the section","required":false,"type":"string"}],"responses":{"200":{"description":"The API will return the 200 response code without any message"},"401":{"description":"Unauthorised"},"403":{"description":"Validation failed | Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling API endpoint with the wrong method)"},"500":{"description":"Internal error occurred"}},"security":[{"OAuth":[]}]}},"/{version}/isheets/admin/doctemplate/{doctemplateid}/download":{"get":{"tags":["ISheet Admin API"],"summary":"To download the iSheet document report (configuration file)","description":"
This api is designed for downloading the configuration file (docx, docm) of an iSheet document template
Parameter Name | \r\n\t\t\tParameter Value | \r\n\t\t\tDescription | \r\n\t\t
| \r\n\t\t\t doctemplateid \r\n\t\t\t | \r\n\t\t\tnumber | \r\n\t\t\tId of isheet document template. | \r\n\t\t
Response : Binary stream of document.
Code | \r\n\t\t\tMeaning | \r\n\t\t
| \r\n\t\t\t 200 \r\n\t\t\t | \r\n\t\t\tDocument found. | \r\n\t\t
| \r\n\t\t\t 400 \r\n\t\t\t | \r\n\t\t\tProblem with parsing XML or JSON object (Bad Request). | \r\n\t\t
| \r\n\t\t\t 401 \r\n\t\t\t | \r\n\t\t\tUnauthorized. | \r\n\t\t
| \r\n\t\t\t 403 \r\n\t\t\t | \r\n\t\t\tValidation failed/ Forbidden. | \r\n\t\t
| \r\n\t\t\t 404 \r\n\t\t\t | \r\n\t\t\tDocument doesn't exists in the system. | \r\n\t\t
| \r\n\t\t\t 405 \r\n\t\t\t | \r\n\t\t\tMethod not allowed (calling api with wrong method). | \r\n\t\t
| \r\n\t\t\t 500 \r\n\t\t\t | \r\n\t\t\tInternal error occured while gettting document content | \r\n\t\t
This method set the values based on the information provided
If the operation is successful the API returns an progressive key resource object.
And based on this progressive key, you can see the status of the isheet template, otherwise an error object is returned with the appropriate error code.
To get the status of an iSheet template based on a progressive key
POST /api/3/progressivekeystatus/{progressive_key}
Name | \r\n\t\t\tType | \r\n\t\t\tDescription | \r\n\t\t
| \r\n\t\t\t progressive_key \r\n\t\t\t | \r\n\t\t\tString | \r\n\t\t\tYou can use this key to check the status of your progress. When the first request is sent, a progressive key is returned in response. | \r\n\t\t
If the operation is successful, the API returns a progressive key resource object with status of either 'INPROGRESS', 'DONE', or 'FAIL'. If there is a failure, an error object is returned with the appropriate error code.
Note: linkedtemplateid = A new id is generated when an iSheet template is added in the site.
","operationId":"updateImportedIsheetTemplate","consumes":["application/xml","application/json","text/xml"],"produces":["application/xml","application/json","text/xml"],"parameters":[{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"3"},{"name":"linkedtemplateid","in":"path","description":"Id of the linked template","required":true,"type":"integer","format":"int32"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/importISheetTemplateDBO"}}],"responses":{"201":{"description":"This key is returned when a long-running operation is called and can be used to find the final status of the operation.","schema":{"$ref":"#/definitions/ProgressiveKeyDBO"}},"401":{"description":"Unauthorised"},"403":{"description":"Validation failed | Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling API endpoint with the wrong method)"},"500":{"description":"Internal error occurred"}},"security":[{"OAuth":[]}]},"delete":{"tags":["ISheet Admin API"],"summary":"To delete the imported iSheet template","description":"Use this method to delete iSheet templates from a site
If the operation is successful, the API returns a progressive key resource object. And based on this progressive key, you can see the status of the iSheet template, otherwise an error object is returned with the appropriate error code.
To get the status of an iSheet template based on a progressive key
POST /api/3/progressivekeystatus/{progressive_key}
Name | \r\n\t\t\tType | \r\n\t\t\tDescription | \r\n\t\t
| \r\n\t\t\t progressive_key \r\n\t\t\t | \r\n\t\t\tString | \r\n\t\t\tUse this key to check the status of your progress. When the first request is sent, a progressive key is returned in the response. | \r\n\t\t
If the operation is successful, the API returns a progressive key resource object with status of either 'INPROGRESS', 'DONE', or 'FAIL'. If there is a failure, an error object is returned with the appropriate error code.
Note: linkedtemplateid = A new id is generated when an iSheet template is added in the site.
","operationId":"deleteImportedIsheetTemplate","produces":["application/xml","application/json","text/xml"],"parameters":[{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"3"},{"name":"linkedtemplateid","in":"path","description":"Id of the linked template","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"This key is returned when a long-running operation is called and can be used to find the final status of the operation","schema":{"$ref":"#/definitions/ProgressiveKeyDBO"}},"401":{"description":"Unauthorised"},"403":{"description":"Validation failed | Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling API endpoint with the wrong method)"},"500":{"description":"Internal error occurred"}},"security":[{"OAuth":[]}]}},"/{version}/isheets/admin/choicelists/{choicelistid}":{"get":{"tags":["ISheet Admin API"],"summary":"To get choice list template","description":"This API will get individual choice list.
GET /api/{version}/isheets/admin/choicelists/{choicelistid}
Parameter Name | \r\n\t\t\tParameter Value | \r\n\t\t\tDescription | \r\n\t\t|||||||||||||||||||||||||||||||
| \r\n\t\t\t choicelistid \r\n\t\t\t | \r\n\t\t\tnumber | \r\n\t\t\tId of the choice list is to be get. | \r\n\t\t
API Error code | \r\n\t\t\tError message | \r\n\t\t\tDescription | \r\n\t\t
171 | \r\n\t\t\tThe name cannot be blank | \r\n\t\t\tIf the choice list name is empty. | \r\n\t\t
172 | \r\n\t\t\tThe name cannot be more than 256 characters | \r\n\t\t\tIf the choice list name exceeds 256 characters. | \r\n\t\t
174 | \r\n\t\t\tThe name 'Dummy choice' already exists in the system | \r\n\t\t\tIf the duplicate choice list name found. | \r\n\t\t
This API will delete the existing choice list.
DELETE /api/{version}/isheets/admin/choicelists/{choicelistid}
Parameter Name | \r\n\t\t\tParameter Value | \r\n\t\t\tDescription | \r\n\t\t
| \r\n\t\t\t choicelistid \r\n\t\t\t | \r\n\t\t\tnumber | \r\n\t\t\tId of the choice list is to be deleted. | \r\n\t\t
Note:
System admin or site admin of any site can able to access this API for delete choice list.
If user have system admin role, he/she can able to delete any choice list.
If user have site admin role, he/she can able to delete only own created choice list.
","operationId":"deleteChoiceListTemplate","produces":["application/xml","application/json","text/xml"],"parameters":[{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"8"},{"name":"choicelistid","in":"path","description":"Id of the choice list template","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"The API will return the 200 response code without any message"},"403":{"description":"Validation failed | Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"400":{"description":"Problem with parameters"},"401":{"description":"Unauthorised"},"500":{"description":"Internal server error"}},"security":[{"OAuth":[]}]}},"/{version}/isheets/admin/isheettemplate/{templateid}":{"post":{"tags":["ISheet Admin API"],"summary":"To import the iSheet templatein a site","description":"Use this method to import an iSheet template to a site
If the operation is successful the API returns a progressive key resource object . And based on this progressive key, can see the status of an isheet template otherwise an error object is returned with the appropriate error code.
To get the status of an iSheet template based on a progressive key
POST /api/3/progressivekeystatus/{progressive_key}
Name | \r\n\t\t\tType | \r\n\t\t\tDescription | \r\n\t\t
| \r\n\t\t\t progressive_key \r\n\t\t\t | \r\n\t\t\tString | \r\n\t\t\tYou can use this key to check the status of your progress. When the first request is sent, a progressive key is returned in response. | \r\n\t\t
If the operation is successful, the API returns a progressive key resource object with status of either 'INPROGRESS', 'DONE', or 'FAIL'. If there is a failure, an error object is returned with the appropriate error code.
Note: templateid is the id of the templates imported into the site from system admin
","operationId":"importIsheetTemplate","consumes":["application/xml","application/json","text/xml"],"produces":["application/xml","application/json","text/xml"],"parameters":[{"name":"templateid","in":"path","description":"Id of the template","required":true,"type":"string"},{"name":"siteid","in":"query","description":"Id of the site the template will be imported to","required":true,"type":"integer","format":"int32"},{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"3"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/importISheetTemplateDBO"}}],"responses":{"201":{"description":"This key is returned when a long-running operation is called and can be used to find the final status of the operation","schema":{"$ref":"#/definitions/ProgressiveKeyDBO"}},"401":{"description":"Unauthorised"},"403":{"description":"Validation failed | Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling API endpoint with the wrong method)"},"500":{"description":"Internal error occurred"}},"security":[{"OAuth":[]}]}},"/{version}/isheets/admin/{isheetid}/sortviews":{"get":{"tags":["ISheet Admin API"],"summary":"TO get the list of iSheet views sorted based on the position in ascending order","description":"This method is used to get the list of iSheet views sorted based on the position in ascending order
Note : As we can see in the UI, the response will display with iSheet views in the correct sequences.
","operationId":"getSortIsheetViews","produces":["application/xml","application/json","text/xml"],"parameters":[{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"3"},{"name":"isheetid","in":"path","description":"Id of the iSheet for which the views are to be obtained or sort","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"API will return the list of iSheet views sorted based on the position in ascending order","schema":{"$ref":"#/definitions/ISheetViews"}},"401":{"description":"Unauthorised"},"403":{"description":"Validation failed | Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling API endpoint with the wrong method)"},"500":{"description":"Internal error occurred"}},"security":[{"OAuth":[]}]},"put":{"tags":["ISheet Admin API"],"summary":"To update iSheet views' position in sorted order","description":"This method is used to update iSheet views' position in sorted order.
PUT /api/3/isheets/admin/{isheetid}/sortviews
Note : Need to manage sequences in request xml. we will refer this sequence for update. First iSheet view will be set as first and second will be set for second iSheet view.","operationId":"updateSortIsheetViews","consumes":["application/xml","application/json","text/xml"],"produces":["application/xml","application/json","text/xml"],"parameters":[{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"3"},{"name":"isheetid","in":"path","description":"Id of the iSheet","required":true,"type":"integer","format":"int32"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ISheetViews"}}],"responses":{"200":{"description":"The API will return the 200 response code without any message"},"401":{"description":"Unauthorised"},"403":{"description":"Validation failed | Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling API endpoint with the wrong method)"},"500":{"description":"Internal error occurred"}},"security":[{"OAuth":[]}]}},"/{version}/isheets/admin/isheettemplate/linkedtemplatelist":{"get":{"tags":["ISheet Admin API"],"summary":"To get the linked iSheet templates of the site","description":"
This method is used to get a list of iSheet templates which are imported in a site
Parameter Name | \r\n\t\t\tParameter Value | \r\n\t\t\tDescription | \r\n\t\t
| \r\n\t\t\t siteid \r\n\t\t\t | \r\n\t\t\tnumber | \r\n\t\t\tThe id of the site to get list of linked iSheet templates. | \r\n\t\t
Note : As we can see in the UI, the response will display with iSheet template in the correct sequences.
","operationId":"getLinkedtemplateList","produces":["application/xml","application/json","text/xml"],"parameters":[{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"3"},{"name":"siteid","in":"query","description":"Id of the site for which the template are to be obtained","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"API will return the list of imported iSheet reports.","schema":{"$ref":"#/definitions/ImportISheetTemplatesDBO"}},"401":{"description":"Unauthorised"},"403":{"description":"Validation failed | Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling API endpoint with the wrong method)"},"500":{"description":"Internal error occurred"}},"security":[{"OAuth":[]}]}},"/{version}/isheet/doctemplate/generatedocument/singlerecord/{doctemplateid}":{"get":{"tags":["ISheet Module"],"summary":"To download the single-record documents from iSheet","description":"This API call is used to download the single-record documents from iSheet.
Use the progress key to check the status and to download the generated doc template by calling the below API.
/api/{version}/isheet/doctemplate/generatedocument/{doctemplateid}/download?key={progressiveKey}Note: If the iSheet doc template is configured with the setting 'Download document' checked (this can be found in the add/edit manage document template page) then '
This API call is used to get a list of iSheet items.
Note: As seen in the UI, the response will be shown with iSheet views in the correct sequences.
","operationId":"getISheetItems","produces":["application/xml","application/json","text/xml","application/octet-stream"],"parameters":[{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"3"},{"name":"isheetid","in":"path","description":"Id of the iSheet","required":true,"type":"integer","format":"int32"},{"name":"sheetviewid","in":"query","description":"Id of the iSheet view. Optional. Default view will be returned","required":false,"type":"string"},{"name":"sortcolumnid","in":"query","description":"Id of the column to be sorted. Optional. First column sorting will be applied. The sort column id is necessary to pass, if the sort column is set.","required":false,"type":"string"},{"name":"sortorder","in":"query","description":"The sorting order. Optional. Default value : 0. Pass 1 for Ascending and 2 for Descending Order","required":false,"type":"string"},{"name":"limit","in":"query","description":"The maximum number of records to show per request. Optional. Default value : 100","required":false,"type":"string"},{"name":"offset","in":"query","description":"Offset allows us to specify which row to start from retrieving data. Optional. Default value : 0","required":false,"type":"string"}],"responses":{"200":{"description":"API will return the list of the iSheet items"},"401":{"description":"Unauthorised"},"403":{"description":"Validation failed | Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling API endpoint with the wrong method)"},"500":{"description":"Internal server error"}},"security":[{"OAuth":[]}]},"post":{"tags":["ISheet Module"],"summary":"To create the iSheet item","description":"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. |
<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>","operationId":"insertISheetItems","consumes":["application/xml","application/json","text/xml"],"produces":["application/xml","application/json","text/xml"],"parameters":[{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"3"},{"name":"isheetid","in":"path","description":"Id of the iSheet","required":true,"type":"integer","format":"int32"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/isheetDBO"}}],"responses":{"200":{"description":"This key is returned when a long-running operation is called and can be used to find the final status of the operation","schema":{"$ref":"#/definitions/ProgressiveKeyDBO"}},"401":{"description":"Unauthorised"},"403":{"description":"Validation failed | Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling API endpoint with the wrong method)"},"500":{"description":"Internal server error"}},"security":[{"OAuth":[]}]},"delete":{"tags":["ISheet Module"],"summary":"To delete iSheet item by iSheet id","description":"This API call is used to delete iSheet item. This supports multiple sheet items in a single call or all iSheet items.
To get the status of an iSheet item based on a progressive key
POST /api/{version}/progressivekeystatus/{progressiveKey}{progressiveKey} - This key is returned when a long-running operation is called and can be used to find the final status of the operation
\t<progressivekeyresponse>
\t\t<items>
\t\t\t<item>
\t\t\t\t<itemid>{itemId}</itemid>
\t\t\t\t<externalid>{externalId}</externalid>
\t\t\t\t<status>INPROGRESS or DONE or FAIL</status>
\t\t\t\t<statuscode>{statusCode (e.g. - 200)}</statuscode>
\t\t\t\t<message>{API response message (e.g. - Deleted successfully)}</message>
\t\t\t</item>
\t\t</items>
\t</progressivekeyresponse>","operationId":"deleteISheetItems","produces":["application/xml","application/json","text/xml"],"parameters":[{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"3"},{"name":"itemids","in":"query","description":"Id(s) of the iSheet item","required":true,"type":"string"},{"name":"isheetid","in":"path","description":"Id of the iSheet","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"API returns progressive object with status of either 'INPROGRESS', 'DONE', or 'FAIL'. Using the progressive key, an API user can see the status of an iSheet item.","schema":{"$ref":"#/definitions/ProgressiveKeyDBO"}},"401":{"description":"Unauthorised"},"403":{"description":"Validation failed | Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling API endpoint with the wrong method)"},"500":{"description":"Internal server error"}},"security":[{"OAuth":[]}]}},"/{version}/isheet/{isheetid}/items/{itemid}":{"get":{"tags":["ISheet Module"],"summary":"To get an iSheet items by item id","description":"This API call is used to get an iSheet item.
Note : As seen in the UI, the response will be shown with iSheet views in the correct sequences.
","operationId":"getISheetItem","produces":["application/xml","application/json","text/xml","application/octet-stream"],"parameters":[{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"3"},{"name":"isheetid","in":"path","description":"Id of the iSheet","required":true,"type":"integer","format":"int32"},{"name":"itemid","in":"path","description":"Id of the iSheet item","required":true,"type":"integer","format":"int32"},{"name":"sheetviewid","in":"query","description":"Id of the iSheet view. Optional. Default view will be returned","required":false,"type":"string"}],"responses":{"200":{"description":"API will return the specific iSheet item"},"401":{"description":"Unauthorised"},"403":{"description":"Validation failed | Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling API endpoint with the wrong method)"},"500":{"description":"Internal server error"}},"security":[{"OAuth":[]}]},"put":{"tags":["ISheet Module"],"summary":"To edit iSheet item by using the item id","description":"This API call is used to edit Isheet item by item ID.
","operationId":"editIsheetItem","consumes":["application/xml","application/json","text/xml"],"produces":["application/xml","application/json","text/xml","application/octet-stream"],"parameters":[{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"3"},{"name":"isheetid","in":"path","description":"Id of the iSheet","required":true,"type":"integer","format":"int32"},{"name":"itemid","in":"path","description":"Id of the iSheet item","required":true,"type":"integer","format":"int32"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/isheetDBO"}}],"responses":{"200":{"description":"The API will return the 200 response code without any message"},"401":{"description":"Unauthorised"},"403":{"description":"Validation failed | Forbidden","schema":{"$ref":"#/definitions/ItemErrorDBO"}},"405":{"description":"Method not allowed (calling API endpoint with the wrong method)"},"409":{"description":"Another user is editing the same rowid / Unable to aquire data source","schema":{"$ref":"#/definitions/ItemErrorDBO"}},"500":{"description":"Internal server error"}},"security":[{"OAuth":[]}]}},"/{version}/isheet/item/{itemid}/attachment/{attachmentid}":{"get":{"tags":["ISheet Module"],"summary":"To download the isheet item attachment","description":"This API call is used to download iSheet attachment.
","operationId":"downloadIsheetItemAttachment","produces":["application/json","application/xml","text/xml","application/octet-stream"],"parameters":[{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"3"},{"name":"itemid","in":"path","description":"Id of the iSheet item","required":true,"type":"integer","format":"int32"},{"name":"attachmentid","in":"path","description":"Id of the iSheet item attachment","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"The API will return the 200 response code without any message"},"401":{"description":"Unauthorised"},"403":{"description":"Validation failed | Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling API endpoint with the wrong method)"},"500":{"description":"Internal server error"}},"security":[{"OAuth":[]}]}},"/{version}/businessWorkflow/isheet/{isheetid}/search":{"post":{"tags":["ISheet Module"],"summary":"To get the number of records of the iSheet item","description":"This API call is used for Isheet item search record count.
","operationId":"businessWorkflowSheetItemSearch","consumes":["application/xml","application/json","text/xml"],"produces":["application/xml","application/json","text/xml"],"parameters":[{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"6"},{"name":"isheetid","in":"path","description":"Id of the iSheet","required":true,"type":"integer","format":"int32"},{"name":"limit","in":"query","description":"The maximum number of records to show per request","required":false,"type":"string","default":"100"},{"name":"offset","in":"query","description":"Offset allows us to specify which row to start from retrieving data","required":false,"type":"string","default":"0"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/isheetItemSearchDBO"}},{"name":"ruleId","in":"query","description":"ruleId of RuleDetails","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"API will return the count of totalRecords. Exa: { \"totalRecords\": {totalCounts} }"},"401":{"description":"Unauthorised"},"403":{"description":"Validation failed/ Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling API endpoint with the wrong method)"},"500":{"description":"Internal server error"}},"security":[{"OAuth":[]}]}},"/{version}/isheet/doctemplate/generatedocument/sitewide/{doctemplateid}":{"get":{"tags":["ISheet Module"],"summary":"Generate site-wide document","description":"This API call is used to download a site-wide documents from iSheet.
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. |
If generating a document that is in progress
\t<progressivekeyresponse>
\t\t<progressivekeystatus>INPROGRESS</progressivekeystatus>
\t</progressivekeyresponse>If generating a document that is now complete
\t<progressivekeyresponse>
\t\t<progressivekeystatus>DONE</progressivekeystatus>
\t\t<downloadlink>https://local.com/sitepont/api/{apiversion}/isheet/doctemplate/generatedocument/{docTemplateId}/download/key={progressiveKey}</downloadlink>
\t</progressivekeyresponse>Note : If the iSheet doc template is configured with the setting 'Download document' checked (this can be found in the add/edit manage document template page) then '
This API call is used to download the generated document template using /isheet/doctemplate/generatedocument API. And a key can be found in the response from the API.
If generating a document that is in progress
\t<progressivekeyresponse>
\t\t<progressivekeystatus>INPROGRESS</progressivekeystatus>
\t</progressivekeyresponse>If generating a document that is now complete
\t<progressivekeyresponse>
\t\t<progressivekeystatus>DONE</progressivekeystatus>
\t\t<downloadlink>https://local.com/sitepont/api//isheet/doctemplate/generatedocument/{docTemplateId}/download/key={progressiveKey}</downloadlink>
\t</progressivekeyresponse> Response will be in binary stream of document
","operationId":"downloadDocuAutoReport","produces":["application/xml","application/json","text/xml","application/octet-stream"],"parameters":[{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"3"},{"name":"key","in":"query","description":"The key generated in response of document generation api","required":true,"type":"string"},{"name":"doctemplateid","in":"path","description":"Id of the document template","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"The API will return the 200 response code without any message"},"400":{"description":"Problem with parsing XML or JSON object (Bad Request)"},"401":{"description":"Unauthorised"},"403":{"description":"Validation failed | Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling API endpoint with the wrong method)"},"500":{"description":"Internal server error"}},"security":[{"OAuth":[]}]}},"/{version}/isheet/{isheetid}/items/byexternalid/{externalid}":{"get":{"tags":["ISheet Module"],"summary":"To get iSheet item by the external id","description":"This API call is used to get iSheet item by external ID.
","operationId":"getISheetItemByExternalId","produces":["application/xml","application/json","text/xml"],"parameters":[{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"3"},{"name":"isheetid","in":"path","description":"Id of the iSheet","required":true,"type":"integer","format":"int32"},{"name":"externalid","in":"path","description":"External id of the iSheet","required":true,"type":"string"},{"name":"sheetviewid","in":"query","description":"Id of the iSheet view. Optional. Default view will be returned","required":false,"type":"string"}],"responses":{"200":{"description":"API will return a dynamic XML/JSON Object"},"401":{"description":"Unauthorised"},"403":{"description":"Validation failed | Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling API endpoint with the wrong method)"},"409":{"description":"Another user is editing the same rowid / Unable to aquire data source","schema":{"$ref":"#/definitions/ItemErrorDBO"}},"500":{"description":"Internal server error"}},"security":[{"OAuth":[]}]},"put":{"tags":["ISheet Module"],"summary":"To edit an iSheet item by using the external id","description":"This API call is used to edit an iSheet item by external id.
","operationId":"editIsheetItemByExternalID","consumes":["application/xml","application/json","text/xml"],"produces":["application/xml","application/json","text/xml","application/octet-stream"],"parameters":[{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"3"},{"name":"isheetid","in":"path","description":"Id of the iSheet","required":true,"type":"integer","format":"int32"},{"name":"externalid","in":"path","description":"External id of the iSheet","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/isheetDBO"}}],"responses":{"200":{"description":"The API will return the 200 response code without any message"},"401":{"description":"Unauthorised"},"403":{"description":"Validation failed | Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling API endpoint with the wrong method)"},"500":{"description":"Internal server error"}},"security":[{"OAuth":[]}]}},"/{version}/isheets/{isheetid}/attachment":{"get":{"tags":["ISheet Module"],"summary":"To download isheet items attachments zip","description":"Method to download isheet attachment zip.
If the operation is successful, the API returns approprivate file object.
In the case of a failure, an error object is returned with the appropriate error code.
This method is supported in version 8 of the API and above.
Method to prepare isheet attachment zip.
To get the status of zip creation process 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 | This key is returned when a long-running operation is called and can be used to find the final status of the operation |
If the operation is successful, the API returns a progressive key resource object. The possible status values are \"INPROGRESS\", \"DONE\" or \"FAIL\".
Also send zip creation id.
In the case of a failure, an error object is returned with the appropriate error code.
This method is supported in version 8 of the API and above.
This API call is used to get a list of audit history at iSheet level. Audit details like what, when and by whom the actions were performed, IP address of user, audit identification.
","operationId":"getISheetLevelAuditHistory","produces":["application/xml","application/json","text/xml"],"parameters":[{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"3"},{"name":"isheetid","in":"path","description":"Id of the iSheet","required":true,"type":"string"},{"name":"nextauditid","in":"query","description":"Next audit id to get the list of audit history from provided audit id.","required":false,"type":"string","default":"0"},{"name":"limit","in":"query","description":"The maximum number of records to show per request. Default value is 25","required":false,"type":"string","default":"25"}],"responses":{"200":{"description":"API will return the list of audit history for an iSheet","schema":{"$ref":"#/definitions/AuditsDBO"}},"401":{"description":"Unauthorised"},"403":{"description":"Validation failed | Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling API endpoint with the wrong method)"},"500":{"description":"Internal server error"}},"security":[{"OAuth":[]}]}},"/{version}/isheet/{isheetid}/items/{itemid}/audit":{"get":{"tags":["ISheet Module"],"summary":"To get the iSheet item level audit history","description":"This API call is used to get a list of audit history of an iSheet at item level. Audit details like what, when and by whom the actions were performed, IP address of user, audit identification.
","operationId":"getISheetItemLevelAuditHistory","produces":["application/xml","application/json","text/xml"],"parameters":[{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"3"},{"name":"isheetid","in":"path","description":"Id of the iSheet","required":true,"type":"string"},{"name":"itemid","in":"path","description":"Id of the iSheet item","required":true,"type":"string"},{"name":"nextauditid","in":"query","description":"Next audit id to get the list of audit history from provided audit id","required":false,"type":"string","default":"0"},{"name":"limit","in":"query","description":"The maximum number of records to show per request. Default value is 25","required":false,"type":"string","default":"25"}],"responses":{"200":{"description":"API will return the list of audit history of an iSheet item","schema":{"$ref":"#/definitions/AuditsDBO"}},"401":{"description":"Unauthorised"},"403":{"description":"Validation failed | Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling API endpoint with the wrong method)"},"500":{"description":"Internal server error"}},"security":[{"OAuth":[]}]}},"/{version}/isheet/{isheetid}/items/byexternalid":{"delete":{"tags":["ISheet Module"],"summary":"To delete the iSheet items by external id(s)","description":"This API call is used to delete iSheet items by using external id. This supports multiple sheet items in a single call or all iSheet items.
To get the status of an iSheet item based on a progressive key
POST /api/{version}/progressivekeystatus/{progressiveKey}{progressiveKey} - This key is returned when a long-running operation is called and can be used to find the final status of the operation
\t<progressivekeyresponse>
\t\t<items>
\t\t\t<item>
\t\t\t\t<itemid>{itemId}</itemid>
\t\t\t\t<externalid>{externalId}</externalid>
\t\t\t\t<status>INPROGRESS or DONE or FAIL</status>
\t\t\t\t<statuscode>{statusCode (e.g. - 200)}</statuscode>
\t\t\t\t<message>{API response message (e.g. - Deleted successfully)}</message>
\t\t\t</item>
\t\t</items>
\t</progressivekeyresponse>","operationId":"deleteISheetItemsByExternalIds","produces":["application/xml","application/json","text/xml","application/octet-stream"],"parameters":[{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"3"},{"name":"externalids","in":"query","description":"External id(s) of iSheet which is linked with an iSheet item id. You can get the external id from the get all iSheet item api call.This API call is used to upload file in iSheet for image and attachment column type fields.
The returned attachment id by calling progressive key API will be used in image or attachment column type while adding/updating an item.
The file should be added as multipart form data. Please note that the parameters are case sensitive.
Add iSheet Attachment API response
\t<progressivekeyresponse>
\t\t<progressivekey>{progressiveKey}</progressivekey>
\t\t<progressivekeystatus>INPROGRESS or DONE or FAIL</progressivekeystatus>
\t</progressivekeyresponse>To get the status of an iSheet attachment based on a progressive key
\t<progressivekeyresponse>
\t\t<progressivekeystatus>INPROGRESS or DONE or FAIL</progressivekeystatus>
\t\t<attachment>
\t\t<id>{attachmentId}</id>
\t\t</attachment>
\t</progressivekeyresponse>","operationId":"addISheetAttachment","consumes":["multipart/form-data"],"produces":["application/xml","application/json","text/xml","application/octet-stream"],"parameters":[{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"3"},{"name":"isheetid","in":"path","description":"Id of the iSheet","required":true,"type":"integer","format":"int32"},{"name":"file","in":"formData","description":"The parameter name should be the file and the value should be the file to be uploaded","required":true,"type":"file"},{"name":"filename","in":"formData","description":"Name of the newly created file","required":true,"type":"string"}],"responses":{"200":{"description":"This key is returned when a long-running operation is called and can be used to find the final status of the operation.","schema":{"$ref":"#/definitions/ProgressiveKeyDBO"}},"401":{"description":"Unauthorised"},"403":{"description":"Validation failed | Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling API endpoint with the wrong method)"},"500":{"description":"Internal server error"}},"security":[{"OAuth":[]}]}},"/{version}/isheet/{isheetid}/items/{itemid}/externalreference/{externalid}":{"put":{"tags":["ISheet Module"],"summary":"To set the external id for an existing iSheet item","description":"This API call is used to update the external ID for an existing iSheet item.
","operationId":"updateExternalIDToISheetItemID","consumes":["application/xml","application/json","text/xml"],"produces":["application/xml","application/json","text/xml","application/octet-stream"],"parameters":[{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"3"},{"name":"isheetid","in":"path","description":"Id of the iSheet","required":true,"type":"integer","format":"int32"},{"name":"externalid","in":"path","description":"External id of the iSheet","required":true,"type":"string"},{"name":"itemid","in":"path","description":"Id of the iSheet item","required":true,"type":"string"}],"responses":{"200":{"description":"The API will return the 200 response code without any message"},"401":{"description":"Unauthorised"},"403":{"description":"Validation failed | Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling API endpoint with the wrong method)"},"500":{"description":"Internal server error"}},"security":[{"OAuth":[]}]}},"/{version}/isheet/{isheetid}/search":{"post":{"tags":["ISheet Module"],"summary":"iSheet advanced search","description":"This API call is used for iSheet advanced search.
","operationId":"sheetItemSearch","consumes":["application/xml","application/json","text/xml"],"produces":["application/xml","application/json","text/xml"],"parameters":[{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"3"},{"name":"isheetid","in":"path","description":"Id of the iSheet","required":true,"type":"integer","format":"int32"},{"name":"limit","in":"query","description":"The maximum number of records to show per request","required":false,"type":"string","default":"100"},{"name":"offset","in":"query","description":"Offset allows us to specify which row to start from retrieving data","required":false,"type":"string","default":"0"},{"name":"sheetviewid","in":"query","description":"Id of the iSheet view","required":false,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/isheetItemSearchDBO"}}],"responses":{"200":{"description":"Will return a dynamic XML/JSON Object. i.e. JSON - { \"totalRecords\": {taotalCount} } Or XML -This method is used to get the list of iSheet template
Note: Only the linked iSheets are returned through this call.
","operationId":"getLinkTemplates","produces":["application/xml","application/json","text/xml"],"parameters":[{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"1"}],"responses":{"200":{"description":"API will return the list of iSheet templates","schema":{"$ref":"#/definitions/templateListDBO"}},"401":{"description":"Unauthorised"},"403":{"description":"Validation failed | Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling API endpoint with the wrong method)"},"500":{"description":"Internal server error"}},"security":[{"OAuth":[]}]}},"/{version}/isheets":{"get":{"tags":["ISheet API"],"summary":"To get the iSheet details","description":"This API will get the list of iSheets.
Specific type of iSheets e.g file metadata iSheet can be obtained by providing the type parameter.
Request : Method Type : Get, Request URL: /isheets?siteid=${siteid}&type=${type}
Parameters| Parameter Name | Value | Description |
|---|---|---|
| siteid | Int | The id of the site for which the iSheets are to be obtained. |
| type | string | Parameter to specify the type of iSheet to be obtained. The possible values are documentmetadata / foldermetadata / normal. |
<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
\t<isheets>
\t\t<isheet>
\t\t\t<name>SharePoint_Sheet</name>
\t\t\t<id>{Integer value of the }</id>
\t\t\t<type>{text value of one of the supported types}</type>
\t\t</isheet>
\t</isheets>
","operationId":"getISheets_1","produces":["application/xml","application/json","text/xml"],"parameters":[{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"1"},{"name":"siteid","in":"query","description":"Id of the site","required":true,"type":"integer","format":"int32"},{"name":"type","in":"query","description":"Type of the iSheet","required":false,"type":"string","enum":["normal","documentmetadata","foldermetadata"]}],"responses":{"200":{"description":"API will return the list of iSheets","schema":{"$ref":"#/definitions/ISheetsDBO"}},"401":{"description":"Unauthorised"},"403":{"description":"Validation failed | Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling API endpoint with the wrong method)"},"500":{"description":"Internal server error"}},"security":[{"OAuth":[]}]}},"/{version}/isheets/{isheetid}/columns":{"get":{"tags":["ISheet API"],"summary":"To get the iSheet columns","description":"This API will get the list of iSheet columns.
","operationId":"getColumns","produces":["application/xml","application/json","text/xml"],"parameters":[{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"1"},{"name":"isheetid","in":"path","description":"Id of the iSheet for which the column details are to be obtained","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"API will return the list of iSheet columns","schema":{"$ref":"#/definitions/columnListDBO"}},"401":{"description":"Unauthorised"},"403":{"description":"Validation failed | Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling API endpoint with the wrong method)"},"500":{"description":"Internal server error"}},"security":[{"OAuth":[]}]}},"/{version}/isheet/item/delete":{"post":{"tags":["ISheet API"],"summary":"To delete the records from the iSheet","description":"This API call is used to delete items/records from iSheet.
This method can only delete a record if it was added through an API call and an external id was provided for the record added.
This method does not support deletion of a record internally created in Collaborate, using the Collaborate interface.
| Name | Type | Description |
|---|---|---|
| siteid | int | The id of the site in which the iSheet exists |
| sheetid | int | Specific iSheet from which the records are to be deleted |
| items | int | These are the external ids of the system from which the records were imported, these ids can be obtained by a call to get external ids method |
This method is used to get the list of iSheets created using a specific iSheet template
","operationId":"getTemplateISheetsByTemplate","consumes":["application/xml","application/json","text/xml"],"produces":["application/xml","application/json","text/xml"],"parameters":[{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"1"},{"name":"templateid","in":"query","description":"The id of the template which was used to create the specific iSheets","required":true,"type":"string"}],"responses":{"200":{"description":"API will return the list of iSheets","schema":{"$ref":"#/definitions/templateISheetListDBO"}},"401":{"description":"Unauthorised"},"403":{"description":"Validation failed | Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling API endpoint with the wrong method)"},"500":{"description":"Internal server error"}},"security":[{"OAuth":[]}]}},"/{version}/isheet/templateisheet/column":{"get":{"tags":["ISheet API"],"summary":"To get the list of iSheets columns created using a specific iSheet template","description":"This method is used to get the list of iSheets columns created using a specific iSheet template
","operationId":"getColumnsByTemplateISheet","consumes":["application/xml","application/json","text/xml"],"produces":["application/xml","application/json","text/xml"],"parameters":[{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"1"},{"name":"templateisheetid","in":"query","description":"The id of the template which was used to create the specific iSheet columns","required":true,"type":"string"}],"responses":{"200":{"description":"API will return the list of columns","schema":{"$ref":"#/definitions/columnListDBO"}},"401":{"description":"Unauthorised"},"403":{"description":"Validation failed | Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling API endpoint with the wrong method)"},"500":{"description":"Internal server error"}},"security":[{"OAuth":[]}]}},"/{version}/isheet/externalId":{"get":{"tags":["ISheet API"],"summary":"To get external ids of the iSheet","description":"This method gives the external ids of iSheets in CSV format. The external ids are the id of the iSheet records added to the system by an earlier API call.
The client application can use these external ids to match the ids with the external system and perform operations.
If no external ids were added to the system when the records were added to the system, or the records were added through the Collaborate then no external ids will be returned for this call.
GET /isheet/externalId?sheetid={sheetid}&siteid={siteid}
","operationId":"getSheetExternalIDs","produces":["application/xml","application/json","text/xml"],"parameters":[{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"1"},{"name":"sheetid","in":"query","description":"Id of the iSheet for which the column details are to be obtained","required":true,"type":"string"},{"name":"siteid","in":"query","description":"Id of the site from which the external ID's are to be obtained","required":true,"type":"string"}],"responses":{"200":{"description":"API will return the CSV of external ids","schema":{"$ref":"#/definitions/ResponseDBO"}},"401":{"description":"Unauthorised"},"403":{"description":"Validation failed | Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling API endpoint with the wrong method)"},"500":{"description":"Internal server error"}},"security":[{"OAuth":[]}]}},"/{version}/isheet/item/create":{"post":{"tags":["ISheet API"],"summary":"To create records in the iSheet","description":"This API call is used to create iSheet items/records.
The request XML requires siteid and sheet id parameters to determine the iSheet to which the records will be added.
In order to add the records to the correct columns a column and value mapping is provided, which is associated with a sequence parameter.
the headColumn defines the names of the columns to which the content will be added and row data defines the values for those columns.
Please note that the attachments cannot be added to an attachments column using this method.
iSheets link column is also not supported through the API.
| Name | Type | Description |
|---|---|---|
| siteid | int | The id of the site in which the iSheet exists |
| sheetid | int | The iSheet id to which the records are to be added |
| headcolumn | string | The name of the columns to which a value is to be added |
| sequence | int | A number represending the sequence of the column in the iSheet |
| itemID (optional) | int | This parameter is to be used in case of file metadata iSheet, and is the id of the row which is to be updated. (Please note that the id can be obtained by inspecting the HTML of the page) |
| externalID | int | Item id of the item from the external system. This saves the external item id of the item in the system, this should be used later on to execute the delete operation |
The following iSheet column types are supported at this time:
This API call is used to get a list of iSheets created using a specific iSheet template.
Request : Method Type : Get, Request URL: /isheet/templateisheet?templateid={templateid}
Parameters
| Parameter Name | Value | Description |
|---|---|---|
| templateid | Int | The id of the template which was used to create the specific iSheets. |
<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
\t<site>
\t\t<siteid>1</siteid>
\t\t<sitename>Test site</sitename>
\t\t<template>
\t\t\t<templateid>1</templateid>
\t\t\t<templatelinkid>1</templatelinkid>
\t\t</template>
\t</site>
","operationId":"getLinkTemplateSheets","consumes":["application/xml","application/json","text/xml"],"produces":["application/xml","application/json","text/xml"],"parameters":[{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"1"},{"name":"templateid","in":"path","description":"Id of the template for get linked iSheets","required":true,"type":"string"}],"responses":{"200":{"description":"API will return the iSheets."},"401":{"description":"Unauthorised"},"403":{"description":"Validation failed/ Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling API endpoint with the wrong method)"},"500":{"description":"Internal server error"}},"security":[{"OAuth":[]}]}},"/{version}/files/{fileid}/isheetRecordID":{"get":{"tags":["ISheet API"],"summary":"To get the iSheet record id from a file","description":"This API call is used to get iSheet recordId form a fileId.
Collaborate site can be configured with a file metadata iSheet.
With a file metadata iSheet a new record is created in the file metadata iSheet when a file is uploaded to the files module of the site.
There can only be one file metadata isheet in a site.
On uploading the file to the files module the associated record in the file metadata isheet can be obtained by calling the following method.
This method can also be called for any existing file in the site, to update the metadata records for the file.
Call the isheetRecordID to obtain the isheet record which is to be updated.
Request
Method Type : Get, Request URL: files/${fileid}/isheetRecordID
Where fileid parameter is the id of the file for which the metadata record id is required
<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
\t<sheet>
\t\t<IsheetRecordID>{numeric record id} </IsheetRecordID>
\t</sheet>
Please note that the isheetRecordID parameter is case sensitive
In case of an invalid file id an error object is returned
<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
\t<error>
\t\t<ref>136 </ref>
\t\t<summary>File not found </summary>
\t</error>
","operationId":"getIsheetRecordID","produces":["application/xml","application/json","text/xml"],"parameters":[{"name":"version","in":"path","description":"Version of the api","required":true,"type":"string","default":"1"},{"name":"fileid","in":"path","description":"Id of the file to get the iSheet record id","required":true,"type":"string"}],"responses":{"200":{"description":"API will return the specific iSheet record id ","schema":{"$ref":"#/definitions/sheetDBO"}},"401":{"description":"Unauthorised"},"403":{"description":"Validation failed | Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling API endpoint with the wrong method)"},"500":{"description":"Internal server error"}},"security":[{"OAuth":[]}]}},"/{version}/tasks/{taskid}/isheetRecordID":{"get":{"tags":["ISheet API"],"summary":"To get the iSheet record from task","description":"This API call is used to get iSheet record id from a task id.
A site can be configured with a task metadata isheet. When a task is created in the task module, a new record is created in the task metadata iSheet.
Note: There can only be one task metadata iSheet in a site.
On creating the task in the task module, the associated record in the task metadata iSheet can be obtained by calling the following method.
This method can also be called for any existing tasks in the site, to update the metadata records for the task.
Call the isheetRecordID to obtain the isheet record which is to be updated.
This API call is used to get iSheet templates.
Note :
| Content Type | Scope of activities |
| Files | UPLOADED UPDATED LIKED |
| Wiki | CREATED EDITED LIKED |
| Blog | PUBLISHED EDITED LIKED |
| Events | CREATED EDITED LIKED |
| Comments | ADDED |
| Tasks | ADDED UPDATED |
| Content Type | Scope of activities |
| Files | UPLOADED UPDATED LIKED |
| Wiki | CREATED EDITED LIKED |
| Blog | PUBLISHED EDITED LIKED |
| Events | CREATED EDITED LIKED |
| Comments | ADDED |
| Tasks | ADDED UPDATED |
| Item id should be unique in xml. It is used to design sub menu. For e.g. itemid is used while creating the submenu. | ||||||||||||||||||||||||||||||||
<menuid> | Menu id of database. | ||||||||||||||||||||||||||||||||
<menutypealias> | menutypealias is mandatory field. Allowed values are [COLLABORATE_EXTERNAL_TYPE / COLLABORATE_SINGLE_CONTENT_TYPE / COLLABORATE_CONTAINER_TYPE] | ||||||||||||||||||||||||||||||||
<contenttypeid> | Content type id is mandatory field. Following values are allowed.
Content type id is used to identify the menu type. | ||||||||||||||||||||||||||||||||
<contentid> | content id is mandatory field. When contenttypeid is 30, following values are allowed for module type content type.
<contentid> should be -1 or greater than -1.
| ||||||||||||||||||||||||||||||||
<siteid> | Site is to identify that particular menu is belongs to which site. | ||||||||||||||||||||||||||||||||
<numberofcolumns> | Optional. But is mandatory in COLLABORATE_CONTAINER_TYPE. | ||||||||||||||||||||||||||||||||
<parentmenuid> | Optional. It is used to identify that menu is belongs to which container. | ||||||||||||||||||||||||||||||||
<displayorder> | Optional. It is used at the time of displaying menu order. | ||||||||||||||||||||||||||||||||
<externalurl> | Optional. But is mandatory in COLLABORATE_EXTERNAL_TYPE.Url pattern should be valid. | ||||||||||||||||||||||||||||||||
<linktarget> | Optional. But is mandatory in COLLABORATE_EXTERNAL_TYPE. Default value is _blank. | ||||||||||||||||||||||||||||||||
<mobilemenucssclassname> | Optional. Is used for mobile view for menu. | ||||||||||||||||||||||||||||||||
<mobilemenucssstyle> | Optional. Is used for mobile view for menu. | ||||||||||||||||||||||||||||||||
<mobilesubmenucssclassname> | Optional. Is used for mobile view css for sub menu. | ||||||||||||||||||||||||||||||||
<mobilesubmenucssstyle> | Optional. Is used for mobile view css for sub menu. | ||||||||||||||||||||||||||||||||
<menucssclassname> | Optional. Is used for desktop/tablet view css for menu. | ||||||||||||||||||||||||||||||||
<menucssstyle> | Optional. Is used for desktop/tablet view css for menu. | ||||||||||||||||||||||||||||||||
<submenucssclassname> | Optional. Is used for desktop/tablet view css for sub menu. | ||||||||||||||||||||||||||||||||
<submenucssstyle> | Optional. Is used for desktop/tablet view css for sub menu. | ||||||||||||||||||||||||||||||||
<submenualign> | Optional. Is used in for COLLABORATE_CONTAINER_TYPE. Default value is left. And Allowed value is left/right. | ||||||||||||||||||||||||||||||||
<sheetviewid> | Optional. Is used when contenttypeid is 31. | ||||||||||||||||||||||||||||||||
<sheetitemid> | Optional. Is used when contenttypeid is 23. | ||||||||||||||||||||||||||||||||
<sheetviewmode> | Optional. 0 or 1 value is allowed. Otherwise default value 0 will be consider. | ||||||||||||||||||||||||||||||||
<menuitemtitle> | Is used to set the multilingual values for the menu or submenu. English UK is mandatory.
| ||||||||||||||||||||||||||||||||
<title> | Title is used for menu label. | ||||||||||||||||||||||||||||||||
<tooltip> | Optional. If tooltip is not exists and <title> is exists then <title> value will be consider as <tooltip> value. | ||||||||||||||||||||||||||||||||
<language> | Language is mandatory field in <menutitle>. |
| Item id should be unique in xml. It is used to design sub menu. For e.g. itemid is used while creating the submenu. | ||||||||||||||||||||||||||||||||
<menuid> | Menu id of database. | ||||||||||||||||||||||||||||||||
<menutypealias> | menutypealias is mandatory field. Allowed values are [COLLABORATE_EXTERNAL_TYPE / COLLABORATE_SINGLE_CONTENT_TYPE / COLLABORATE_CONTAINER_TYPE] | ||||||||||||||||||||||||||||||||
<contenttypeid> | Content type id is mandatory field. Following values are allowed.
Content type id is used to identify the menu type. | ||||||||||||||||||||||||||||||||
<contentid> | content id is mandatory field. When contenttypeid is 30, following values are allowed for module type content type.
<contentid> should be -1 or greater than -1.
| ||||||||||||||||||||||||||||||||
<siteid> | Site is to identify that particular menu is belongs to which site. | ||||||||||||||||||||||||||||||||
<numberofcolumns> | Optional. But is mandatory in COLLABORATE_CONTAINER_TYPE. | ||||||||||||||||||||||||||||||||
<parentmenuid> | Optional. It is used to identify that menu is belongs to which container. | ||||||||||||||||||||||||||||||||
<displayorder> | Optional. It is used at the time of displaying menu order. | ||||||||||||||||||||||||||||||||
<externalurl> | Optional. But is mandatory in COLLABORATE_EXTERNAL_TYPE.Url pattern should be valid. | ||||||||||||||||||||||||||||||||
<linktarget> | Optional. But is mandatory in COLLABORATE_EXTERNAL_TYPE. Default value is _blank. | ||||||||||||||||||||||||||||||||
<mobilemenucssclassname> | Optional. Is used for mobile view for menu. | ||||||||||||||||||||||||||||||||
<mobilemenucssstyle> | Optional. Is used for mobile view for menu. | ||||||||||||||||||||||||||||||||
<mobilesubmenucssclassname> | Optional. Is used for mobile view css for sub menu. | ||||||||||||||||||||||||||||||||
<mobilesubmenucssstyle> | Optional. Is used for mobile view css for sub menu. | ||||||||||||||||||||||||||||||||
<menucssclassname> | Optional. Is used for desktop/tablet view css for menu. | ||||||||||||||||||||||||||||||||
<menucssstyle> | Optional. Is used for desktop/tablet view css for menu. | ||||||||||||||||||||||||||||||||
<submenucssclassname> | Optional. Is used for desktop/tablet view css for sub menu. | ||||||||||||||||||||||||||||||||
<submenucssstyle> | Optional. Is used for desktop/tablet view css for sub menu. | ||||||||||||||||||||||||||||||||
<submenualign> | Optional. Is used in for COLLABORATE_CONTAINER_TYPE. Default value is left. And Allowed value is left/right. | ||||||||||||||||||||||||||||||||
<sheetviewid> | Optional. Is used when contenttypeid is 31. | ||||||||||||||||||||||||||||||||
<sheetitemid> | Optional. Is used when contenttypeid is 23. | ||||||||||||||||||||||||||||||||
<sheetviewmode> | Optional. 0 or 1 value is allowed. Otherwise default value 0 will be consider. | ||||||||||||||||||||||||||||||||
<menuitemtitle> | Is used to set the multilingual values for the menu or submenu. English UK is mandatory.
| ||||||||||||||||||||||||||||||||
<title> | Title is used for menu label. | ||||||||||||||||||||||||||||||||
<tooltip> | Optional. If tooltip is not exists and <title> is exists then <title> value will be consider as <tooltip> value. | ||||||||||||||||||||||||||||||||
<language> | Language is mandatory field in <menutitle>. |
Get a domain list in an organisation within Collaborate\r\nThis API call is used to get list of domains in an organisation object in the system.
Error Codes
| Summary | \r\n\t\t\tRef Code (V4) | \r\n\t\t\tRef Code (before V4) | \r\n\t\t
| \r\n\t\t\t The Organisation id is invalid \r\n\t\t\t | \r\n\t\t\t260 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The given domain id is invalid \r\n\t\t\t | \r\n\t\t\t263 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The organisation id does not match with the domain id \r\n\t\t\t | \r\n\t\t\t264 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The ordertype is invalid \r\n\t\t\t | \r\n\t\t\t289 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The orderby value is invalid. Please use either asc or desc \r\n\t\t\t | \r\n\t\t\t290 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t You donot have access to the given organisation \r\n\t\t\t | \r\n\t\t\t396 | \r\n\t\t\tN/A | \r\n\t\t
JIRA Ticket : https://dev.highq.com/jira/browse/COL-64098
This method is used to add a new domain to an organisation within Collaborate. This API call is used to add a new domain to an organisation object in the system.
| Summary | \r\n\t\t\tRef Code (V4) | \r\n\t\t\tRef Code (before V4) | \r\n\t\t
| \r\n\t\t\t The Organisation id is invalid \r\n\t\t\t | \r\n\t\t\t260 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t A domain name is required \r\n\t\t\t | \r\n\t\t\t265 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The domain name formatting is incorrect \r\n\t\t\t | \r\n\t\t\t266 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The domain status is required \r\n\t\t\t | \r\n\t\t\t267 | \r\n\t\t\t\r\n\t\t\t N/A \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t The domain status is invalid. It must either be active or pending \r\n\t\t\t | \r\n\t\t\t268 | \r\n\t\t\t\r\n\t\t\t N/A \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t The domain name 'domainname.com' already exists \r\n\t\t\t | \r\n\t\t\t314 | \r\n\t\t\t\r\n\t\t\t N/A \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t The contact person's email address domain is already being used by another organisation \r\n\t\t\t | \r\n\t\t\t315 | \r\n\t\t\tN/A | \r\n\t\t
JIRA Ticket : https://dev.highq.com/jira/browse/COL-62794
","operationId":"addOrgDomain","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"version","in":"path","description":"version","required":true,"type":"string"},{"name":"orgid","in":"query","description":"\tThe ID of the organisation to add the new domain to ","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/domain"}}],"responses":{"201":{"description":"OK","schema":{"$ref":"#/definitions/DomainDBO"}},"400":{"description":"4xx Fail transaction(Client Side)","schema":{"$ref":"#/definitions/ErrorDBO"}},"500":{"description":"5xx Fail transaction(Server Side)","schema":{"$ref":"#/definitions/ErrorDBO"}}},"security":[{"OAuth":[]}]}},"/{version}/domains/{domainID}":{"get":{"tags":["Domains"],"summary":"Get Domain","description":"Get a domain to an organisation within Collaborate.This API call is used to get a domain to an organisation object in the system.
Error Codes
| Summary | \r\n\t\t\tRef Code (V4) | \r\n\t\t\tRef Code (before V4) | \r\n\t\t
| \r\n\t\t\t The given domain id is invalid \r\n\t\t\t | \r\n\t\t\t263 | \r\n\t\t\tN/A | \r\n\t\t
JIRA Ticket : https://dev.highq.com/jira/browse/COL-63884
Move an existing domain from one organisation to another within Collaborate\r\nThis API call is used to move a domain to a new organisation object in the system. This in turn will move all users who have an email address associated with that domain to the new organisation.
Error Codes
| Summary | \r\n\t\t\tRef Code (V4) | \r\n\t\t\tRef Code (before V4) | \r\n\t\t
| \r\n\t\t\t The given domain id is invalid \r\n\t\t\t | \r\n\t\t\t263 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The Organisation id is invalid (Target Organisation id) \r\n\t\t\t | \r\n\t\t\t261 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t Please select different organisation \r\n\t\t\t | \r\n\t\t\t262 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The domain cannot be moved to a bidder organisation \r\n\t\t\t | \r\n\t\t\t316 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t An exception domain cannot be moved to any organisation \r\n\t\t\t | \r\n\t\t\t323 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The domain already exists in the given organisation. Please select a different organisation \r\n\t\t\t | \r\n\t\t\t324 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The Organisation id is required \r\n\t\t\t | \r\n\t\t\t322 | \r\n\t\t\tN/A | \r\n\t\t
JIRA Ticket : https://dev.highq.com/jira/browse/COL-62796
Update an existing domain in an organisation within Collaborate.This API call is used to change a domain within an organisation object in the system. This in turn will update the email address of all users within that organisation who have this domain assigned to their email address.
| Summary | \r\n\t\t\tRef Code (V4) | \r\n\t\t\tRef Code (before V4) | \r\n\t\t
| \r\n\t\t\t The given domain id is invalid \r\n\t\t\t | \r\n\t\t\t263 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t A domain name is required \r\n\t\t\t | \r\n\t\t\t265 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The domain name formatting is incorrect \r\n\t\t\t | \r\n\t\t\t266 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The domain status is required \r\n\t\t\t | \r\n\t\t\t267 | \r\n\t\t\t\r\n\t\t\t N/A \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t The domain status is invalid. It must either be active or pending \r\n\t\t\t | \r\n\t\t\t268 | \r\n\t\t\t\r\n\t\t\t N/A \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t The domain name 'domainname.com' already exists \r\n\t\t\t | \r\n\t\t\t314 | \r\n\t\t\t\r\n\t\t\t N/A \r\n\t\t\t | \r\n\t\t
JIRA Ticket : https://dev.highq.com/jira/browse/COL-62795
This API is used to archive a domain to an organisation within CollaborateThis API call is used to archive a domain to an organisation object in the system.
Error Codes
| Summary | \r\n\t\t\tRef Code (V4) | \r\n\t\t\tRef Code (Before V4) | \r\n\t\t
|---|---|---|
| The given domain ID is invalid | \r\n\t\t\t263 | \r\n\t\t\tN/A | \r\n\t\t
JIRA Ticket : https://dev.highq.com/jira/browse/COL-63885
Get a list of organisations. This API call is used to retrieve a list of organisations from the system.
Error Codes
| Summary | \r\n\t\t\tRef Code (V4) | \r\n\t\t\tRef Code (before V4) | \r\n\t\t
| \r\n\t\t\t The industry is invalid \r\n\t\t\t | \r\n\t\t\t293 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The category is invalid \r\n\t\t\t | \r\n\t\t\t294 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The status is invalid. \r\n\t\t\t | \r\n\t\t\t295 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The limit value is invalid. \r\n\t\t\t | \r\n\t\t\t291 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The offset value is invalid. \r\n\t\t\t | \r\n\t\t\t292 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The ordertype is invalid. \r\n\t\t\t | \r\n\t\t\t289 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The orderby value is invalid. Please use either asc or desc \r\n\t\t\t | \r\n\t\t\t290 | \r\n\t\t\tN/A | \r\n\t\t
JIRA Ticket : https://dev.highq.com/jira/browse/COL-62789
Add a new organisation to Collaborate.This API call is used to add a new organisation object to the system.
Error Codes
| Summary | \r\n\t\t\tRef Code (V4) | \r\n\t\t\tRef Code (before V4) | \r\n\t\t
| \r\n\t\t\t The contact tier is invalid \r\n\t\t\t | \r\n\t\t\t275 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The contact type id is invalid \r\n\t\t\t | \r\n\t\t\t276 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t Contact email is invalid \r\n\t\t\t | \r\n\t\t\t278 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The internal organisation attribute is invalid \r\n\t\t\t | \r\n\t\t\t284 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The organisation status is invalid. It must either be active or pending \r\n\t\t\t | \r\n\t\t\t274 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The organisation industry ID is invalid \r\n\t\t\t | \r\n\t\t\t273 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The disable edit profile attribute is invalid \r\n\t\t\t | \r\n\t\t\t285 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The restrict direct login attribute is invalid \r\n\t\t\t | \r\n\t\t\t286 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The organisation strategic attribute is invalid \r\n\t\t\t | \r\n\t\t\t287 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t keycontact userid attribute is required \r\n\t\t\t | \r\n\t\t\t288 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The keycontact userid attribute is invalid \r\n\t\t\t | \r\n\t\t\t312 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The organisation name is required \r\n\t\t\t | \r\n\t\t\t269 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The organisation name cannot be more than 128 characters \r\n\t\t\t | \r\n\t\t\t270 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t A contact name is required \r\n\t\t\t | \r\n\t\t\t277 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t An email address is required \r\n\t\t\t | \r\n\t\t\t278 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t Enter a valid contact primary email address \r\n\t\t\t | \r\n\t\t\t279 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t A company switchboard is required \r\n\t\t\t | \r\n\t\t\t280 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The online service link is invalid \r\n\t\t\t | \r\n\t\t\t281 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The organisation name cannot contain the following characters: \\\\ / : * ? \\" | \r\n\t\t\t | \r\n\t\t\t282 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t This organisation name already exists in system \r\n\t\t\t | \r\n\t\t\t317 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The contact person's email address domain is already being used by another organisation \r\n\t\t\t | \r\n\t\t\t315 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The external ID entered already exists in system \r\n\t\t\t | \r\n\t\t\t407 | \r\n\t\t\tN/A | \r\n\t\t
JIRA Ticket : https://dev.highq.com/jira/browse/COL-62781
This API call is used to get an address to an organisation object in the system.
Error Codes
| Summary | \r\n\t\t\tRef Code (V4) | \r\n\t\t\tRef Code (before V4) | \r\n\t\t
| \r\n\t\t\t The given address ID is invalid \r\n\t\t\t | \r\n\t\t\t308 | \r\n\t\t\t\r\n\t\t\t N/A \r\n\t\t\t | \r\n\t\t
JIRA Ticket : https://dev.highq.com/jira/browse/COL-63740
This API call is used to change an address within an organisation object in the system.
Error Codes
| Summary | \r\n\t\t\tRef Code (V4) | \r\n\t\t\tRef code (before V4) | \r\n\t\t
| \r\n\t\t\t The given address ID is invalid \r\n\t\t\t | \r\n\t\t\t308 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t You do not have access to the given organisation ID \r\n\t\t\t | \r\n\t\t\t318 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The address countryname is required. \r\n\t\t\t | \r\n\t\t\t319 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The address countryname is invalid. \r\n\t\t\t | \r\n\t\t\t309 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The defaultaddress attribute is invalid. It must be 1 or 0 \r\n\t\t\t | \r\n\t\t\t313 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t A city name is required \r\n\t\t\t | \r\n\t\t\t301 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t A city name can have a maximum of 50 characters \r\n\t\t\t | \r\n\t\t\t302 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t A postal code can have a maximum of 50 characters \r\n\t\t\t | \r\n\t\t\t303 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The entered address' external ID already exists in the system \r\n\t\t\t | \r\n\t\t\t413 | \r\n\t\t\t\r\n\t\t |
JIRA Ticket : https://dev.highq.com/jira/browse/COL-63738
This API call is used to delete an address to an organisation object in the system.
Error Codes
| Summary | \r\nRef Code (V4) | \r\nRef Code (before V4) | \r\n
| \r\n The given address ID is invalid \r\n | \r\n 308 | \r\n\r\n |
JIRA Ticket : https://dev.highq.com/jira/browse/COL-63739
This API call is used to get a list of departments in an organisation object in the system.
Error Codes
| Summary | \r\n\t\t\tRef Code (V4) | \r\n\t\t\tRef Code (before V4) | \r\n\t\t
| \r\n\t\t\t The ordertype is invalid. name and ID are supported ordertype \r\n\t\t\t | \r\n\t\t\t351 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The orderby value is invalid. asc and desc are supported orderby values. \r\n\t\t\t | \r\n\t\t\t147 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The Organisation ID is invalid \r\n\t\t\t | \r\n\t\t\t260 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t You do not have access to the given organisation ID \r\n\t\t\t | \r\n\t\t\t318 | \r\n\t\t\t\r\n\t\t |
JIRA Ticket : https://dev.highq.com/jira/browse/COL-65701
This API call is used to add a new department to an organisation object in the system.
Error Codes
| Summary | \r\nRef Code (V4) | \r\nRef Code (before V4) | \r\n
| \r\n The Organisation ID is invalid \r\n | \r\n 260 | \r\n\r\n |
| \r\n This department name already exists \r\n | \r\n 370 | \r\n\r\n |
| \r\n You do not have the permissions to create a department within this organisation \r\n | \r\n 318 | \r\n\r\n |
JIRA Ticket : https://dev.highq.com/jira/browse/COL-65697
This API call is used to get a department from an organisation object in the system.
Error Codes
| Summary | \r\n\t\t\tRef Code (V4) | \r\n\t\t\tRef Code (before V4) | \r\n\t\t
| \r\n\t\t\t Department ID is invalid \r\n\t\t\t | \r\n\t\t\t349 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t You do not have permissions to view this Department ID \r\n\t\t\t | \r\n\t\t\t350 | \r\n\t\t\t\r\n\t\t |
JIRA Ticket : https://dev.highq.com/jira/browse/COL-65700
This API call is used to change a department within an organisation object in the system.
Error Codes
| Summary | \r\n\t\t\tRef Code (V4) | \r\n\t\t\tRef Code (before V4) | \r\n\t\t
| \r\n\t\t\t This department name already exists \r\n\t\t\t | \r\n\t\t\t370 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The Department ID is invalid \r\n\t\t\t | \r\n\t\t\t349 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The department status is invalid. Please use the active status. \r\n\t\t\t | \r\n\t\t\t344 | \r\n\t\t\t\r\n\t\t |
JIRA Ticket : https://dev.highq.com/jira/browse/COL-65698
This API call is used to delete a department to an organisation object in the system.
Error Codes
| Summary | \r\n\t\t\tRef Code (V4) | \r\n\t\t\tRef Code (before V4) | \r\n\t\t
| \r\n\t\t\t Department ID is invalid \r\n\t\t\t | \r\n\t\t\t349 | \r\n\t\t\t\r\n\t\t |
JIRA Ticket : https://dev.highq.com/jira/browse/COL-65699
This API call is used to get list of a addresses in an organisation object in the system.
Error Codes
| Summary | \r\nRef Code (V4) | \r\nRef Code (before V4) | \r\n
| \r\n The Organisation ID is invalid \r\n | \r\n 260 | \r\n\r\n |
JIRA Ticket : https://dev.highq.com/jira/browse/COL-64267
This API call is used to add a new address to an organisation object in the system.
Error Codes
| Summary | \r\nRef Code (V4) | \r\nRef Code (before V4) | \r\n
| \r\n The entered address' external ID already exists in the system \r\n | \r\n 413 | \r\nN/A | \r\n
JIRA Ticket : https://dev.highq.com/jira/browse/COL-63737
Get a list of countries.This API call is used to retrieve a list of countries from the system.
JIRA Ticket : https://dev.highq.com/jira/browse/COL-69562
Get an organisation from Collaborate.This API call is used to retrieve an organisation from the system. The organisation identifier is the organisation ID.
Error Codes
| Summary | \r\n\t\t\tRef Code (V4) | \r\n\t\t\tRef Code (before V4) | \r\n\t\t
| \r\n\t\t\t The Organisation id is invalid \r\n\t\t\t | \r\n\t\t\t260 | \r\n\t\t\tN/A | \r\n\t\t
JIRA Ticket : https://dev.highq.com/jira/browse/COL-62788
Update an existing organisation in Collaborate.This API call is used to update an existing organisation in the system, by replacing the organisation with the provided organisation object.
Error Codes
| Summary | \r\n\t\t\tRef Code (V4) | \r\n\t\t\tRef Code (before V4) | \r\n\t\t
| \r\n\t\t\t The organisation ID is invalid \r\n\t\t\t | \r\n\t\t\t260 | \r\n\t\t\t\r\n\t\t\t N/A \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t This group is associated with the site(s) listed below \r\n\t\t\t | \r\n\t\t\t283 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The contact tier is invalid \r\n\t\t\t | \r\n\t\t\t275 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The contact type ID is invalid \r\n\t\t\t | \r\n\t\t\t276 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t Contact email is invalid \r\n\t\t\t | \r\n\t\t\t278 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The internal organisation attribute is invalid \r\n\t\t\t | \r\n\t\t\t284 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The organisation status is invalid. It must either be active or pending \r\n\t\t\t | \r\n\t\t\t274 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The organisation industry id is invalid \r\n\t\t\t | \r\n\t\t\t273 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The disable edit profile attribute is invalid \r\n\t\t\t | \r\n\t\t\t285 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The restrict direct login attribute is invalid \r\n\t\t\t | \r\n\t\t\t286 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The organisation strategic attribute is invalid \r\n\t\t\t | \r\n\t\t\t287 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t keycontact userid attribute is required \r\n\t\t\t | \r\n\t\t\t288 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The keycontact userid attribute is invalid \r\n\t\t\t | \r\n\t\t\t312 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The organisation name is required \r\n\t\t\t | \r\n\t\t\t269 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The organisation name cannot be more than 128 characters \r\n\t\t\t | \r\n\t\t\t270 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t A contact name is required \r\n\t\t\t | \r\n\t\t\t277 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t An email address is required \r\n\t\t\t | \r\n\t\t\t278 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t Enter a valid contact primary email address \r\n\t\t\t | \r\n\t\t\t279 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t A company switchboard is required \r\n\t\t\t | \r\n\t\t\t280 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The online service link is invalid \r\n\t\t\t | \r\n\t\t\t281 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The organisation name cannot contain the following characters: \\\\ / : * ? \\" | \r\n\t\t\t | \r\n\t\t\t282 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t This organisation name already exists in system. \r\n\t\t\t | \r\n\t\t\t317 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The contact person's email address domain is already being used by another organisation \r\n\t\t\t | \r\n\t\t\t315 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The external ID entered already exists in system \r\n\t\t\t | \r\n\t\t\t407 | \r\n\t\t\tN/A | \r\n\t\t
JIRA Ticket : https://dev.highq.com/jira/browse/COL-62783
Archive an organisation within Collaborate.This API call is used to archive an organisation within the system. The organisation identifier is the organisation ID.
Error Codes
| Summary | \r\n\t\t\tRef Code (V4) | \r\n\t\t\tRef Code (before V4) | \r\n\t\t
| \r\n\t\t\t The Organisation ID is invalid \r\n\t\t\t | \r\n\t\t\t260 | \r\n\t\t\tN/A | \r\n\t\t
JIRA Ticket : https://dev.highq.com/jira/browse/COL-62784
This API call is used to get list of exception domain objects in the system.\r\n
Error Codes
| Summary | \r\n\t\t\tRef Code (V4) | \r\n\t\t\tRef Code (before V4) | \r\n\t\t
| \r\n\t\t\t The given domain id is invalid \r\n\t\t\t | \r\n\t\t\t263 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The ordertype is invalid. \r\n\t\t\t | \r\n\t\t\t289 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The orderby value is invalid. Please use either ascending or descending \r\n\t\t\t | \r\n\t\t\t290 | \r\n\t\t\tN/A | \r\n\t\t
JIRA Ticket : https://dev.highq.com/jira/browse/COL-64103
This API call is used to add a new exception domain to an organisation object in the system.
| Summary | \r\n\t\t\tRef Code (V4) | \r\n\t\t\tRef Code (before V4) | \r\n\t\t
| \r\n\t\t\t A domain name is required \r\n\t\t\t | \r\n\t\t\t265 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The domain name formatting is incorrect \r\n\t\t\t | \r\n\t\t\t266 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The domain status is required \r\n\t\t\t | \r\n\t\t\t267 | \r\n\t\t\t\r\n\t\t\t N/A \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t The domain status is invalid. It must either be active or pending \r\n\t\t\t | \r\n\t\t\t268 | \r\n\t\t\t\r\n\t\t\t N/A \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t The domain name 'domainname.com' already exists \r\n\t\t\t | \r\n\t\t\t314 | \r\n\t\t\t\r\n\t\t\t N/A \r\n\t\t\t | \r\n\t\t
JIRA Ticket : https://dev.highq.com/jira/browse/COL-64099
","operationId":"addExceptionalDomain","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"version","in":"path","description":"version of api","required":true,"type":"string","default":"4"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/domain"}}],"responses":{"201":{"description":"OK","schema":{"$ref":"#/definitions/DomainDBO"}},"400":{"description":"4xx Fail transaction(Client Side)","schema":{"$ref":"#/definitions/ErrorDBO"}},"500":{"description":"5xx Fail transaction(Server Side)","schema":{"$ref":"#/definitions/ErrorDBO"}}},"security":[{"OAuth":[]}]}},"/{version}/exceptiondomains/{domainID}":{"get":{"tags":["Exceptiondomains"],"summary":"Get exception domain","description":"This API call is used to get a exception domain object in the system.
Error Codes
| Summary | \r\n\t\t\tRef Code (V4) | \r\n\t\t\tRef Code (before V4) | \r\n\t\t
| \r\n\t\t\t The given domain id is invalid \r\n\t\t\t | \r\n\t\t\t263 | \r\n\t\t\tN/A | \r\n\t\t
JIRA Ticket : https://dev.highq.com/jira/browse/COL-64101
This API call is used to change an exception domain within an organisation object in the system.
Error Codes
| Summary | \r\n\t\t\tRef Code (V4) | \r\n\t\t\tRef Code (before V4) | \r\n\t\t
| \r\n\t\t\t The given domain id is invalid \r\n\t\t\t | \r\n\t\t\t263 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t A domain name is required \r\n\t\t\t | \r\n\t\t\t265 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The domain name formatting is incorrect \r\n\t\t\t | \r\n\t\t\t266 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The domain status is invalid. It must either be active or pending \r\n\t\t\t | \r\n\t\t\t268 | \r\n\t\t\t\r\n\t\t\t N/A \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t The domain name 'domainname.com' already exists \r\n\t\t\t | \r\n\t\t\t314 | \r\n\t\t\t\r\n\t\t\t N/A \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t An anonymous domain cannot be updated \r\n\t\t\t | \r\n\t\t\t392 | \r\n\t\t\t\r\n\t\t |
JIRA Ticket : https://dev.highq.com/jira/browse/COL-64100
This API call is used to delete a domain in the system.
Error Codes
| Summary | \r\n\t\t\tRef Code (V4) | \r\n\t\t\tRef Code (before V4) | \r\n\t\t
| \r\n\t\t\t The given domain id is invalid \r\n\t\t\t | \r\n\t\t\t263 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t An anonymous domain cannot be archived \r\n\t\t\t | \r\n\t\t\t393 | \r\n\t\t\t\r\n\t\t |
JIRA Ticket : https://dev.highq.com/jira/browse/COL-64102
Get a social link list in Collaborate.
JIRA Ticket : https://dev.highq.com/jira/browse/COL-72703
Get a messaging link list in Collaborate.
JIRA Ticket : https://dev.highq.com/jira/browse/COL-72704
Get manage tool status in Collaborate
JIRA Ticket : https://dev.highq.com/jira/browse/COL-73530
API to import template from .hqa file.
This is a Long polling API( Multi step API). Below are the steps explaning how to consume this API.
API method to obtain site categories
","operationId":"getSitesCategory","produces":["application/xml","application/json"],"parameters":[{"name":"version","in":"path","description":"version of api","required":true,"type":"string","default":"1"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/categories"}},"400":{"description":"Problem with parsing XML or JSON object (Bad Request)"},"401":{"description":"Unauthorised"},"403":{"description":"Validation failed/Forbidden"},"405":{"description":"Method not allowed (calling API with the wrong method)"},"500":{"description":"Internal error occurred while obtaining site templates"}},"security":[{"OAuth":[]}]}},"/{version}/sites/{siteid}/groups/{groupid}":{"get":{"tags":["Site Resource APIs"],"summary":"Get site group","description":"Get details of individual site group
","operationId":"getSiteGroup","produces":["application/xml","application/json"],"parameters":[{"name":"siteid","in":"path","description":"site id","required":true,"type":"string"},{"name":"groupid","in":"path","description":"site group id to retrive","required":true,"type":"string"},{"name":"version","in":"path","description":"version","required":true,"type":"string","default":"3"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/group"}},"401":{"description":"Unauthorized"},"403":{"description":"Validation failed/ Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling api with wrong method)","schema":{"$ref":"#/definitions/ErrorDBO"}},"500":{"description":"Internal error occured while gettting site"}},"security":[{"OAuth":[]}]},"post":{"tags":["Site Resource APIs"],"summary":"Add existing group to site","description":"This API method adds an existing system group to the site
","operationId":"addExistingGroupToSite","produces":["application/xml","application/json"],"parameters":[{"name":"siteid","in":"path","description":"The ID of the site.","required":true,"type":"string"},{"name":"groupid","in":"path","description":"The ID of the system group to be added to the site. ","required":true,"type":"string"},{"name":"version","in":"path","description":"version","required":true,"type":"string","default":"3"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/group"}},"401":{"description":"Unauthorized"},"403":{"description":"Validation failed/ Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling api with wrong method)","schema":{"$ref":"#/definitions/ErrorDBO"}},"500":{"description":"Internal error occured while gettting site"}},"security":[{"OAuth":[]}]},"put":{"tags":["Site Resource APIs"],"summary":"Update site group","description":"This API method updates the name of an existing group in a site
","operationId":"updateSiteGroup","consumes":["application/xml","application/json","multipart/form-data"],"produces":["application/xml","application/json"],"parameters":[{"name":"siteid","in":"path","description":"The ID of the site.","required":true,"type":"string"},{"name":"groupid","in":"path","description":"\tThe ID of the site group.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/group"}},{"name":"version","in":"path","description":"version","required":true,"type":"string","default":"3"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/group"}},"401":{"description":"Unauthorized"},"403":{"description":"Validation failed/ Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling api with wrong method)","schema":{"$ref":"#/definitions/ErrorDBO"}},"500":{"description":"Internal error occured while gettting site"}},"security":[{"OAuth":[]}]}},"/{version}/sites/{siteid}/groups":{"get":{"tags":["Site Resource APIs"],"summary":"Get all site groups","description":"A list of site groups.Notes :
In the response all site groups are returned e.g. org,site,system,admin, allsystem and synced.
This API method adds a new group to the site.
Notes
Method to obtain a list of site users
Notes
1.The value of limit parameter behaves as follows:
limit =100 is the default value
if limit>0 then (number of items returned is equal to limit)
if limit=-1 then return all records
if limit <-1 then the system returns the default no of items i.e 100
2.The value of the offset parameter behaves as below
(Default) offset =0
if the offset is higher than 0 then the records are returned from the offset value
if offset is lower than 0 then an offset value of 0 is set
3.Default value for orderby parameter is asc (ascending)
4.Default value for ordertype parameter is organisation (organisation name)
5.In limit parameter if the limit is 0, it will display a validation message stating that the \"limit provided is invalid\"
This method explains how to add a number of new users to the site.
When adding a single user to a site follow the first step below. When adding more than one user to a site the below two steps should be followed.
Note: The getProgressiveKey call is covered in step 1 and is used further in the process.Step 1:
Request URI
POST /api/3/sites/{siteid}/users
This is the method to add a user to the site. This method expects that the user already exists in the system and the API user is aware of the userid of the user.
Note: The site should already exist in the system.
This method can be used to remove user(s) from a site.
","operationId":"removeUserFromSite","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"version","in":"path","description":"version of api","required":true,"type":"string","default":"3"},{"name":"siteid","in":"path","description":"The ID for the site.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/TransactionIds"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/transactionstatus"}},"401":{"description":"Unauthorized"},"403":{"description":"Validation failed/ Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling api with wrong method)","schema":{"$ref":"#/definitions/ErrorDBO"}},"500":{"description":"Internal error occured while gettting site"}},"security":[{"OAuth":[]}]}},"/{version}/sites/{siteid}/groups/{groupid}/users":{"get":{"tags":["Site Resource APIs"],"summary":"Get users of a site group","description":"This API method returns the users of a site group
","operationId":"getSiteGroupParticipants","produces":["application/xml","application/json"],"parameters":[{"name":"version","in":"path","description":"version of api","required":true,"type":"string","default":"1"},{"name":"siteid","in":"path","description":"The ID of the site.","required":true,"type":"string"},{"name":"groupid","in":"path","description":"The ID of the site group.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/users"}},"401":{"description":"Unauthorized"},"403":{"description":"Validation failed/ Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling api with wrong method)","schema":{"$ref":"#/definitions/ErrorDBO"}},"500":{"description":"Internal error occured while gettting site"}},"security":[{"OAuth":[]}]},"put":{"tags":["Site Resource APIs"],"summary":"Add user to a group","description":"This API method associates a user to a group
","operationId":"addUserToGroup","produces":["application/xml","application/json"],"parameters":[{"name":"siteid","in":"path","description":"The ID of the site. ","required":true,"type":"string"},{"name":"groupid","in":"path","description":"The ID of the site group. ","required":true,"type":"string"},{"name":"userid","in":"query","description":"The ID of the user to be added to the group.","required":true,"type":"string"},{"name":"version","in":"path","description":"version","required":true,"type":"string","default":"3"}],"responses":{"200":{"description":"OK"},"401":{"description":"Unauthorized"},"403":{"description":"Validation failed/ Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling api with wrong method)","schema":{"$ref":"#/definitions/ErrorDBO"}},"500":{"description":"Internal error occured while gettting site"}},"security":[{"OAuth":[]}]},"delete":{"tags":["Site Resource APIs"],"summary":"Delete user from a group","description":"This API method removes a user from a group
","operationId":"deleteUserFromGroup","produces":["application/xml","application/json"],"parameters":[{"name":"siteid","in":"path","description":"The ID of the site.","required":true,"type":"string"},{"name":"groupid","in":"path","description":"The ID of the site group.","required":true,"type":"string"},{"name":"userid","in":"query","description":"The ID of the user to be removed from the group. ","required":true,"type":"string"},{"name":"version","in":"path","description":"version","required":true,"type":"string","default":"3"}],"responses":{"200":{"description":"OK"},"401":{"description":"Unauthorized"},"403":{"description":"Validation failed/ Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling api with wrong method)","schema":{"$ref":"#/definitions/ErrorDBO"}},"500":{"description":"Internal error occured while gettting site"}},"security":[{"OAuth":[]}]}},"/{version}/sites/{siteid}/users/email":{"put":{"tags":["Site Resource APIs"],"summary":"Send an email to users","description":"Use this method to send an email to user(s)
Notes :\r\n
1) User id must be integer. If it's not, it will display this message \"User ID provided is Invalid.\"\r\n
2) If a user id is listed multiple times in the transaction id's list an email will be sent to the user and the second time it will display a message stating \"This user was already sent an email.\"\r\n
3) The user must be a participant of the given site. If not then it will display a message stating \"User with the specified User ID does not exist in the site.\"\r\n
4) If the site is in read only mode at the time the invitation is sent only system admin have rights to send an email to site participants.\r\n
5) In the request body users must have to add CDATA tag if they have special characters in emailsubject or messagebody tag. The request body is shown below\r\n
\r\n
<emailusers>\r\n
<emailsubject><![CDATA[Subject]]></emailsubject>
<messagebody><![CDATA[message]]></messagebody>
<transactionids>
<transactionid>181</transactionid>
<transactionid>124</transactionid>
</emailusers>
API method to obtain site templates
","operationId":"getSiteTemplates","produces":["application/xml","application/json"],"parameters":[{"name":"version","in":"path","description":"version of api","required":true,"type":"string","default":"1"},{"name":"filterby","in":"query","description":"Possible values are {recent|favourite|category|all} Default for this field is 'recent'The get site API returned the details for a site. Anyone with site access in Collaborate is permitted to use this API endpoint.
The fields returned for the site object are determined based on user permissions. If the user is a site admin user then they will get fields like Admin Notes otherwise not.
The current implementation does not include logo link.
The response object contains the user ID of the site owner.
The API responds with an access denied message when 'My site' details of another user are accessed.
Blank values for individual fields are not returned in the XML response, absence of value in the returned XML means that either the value does not exist for that field or the user does not have access to that field.
From version 7 onwards module tag will be in response to all user (Not only Admin) , and enable=0/1 will be based on either ON/OFF or have access (for normal users) to that module.
API version 8 onwards, a new tag 'restrictiontype' is added as part of 'Site Security API' functionality.There will be 8 restrictions shown under this tag each with value 0/1 to show whether the respective feature is enabled or disabled for the site.
Use this API endpoint to update the details of an existing site. The API supports the same fields used in Create site API.
","operationId":"updateSite","consumes":["application/json","application/xml"],"produces":["application/xml","text/plain","application/json"],"parameters":[{"name":"version","in":"path","description":"version of api","required":true,"type":"string","default":"1"},{"name":"siteid","in":"path","description":"The ID for the site","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/site"}}],"responses":{"201":{"description":"OK"},"400":{"description":"Problem with parsing XML or JSON object (Bad Request)"},"401":{"description":"Unauthorized"},"403":{"description":"Validation failed/ Forbidden"},"405":{"description":"Method not allowed (calling api with wrong method)"},"500":{"description":"Internal error occured while gettting site"}},"security":[{"OAuth":[]}]},"delete":{"tags":["Site Resource APIs"],"summary":"Delete site","description":"This API method is used to delete a site. The site is marked as archived and the system admin can revert the action if required. The system throws an 'Access Denied' message if the site does not exist.
If a delete file request is sent through the API for a site that has already been archived, the API will return a 200 OK response to that request.
'My site' cannot be deleted using this API method.
Response
The system sends a 200 OK response in case of success and throws an error object in case of an error.
This method returns the list of sites a user owns in Collaborate.
Please note that a site which has one of the configuration options enabled as specified in the \"callfrom\" parameter will not serve the documents using the API, as the configuration settings such as DRM, password protection etc cannot be bypassed using the API at the moment.
Until we provide API endpoints that allow you to accept these settings using the API, there is no way to get documents from these sites, doing so will conflict with the Collaborate security policies and hence cannot be achieved using the API at this time.
From version 7 onwards module tag will be in response to all user (Not only Admin) , and enable=0/1 will be based on either ON/OFF or have access (for normal users) to that module.
API version 8 onwards, a new tag 'restrictiontype' is added as part of 'Site Security API' functionality.There will be 8 restrictions shown under this tag each with value 0/1 to show whether the respective feature is enabled or disabled for the site.
Use this API to create a new site.The site object only supports attributes which are visible in the create site interface.
The method implementation now supports site templates.
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.
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.
We expect three different wordings or identifications for options in
- 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
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)
Method to get module permissions for a group
","operationId":"getModulePermissions","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"siteid","in":"path","description":"site id","required":true,"type":"string"},{"name":"groupid","in":"path","description":"The ID of the site group.","required":true,"type":"string"},{"name":"version","in":"path","description":"version","required":true,"type":"string","default":"3"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/modulepermissions"}},"401":{"description":"Unauthorized"},"403":{"description":"Validation failed/ Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling api with wrong method)","schema":{"$ref":"#/definitions/ErrorDBO"}},"500":{"description":"Internal error occured while gettting site"}},"security":[{"OAuth":[]}]},"post":{"tags":["Site Resource APIs"],"summary":"Add / edit group module permission","description":"Method to allocate module permissions to a group
","operationId":"addGroupModulePermission","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"siteid","in":"path","description":"The ID of the site.","required":true,"type":"string"},{"name":"groupid","in":"path","description":"The ID of the site group.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/modulepermissions"}},{"name":"version","in":"path","description":"version","required":true,"type":"string","default":"3"}],"responses":{"200":{"description":"OK"},"401":{"description":"Unauthorized"},"403":{"description":"Validation failed/ Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling api with wrong method)","schema":{"$ref":"#/definitions/ErrorDBO"}},"500":{"description":"Internal error occured while gettting site"}},"security":[{"OAuth":[]}]}},"/{version}/sites/{siteid}/templates":{"post":{"tags":["Site Resource APIs"],"summary":"Create template from site","description":"API to Create template from site.
This is a Long polling API( Multi step API). Below are the steps explaning how to consume this API.
API to Export template as a .hqa file.
This is a Long polling API( Multi step API). Below are the steps explaning how to consume this API.
API to export site template as a .hqa file.
To use this API, first use/consume Export template API (sites/templates/{templateid}/content).
progresskey can be found in the response of Export template API.
Please see documentation of Export template API for more details on how to consume this API.
API to Create site from template.
This is a Long polling API( Multi step API). Below are the steps explaning how to consume this API.
This method allows you to get the email alert setting for a user
","operationId":"getEmailAlertsForSiteUser","produces":["application/xml","application/json"],"parameters":[{"name":"siteid","in":"path","description":"The ID of the site.","required":true,"type":"string"},{"name":"userid","in":"path","description":"The ID of the user. ","required":true,"type":"string"},{"name":"version","in":"path","description":"version","required":true,"type":"string","default":"3"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/emailalerts"}},"401":{"description":"Unauthorized"},"403":{"description":"Validation failed/ Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling api with wrong method)","schema":{"$ref":"#/definitions/ErrorDBO"}},"500":{"description":"Internal error occured while gettting site"}},"security":[{"OAuth":[]}]},"put":{"tags":["Site Resource APIs"],"summary":"Set email alert settings","description":"This method allows you to set or update the email alert setting for a user
","operationId":"setEmailAlertsForSiteUser","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"siteid","in":"path","description":"The ID of the site.","required":true,"type":"string"},{"name":"userid","in":"path","description":"The ID of the user.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/emailalerts"}},{"name":"version","in":"path","description":"version","required":true,"type":"string","default":"3"}],"responses":{"200":{"description":"OK"},"401":{"description":"Unauthorized"},"403":{"description":"Validation failed/ Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling api with wrong method)","schema":{"$ref":"#/definitions/ErrorDBO"}},"500":{"description":"Internal error occured while gettting site"}},"security":[{"OAuth":[]}]}},"/{version}/sites/{siteid}/users/{userids}":{"delete":{"tags":["Site Resource APIs"],"summary":"Remove users from a site","description":"This method can be used to remove user(s) which given in userCSV from a site.
","operationId":"removeUsersFromSite","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"version","in":"path","description":"version of api","required":true,"type":"string","default":"3"},{"name":"siteid","in":"path","description":"The ID for the site.","required":true,"type":"string"},{"name":"userids","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/transactionstatus"}},"401":{"description":"Unauthorized"},"403":{"description":"Validation failed/ Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling api with wrong method)","schema":{"$ref":"#/definitions/ErrorDBO"}},"500":{"description":"Internal error occured while gettting site"}},"security":[{"OAuth":[]}]}},"/{version}/sites/{siteid}/users/resetpassword":{"put":{"tags":["Site Resource APIs"],"summary":"Send reset password email to users","description":"Use this method to send a reset password email to user(s)
Notes :
1) In the case of success, it will display the message \"Successfully sent the reset password email\"
2) When a user id is not correct, it will display the message \"User Id provided is invalid\"
3) When a given user id is not a site participant, it will display the message \"User with the specified user ID does not exist in the site\"
4) When a user id has already requested a password reset email and then requests it again it will display the message \"User with this User ID has already been sent a reset password email\"
5) When a user id is not in the system or a user is not active, it will display a message \"User with this user ID does not exist in system or the user is not active\"
6) When the site is archived or a user does not have access to the site, it will display the message \"Site is archived or user does not have access to the site \"
7) In any other case of exception, it will display the message \"Internal server error\"
A list of groups in which given userID is participants.Notes :
In the response all groups in which given userID is participants are returned
Use this method to activate user(s) in a site
Note:
\r\n
User Id must be integer. If it's not, it will display the following message \"User ID provided is Invalid.\"\r\n
If a user id is listed multiple times in the transaction id's list it will initially activate the user and the next time it will display the following message \"The selected user is already activated\". \r\n
The user must be a participant of the given site. If the user is not, it will display the following message \"User with the specified User ID does not exist in the site\"
Use this method to get module permissions for a user
","operationId":"getModulePermissionForUser","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"siteid","in":"path","description":"The ID of the site.","required":true,"type":"string"},{"name":"userid","in":"path","description":"The ID of the site user.","required":true,"type":"string"},{"name":"version","in":"path","description":"version","required":true,"type":"string","default":"3"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/modulepermissions"}},"401":{"description":"Unauthorized"},"403":{"description":"Validation failed/ Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling api with wrong method)","schema":{"$ref":"#/definitions/ErrorDBO"}},"500":{"description":"Internal error occured while gettting site"}},"security":[{"OAuth":[]}]},"post":{"tags":["Site Resource APIs"],"summary":"Add / edit user module permission","description":"Method to allocate module permissions to a user
","operationId":"addModulePermissionForUser","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"siteid","in":"path","description":"The ID of the site.","required":true,"type":"string"},{"name":"userid","in":"path","description":"The ID of the user. ","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/modulepermissions"}},{"name":"version","in":"path","description":"version","required":true,"type":"string","default":"3"}],"responses":{"200":{"description":"OK"},"401":{"description":"Unauthorized"},"403":{"description":"Validation failed/ Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling api with wrong method)","schema":{"$ref":"#/definitions/ErrorDBO"}},"500":{"description":"Internal error occured while gettting site"}},"security":[{"OAuth":[]}]}},"/{version}/sites/{siteid}/users/suspended":{"put":{"tags":["Site Resource APIs"],"summary":"Suspend users","description":"Use this method to suspend user(s) in a site
Notes :
1) In case of success, it will display the following message \"User suspended successfully.\"
2) When the user id is not correct, it will display the following message \"User Id provided is Invalid\"
3) When a given user id is not a site participant, it will display the following message \"User with the specified User ID does not exist in the site\"
4) When a user id is already suspended from the site, it will display the following message \"The selected user is already suspended\"
5) When a user id is not in system or the user is not active, it will display the following message \"User with this User ID does not exist in system or User is not active\"
6) When a given user id is a system administrator or has created the given site it will display the following message \"The selected user is either a System Administrator or is the creator of this site and cannot be suspended. \"
7) In any other exception, it will display the following message \"Internal server error\"
Use this method to send an invitation email to user(s)
Notes :
1) User id must be integer. If it's not, it will display the message \"User ID provided is Invalid.\"
2) If a user id is displayed in the transaction id's list multiple times, an invitation will be sent to the user and then a message will display the second time stating \"This user was already sent an invitation.\"
3) User must be a participant of a given site. If they are not it will display the message \"User with the specified User ID does not exist in the site.\"
4) Admin users can send invitations to users who were added by him. Other users will see the message \"You do not have rights to send an invitation email to the specified user.\"
5) If the site is in preparation mode at the time the invitation is send to site admin only and it was send by site admin or system admin.
6) If the site is in archive mode at that time an invitation is sent, the response will be \"Access denied\".
7) If the site is in read only mode at that time an invitation is sent, only system admin have rights to send an invitation to site participants.
8) In the request body, a user must add an e-mail message in the CDATA tag if they have special characters in e-mail message tag. See the request body below
<invitations>
<messagebody>
<![CDATA[E-Mail message.]]>
</messagebody>
<transactionids>
<transactionid>102</transactionid>
<transactionid>126</transactionid>
<transactionid>128</transactionid>
<transactionid>129</transactionid>
</transactionids>
</invitations>
9) If user status is suspended, inactive or archived at the time an invitation is sent, the email will not be sent to the specific user and this message will display \"User with this User ID does not exist in system or User is not active.\"","operationId":"sendInvitationToSiteParticipant","consumes":["application/xml","application/json","multipart/form-data"],"produces":["application/xml","application/json"],"parameters":[{"name":"siteid","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/Invitation"}},{"name":"version","in":"path","description":"version","required":true,"type":"string","default":"3"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/transactionstatus"}},"401":{"description":"Unauthorized"},"403":{"description":"Validation failed/ Forbidden","schema":{"$ref":"#/definitions/ErrorDBO"}},"405":{"description":"Method not allowed (calling api with wrong method)","schema":{"$ref":"#/definitions/ErrorDBO"}},"500":{"description":"Internal error occured while gettting site"}},"security":[{"OAuth":[]}]}},"/{version}/progressivekeystatus/{progressivekey}":{"post":{"tags":["Site Resource APIs"],"operationId":"checkProgressiveKeyStatus","produces":["application/xml","application/json"],"parameters":[{"name":"version","in":"path","required":true,"type":"string"},{"name":"progressivekey","in":"path","required":true,"type":"string"}],"responses":{"default":{"description":"successful operation"}},"security":[{"OAuth":[]}]}},"/{version}/sites/getPermittedSitesForUser":{"get":{"tags":["Site Resource APIs"],"operationId":"getPermittedSitesForUser","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"userEmailID","in":"query","required":false,"type":"string"},{"name":"instanceMetaInfoRequired","in":"query","required":false,"type":"boolean","default":false},{"name":"searchText","in":"query","required":false,"type":"string"},{"name":"startPosition","in":"query","required":false,"type":"integer","default":0,"format":"int32"},{"name":"limit","in":"query","required":false,"type":"integer","default":20,"format":"int32"}],"responses":{"default":{"description":"successful operation"}},"security":[{"OAuth":[]}]}},"/{version}/sites/templates/{templateid}":{"get":{"tags":["Site Resource APIs"],"summary":"Get template","description":"
The get template API returned the details for a template. Anyone with template access in Collaborate is permitted to use this API endpoint.
The fields returned for the template object are determined based on user permissions. If the user is a site admin user then they will get fields like Admin Notes otherwise not.
The current implementation does not include logo link.
The response object contains the user ID of the template owner.
The API responds with an access denied message when 'My site' details of another user are accessed.
Blank values for individual fields are not returned in the XML response, absence of value in the returned XML means that either the value does not exist for that field or the user does not have access to that field.
From version 7 onwards module tag will be in response to all user (Not only Admin) , and enable=0/1 will be based on either ON/OFF or have access (for normal users) to that module
Use this API endpoint to update the details of an existing template. The API supports the same fields used in create template API.
","operationId":"updateSite_1","consumes":["application/json","application/xml"],"produces":["application/xml","text/plain","application/json"],"parameters":[{"name":"version","in":"path","description":"version of api","required":true,"type":"string","default":"8"},{"name":"templateid","in":"path","description":"The ID for the template","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SiteTemplate"}}],"responses":{"201":{"description":"OK"},"400":{"description":"Problem with parsing XML or JSON object (Bad Request)"},"401":{"description":"Unauthorized"},"403":{"description":"Validation failed/ Forbidden"},"405":{"description":"Method not allowed (calling api with wrong method)"},"500":{"description":"Internal error occured while gettting site"}},"security":[{"OAuth":[]}]},"delete":{"tags":["Site Resource APIs"],"summary":"Delete template","description":"This API method is used to delete a template. The template is marked as archived and the system admin can revert the action if required. The system throws an 'Access Denied' message if the template does not exist.
If a delete file request is sent through the API for a template that has already been archived, the API will return a 200 OK response to that request.
Response
The system sends a 200 OK response in case of success and throws an error object in case of an error.
API method to obtain site templates
","operationId":"getSiteTemplates_1","produces":["application/xml","application/json"],"parameters":[{"name":"version","in":"path","description":"version of api","required":true,"type":"string","default":"8"},{"name":"filterby","in":"query","description":"Possible values are {recent|favourite|category|all} Default for this field is 'recent'Use this API to create a new template.The template object only supports attributes which are visible in the create template interface.
The method implementation now supports site templates.
This method does not support uploading template image in this call, the template 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 template categories interface.
template 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.
We expect three different wordings or identifications for options in
- files (root folder)
- files (recent activity)
- files (advanced search)
API 7 or higher, template created from template will follow modules from source template and it will ignore module list sent in request body.
This API call is used to get a system group object in the system.
| Summary | \r\n\t\t\tRef Code (before V4) | \r\n\t\t\tRef Code (V4) | \r\n\t\t
| \r\n\t\t\t Group id is required \r\n\t\t\t | \r\n\t\t\t125 | \r\n\t\t\t125 | \r\n\t\t
| \r\n\t\t\t Group id is not in proper format \r\n\t\t\t | \r\n\t\t\t124 | \r\n\t\t\t124 | \r\n\t\t
| \r\n\t\t\t The group does not exist within the system \r\n\t\t\t | \r\n\t\t\t126 | \r\n\t\t\t126 | \r\n\t\t
JIRA Ticket : https://dev.highq.com/jira/browse/COL-65839
","operationId":"getGroup","produces":["application/xml","application/json"],"parameters":[{"name":"version","in":"path","description":"version of api","required":true,"type":"string","default":"1"},{"name":"id_Name","in":"path","description":"The ID of the system group","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/group"}},"400":{"description":"4xx Fail transaction(Client Side)","schema":{"$ref":"#/definitions/ErrorDBO"}},"500":{"description":"5xx Fail transaction(Server Side)","schema":{"$ref":"#/definitions/ErrorDBO"}}},"security":[{"OAuth":[]}]}},"/{version}/groups/{groupid}/users/{userid}":{"get":{"tags":["System Groups"],"summary":"Get users of a group","description":"API method to get users from a group. Please note that this method only gets users of an AD group, and not the system groups.","operationId":"getUser","produces":["application/xml","application/json"],"parameters":[{"name":"version","in":"path","description":"version of api","required":true,"type":"string","default":"1"},{"name":"groupid","in":"path","description":"group id","required":true,"type":"string"},{"name":"userid","in":"path","description":"user id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IntegrationResponseUsersObject"}},"400":{"description":"4xx Fail transaction(Client Side)","schema":{"$ref":"#/definitions/ErrorDBO"}},"500":{"description":"5xx Fail transaction(Server Side)","schema":{"$ref":"#/definitions/ErrorDBO"}}},"security":[{"OAuth":[]}]},"delete":{"tags":["System Groups"],"summary":"Remove user from system group","description":"
This API call is used to remove multiple users in a system group.
Error Codes
| Summary | \r\n\t\t\tRef Code (before V4) | \r\n\t\t\tRef Code (V4) | \r\n\t\t
| \r\n\t\t\t The following users do not exist within the system: \r\n\t\t\t | \r\n\t\t\t110 | \r\n\t\t\t110 | \r\n\t\t
| \r\n\t\t\t The group does not exist within the system \r\n\t\t\t | \r\n\t\t\t126 | \r\n\t\t\t126 | \r\n\t\t
| \r\n\t\t\t Group id is not in proper format \r\n\t\t\t | \r\n\t\t\t124 | \r\n\t\t\t124 | \r\n\t\t
| \r\n\t\t\t The User ids are not in a given group: \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t259 | \r\n\t\t
| \r\n\t\t\t Users cannot be removed from an auto-created group \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t306 | \r\n\t\t
| \r\n\t\t\t User id is not in proper format \r\n\t\t\t | \r\n\t\t\t113 | \r\n\t\t\t113 | \r\n\t\t
| \r\n\t\t\t The User's id length cannot exceeds 50 characters \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t304 | \r\n\t\t
JIRA Ticket : https://dev.highq.com/jira/browse/COL-66707
","operationId":"removeUserFromSystemGroup","produces":["application/xml","application/json"],"parameters":[{"name":"version","in":"path","description":"version of api","required":true,"type":"string","default":"1"},{"name":"groupid","in":"path","description":"The ID of the system group","required":true,"type":"string"},{"name":"userid","in":"path","description":"The IDs of the users to be removed from system group.","required":true,"type":"string"}],"responses":{"200":{"description":"OK"},"400":{"description":"4xx Fail transaction(Client Side)","schema":{"$ref":"#/definitions/ErrorDBO"}},"500":{"description":"5xx Fail transaction(Server Side)","schema":{"$ref":"#/definitions/ErrorDBO"}}},"security":[{"OAuth":[]}]}},"/{version}/groups/{groupid}/users":{"get":{"tags":["System Groups"],"summary":"Get users of a group","description":"API method to get users from a group. Please note that this method only gets users of an AD group, and not the system groups.","operationId":"getAllUser","produces":["application/xml","application/json"],"parameters":[{"name":"version","in":"path","description":"version of api","required":true,"type":"string","default":"1"},{"name":"groupid","in":"path","description":"group id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IntegrationResponseUsersObject"}},"400":{"description":"4xx Fail transaction(Client Side)","schema":{"$ref":"#/definitions/ErrorDBO"}},"500":{"description":"5xx Fail transaction(Server Side)","schema":{"$ref":"#/definitions/ErrorDBO"}}},"security":[{"OAuth":[]}]},"post":{"tags":["System Groups"],"summary":"Add user to a system group","description":"
This API call is used to add users in a system group.
Error Codes
| Summary | \r\n\t\t\tRef Code (before V4) | \r\n\t\t\tRef Code (V4) | \r\n\t\t
| \r\n\t\t\t The following users do not exist within the system: \r\n\t\t\t | \r\n\t\t\t110 | \r\n\t\t\t110 | \r\n\t\t
| \r\n\t\t\t The group does not exist within the system \r\n\t\t\t | \r\n\t\t\t126 | \r\n\t\t\t126 | \r\n\t\t
| \r\n\t\t\t The Group id is not in the proper format \r\n\t\t\t | \r\n\t\t\t124 | \r\n\t\t\t124 | \r\n\t\t
| \r\n\t\t\t A User id is required \r\n\t\t\t | \r\n\t\t\t109 | \r\n\t\t\t109 | \r\n\t\t
| \r\n\t\t\t Archived user(s) cannot be added to the system group: \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t394 | \r\n\t\t
| \r\n\t\t\t A user cannot be added to an auto-created group \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t299 | \r\n\t\t
JIRA Ticket : https://dev.highq.com/jira/browse/COL-65908
","operationId":"addUserInSystemGroup","consumes":["text/plain","application/json","application/xml"],"produces":["application/xml","application/json"],"parameters":[{"name":"version","in":"path","description":"version of api","required":true,"type":"string","default":"1"},{"name":"groupid","in":"path","description":"The ID of the system group","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/UserIDListDBO"}}],"responses":{"201":{"description":"OK"},"400":{"description":"4xx Fail transaction(Client Side)","schema":{"$ref":"#/definitions/ErrorDBO"}},"500":{"description":"5xx Fail transaction(Server Side)","schema":{"$ref":"#/definitions/ErrorDBO"}}},"security":[{"OAuth":[]}]}},"/{version}/groups":{"get":{"tags":["System Groups"],"summary":"System group list","description":"This API call is used to get a list of system groups.Note:
The following changes have been made to this API endpoint
Introduced sorting
Added following additional items to the return object createddate, totalcount, total, nooforganisation
| Summary | \r\n\t\t\tRef Code (before V4) | \r\n\t\t\tRef Code (V4) | \r\n\t\t
| \r\n\t\t\t Invalid value provided in type, valid values are org, system or synced \r\n\t\t\t | \r\n\t\t\t146 | \r\n\t\t\t146 | \r\n\t\t
| \r\n\t\t\t The ordertype is invalid. createddate is supported ordertype \r\n\t\t\t | \r\n\t\t\t150 | \r\n\t\t\t150 | \r\n\t\t
| \r\n\t\t\t The orderby value is invalid. asc and desc are supported orderby values. \r\n\t\t\t | \r\n\t\t\t151 | \r\n\t\t\t151 | \r\n\t\t
JIRA Ticket : https://dev.highq.com/jira/browse/COL-65896
\r\n
| Parameters | \r\n\t\t\tDescription | \r\n\t\t
| type | \r\n\t\t\t\r\n\t\t\t org (Organisation Auto created groups) | \r\n\t\t
| \r\n\t\t\t sort \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Allow ascending and descending sorting of a single field. \r\n\t\t\tGET /api/3/groups?ordertype=createddate \r\n\t\t\tThis returns a list of groups sorted by createddate in ascending order. \r\n\t\t\tpossible fields: createddate \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t order by \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Allow ascending and descending sorting of a single field. \r\n\t\t\tGET /api/3/groups?orderby=desc \r\n\t\t\tpossible fields: asc,desc \r\n\t\t\t | \r\n\t\t
This API call is used to add a new system group object in the system.
| \r\n\t\t\t Summary \r\n\t\t\t | \r\n\t\t\tRef code (before v4) | \r\n\t\t\t\r\n\t\t\t Ref code (v4) \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t System group name required \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t\r\n\t\t\t 258 \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t Invalid input. Please remove '>' OR '<' from given input : name \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t\r\n\t\t\t 390 \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t Invalid input. Please remove '>' OR '<' from given input : description \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t\r\n\t\t\t 391 \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t Invalid input for sourcetype. Valid values are Active Directory or System. \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t\r\n\t\t\t 359 \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t The group name cannot be empty \r\n\t\t\t | \r\n\t\t\t121 | \r\n\t\t\t\r\n\t\t\t 121 \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t The system group name 'Highq' already exists within the system \r\n\t\t\t | \r\n\t\t\t122 | \r\n\t\t\t\r\n\t\t\t 122 \r\n\t\t\t | \r\n\t\t
JIRA Ticket : https://dev.highq.com/jira/browse/COL-67587
","operationId":"createSystemGroup","consumes":["text/plain","application/json","application/xml"],"produces":["application/xml","application/json"],"parameters":[{"name":"version","in":"path","description":"version of api","required":true,"type":"string","default":"1"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/group"}}],"responses":{"201":{"description":"OK [groupID,link are used in response]","schema":{"$ref":"#/definitions/group"}},"400":{"description":"4xx Fail transaction(Client Side)","schema":{"$ref":"#/definitions/ErrorDBO"}},"500":{"description":"5xx Fail transaction(Server Side)","schema":{"$ref":"#/definitions/ErrorDBO"}}},"security":[{"OAuth":[]}]}},"/{version}/groups/{groupid}":{"delete":{"tags":["System Groups"],"summary":"Delete system group","description":"This API call is used to delete a system group.
NOTE : This API now can be used to delete system as well as active directory groups.
| Summary | \r\n\t\t\tRef Code (before V4) | \r\n\t\t\tRef Code (V4) | \r\n\t\t
| \r\n\t\t\t Group id must be required \r\n\t\t\t | \r\n\t\t\t125 | \r\n\t\t\t125 | \r\n\t\t
| \r\n\t\t\t Group id is not in proper format \r\n\t\t\t | \r\n\t\t\t124 | \r\n\t\t\t124 | \r\n\t\t
| \r\n\t\t\t An auto-created group cannot be deleted \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t311 | \r\n\t\t
| \r\n\t\t\t The group does not exist within the system \r\n\t\t\t | \r\n\t\t\t126 | \r\n\t\t\t126 | \r\n\t\t
| \r\n\t\t\t This system group name is associated with one or more sites \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t310 | \r\n\t\t
JIRA Ticket : https://dev.highq.com/jira/browse/COL-65905
","operationId":"removeSystemGroup","produces":["application/xml","application/json"],"parameters":[{"name":"version","in":"path","description":"version of api","required":true,"type":"string","default":"1"},{"name":"groupid","in":"path","description":"The ID of the System group to delete","required":true,"type":"string"}],"responses":{"200":{"description":"OK"},"400":{"description":"4xx Fail transaction(Client Side)","schema":{"$ref":"#/definitions/ErrorDBO"}},"500":{"description":"5xx Fail transaction(Server Side)","schema":{"$ref":"#/definitions/ErrorDBO"}}},"security":[{"OAuth":[]}]}},"/{version}/groups/{id}":{"put":{"tags":["System Groups"],"summary":"Update system group","description":"This API call is used to change a system group.Note:
1. In the previous version of this API all fields were mandatory, with the new version individual fields that can be updated
2. This API endpoint only supported \"Active directory\" system groups, now any system group can be updated
| \r\n\t\t\t Summary \r\n\t\t\t | \r\n\t\t\tRef code (before v4) | \r\n\t\t\t\r\n\t\t\t Ref code (v4) \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t The group name cannot be empty \r\n\t\t\t | \r\n\t\t\t121 | \r\n\t\t\t\r\n\t\t\t 121 \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t The system group name 'Highq' already exists within the system \r\n\t\t\t | \r\n\t\t\t122 | \r\n\t\t\t\r\n\t\t\t 122 \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t Group id is not in the proper format \r\n\t\t\t | \r\n\t\t\t124 | \r\n\t\t\t\r\n\t\t\t 124 \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t Group id must be required \r\n\t\t\t | \r\n\t\t\t125 | \r\n\t\t\t125 | \r\n\t\t
| \r\n\t\t\t The group does not exist within the system \r\n\t\t\t | \r\n\t\t\t126 | \r\n\t\t\t\r\n\t\t\t 126 \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t Invalid input. Please remove '>' OR '<' from given input : name \r\n\t\t\t | \r\n\t\t\t142 | \r\n\t\t\t\r\n\t\t\t 390 \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t Invalid input. Please remove '>' OR '<' from given input : description \r\n\t\t\t | \r\n\t\t\t142 | \r\n\t\t\t\r\n\t\t\t 391 \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t An auto-created group cannot be updated \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t320 | \r\n\t\t
JIRA Ticket : https://dev.highq.com/jira/browse/COL-65905
","operationId":"updateSystemGroup","consumes":["text/plain","application/json","application/xml"],"produces":["application/xml","application/json"],"parameters":[{"name":"version","in":"path","description":"version of api","required":true,"type":"string","default":"1"},{"name":"id","in":"path","description":"The ID of the system group","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/group"}}],"responses":{"200":{"description":"OK"},"400":{"description":"4xx Fail transaction(Client Side)","schema":{"$ref":"#/definitions/ErrorDBO"}},"500":{"description":"5xx Fail transaction(Server Side)","schema":{"$ref":"#/definitions/ErrorDBO"}}},"security":[{"OAuth":[]}]}},"/{version}/systemreports/sitesummaryreport/content":{"get":{"tags":["System Reports APIs"],"summary":"Download Site summary xlsx report","description":"API method to download Site summary report export in xlsx formatAPI method to check if the file type is supported for a specific functionality. For example if a file type is supported by online viewer or not. The client will send a single file extension in query string for which it wants to find the available functions, and in response Collaborate will respond with available functions for that filetype.
Confirmations and assumptions
Access rights of this API has been given a value of \"ACCESS_ALL\", which means everyone with a valid account can access this method.
This api method can be used to get basic details of a Collaborate Instance
Sample request URL : https://domain.com/instancename/api/1/configuration/basicdetails
Assumptions :
No credentials required to call this api method (Change introduced in 3.4.5)
This api method helps to obtain information about blacklist/whitelist filetypes of Instance
Sample request URL : https://domain.com/instancename/api/1/ configuration/supportedfiletypes
Assumptions :
Any system user can call this API If matched extension not found in system then only
This is an API method to get the user avatar.
Response
The API response is a multipart stream of data. If the avatar has not been uploaded then a place holder default system avatar is returned. In the case of an error, an error object is returned with the appropriate error message.
JIRA Ticket : https://dev.highq.com/jira/browse/COL-62788
This API call is used to get list of experience.\r\n
Error Codes
| Summary | \r\n\t\t\tRef Code (V4) | \r\n\t\t\tRef Code (before V4) | \r\n\t\t
| \r\n\t\t\t A User id is required \r\n\t\t\t | \r\n\t\t\t109 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t User id is not in proper format \r\n\t\t\t | \r\n\t\t\t113 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The following users do not exist within the system: \r\n\t\t\t | \r\n\t\t\t110 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The given action cannot be performed on the anonymised user(s). \r\n\t\t\t | \r\n\t\t\t325 | \r\n\t\t\t\r\n\t\t |
JIRA Ticket : https://dev.highq.com/jira/browse/COL-66714
This API call is used to add a new experience object in the system.\r\n
Error Codes
| Summary | \r\n\t\t\tRef Code (V4) | \r\n\t\t\tRef Code (before V4) | \r\n\t\t
| \r\n\t\t\t User id is not in proper format \r\n\t\t\t | \r\n\t\t\t113 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The given userid is invalid \r\n\t\t\t | \r\n\t\t\t342 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The company name is required \r\n\t\t\t | \r\n\t\t\t328 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The job title is required \r\n\t\t\t | \r\n\t\t\t329 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The Experience From month field is required \r\n\t\t\t | \r\n\t\t\t330 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The Experience From year field is required \r\n\t\t\t | \r\n\t\t\t331 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The Experience To month field is required \r\n\t\t\t | \r\n\t\t\t332 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The Experience To year field is required \r\n\t\t\t | \r\n\t\t\t333 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The information in the Experience From month field is not valid \r\n\t\t\t | \r\n\t\t\t335 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The information in the Experience To month field is not valid \r\n\t\t\t | \r\n\t\t\t336 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t Please enter a year between 1900 and the current year as your start date \r\n\t\t\t | \r\n\t\t\t337 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t Please enter a year between 1900 and the current year as your end date \r\n\t\t\t | \r\n\t\t\t338 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The information in the Experience from year field is not formatted correctly \r\n\t\t\t | \r\n\t\t\t339 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The information in the Experience To year field is not formatted correctly \r\n\t\t\t | \r\n\t\t\t340 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The information in the Currently working value field is not valid \r\n\t\t\t | \r\n\t\t\t341 | \r\n\t\t\t\r\n\t\t |
JIRA Ticket : https://dev.highq.com/jira/browse/COL-66711
Get a user from Collaborate
\r\nThis API call is used to retrieve a user from the system.
\r\nNote:
\r\n1. The following fields have been introduced in this version
\r\nemaildomain, org, invitationsent, createdby, createddate, modifiedby, modifieddate, ifpartner, lastlogindate, invalidlogins, externalid, publicwebsiteprofileid, systemuser, resetpassworddate, usertypeid, avatar, practicegroup, langcode, publicprofile, dateOfBirth
\r\n2. The "location" tag has been renamed to "address" tag to make it consistent with the Collaborate UI
The response will now display the address as
\r\n<address>
\r\n<addressid>1</addressid>
\r\n<addressline1>2nd floor</addressline1>
\r\n<addressline2>additional</addressline2>
\r\n<city>london</city>
\r\n<state>state</state>
\r\n<country>uk</country>
\r\n<postCode>EC4R</postCode>
\r\n</address>
\r\n
\r\nInstead of
\r\n<location>
\r\n<addressline1>2nd floor, 55 King William Street</addressline1>
\r\n<addressline2>additional</addressline2>
\r\n<addressline3>state</addressline3>
\r\n<city>London</city>
\r\n<country>United Kingdom</country>
\r\n<postcode>EC4R 9AD</postcode>
\r\n</location>
| Summary | \r\n\t\t\tRef Code (before V4) | \r\n\t\t\tRef Code (V4) | \r\n\t\t
| \r\n\t\t\t User does not exists in the system \r\n\t\t\t | \r\n\t\t\t110 | \r\n\t\t\t110 | \r\n\t\t
JIRA Ticket : https://dev.highq.com/jira/browse/COL-65605
This API call is used to update an existing user in the system.Note:
1. The following fields have been introduced in the response body emaildomain, org, invitationsent, createdby, createddate, modifiedby, modifieddate, ifpartner, lastlogindate, invalidlogins, externalid, publicwebsiteprofileid, systemuser, resetpassworddate, usertypeid, avatar, practicegroup, langcode, publicprofile, dateOfBirth
2. Address tag is available from API version 4\r\n<address>
<addressid>1</addressid>
</address>
Error Codes
| Summary | \r\n\t\t\tRef Code (before V4) | \r\n\t\t\tRef Code (V4) | \r\n\t\t
| \r\n\t\t\t User ID is not in proper format \r\n\t\t\t | \r\n\t\t\t113 | \r\n\t\t\t\r\n\t\t\t 113 \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t User does not exist in the system \r\n\t\t\t | \r\n\t\t\t110 | \r\n\t\t\t110 | \r\n\t\t
| \r\n\t\t\t Update user is not applicable in the case of a self registered user \r\n\t\t\t | \r\n\t\t\t188 | \r\n\t\t\t\r\n\t\t\t 188 \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t Email address is required \r\n\t\t\t | \r\n\t\t\t101 | \r\n\t\t\t101 | \r\n\t\t
| \r\n\t\t\t Invalid email address \r\n\t\t\t | \r\n\t\t\t104 | \r\n\t\t\t104 | \r\n\t\t
| \r\n\t\t\t First name is required \r\n\t\t\t | \r\n\t\t\t102 | \r\n\t\t\t102 | \r\n\t\t
| \r\n\t\t\t Max characters allowed for first name must be between 1 to 100 \r\n\t\t\t | \r\n\t\t\t102 | \r\n\t\t\t352 | \r\n\t\t
| \r\n\t\t\t The secretary's email address is not valid \r\n\t\t\t | \r\n\t\t\t104 | \r\n\t\t\t353 | \r\n\t\t
| \r\n\t\t\t Status must be active or inactive \r\n\t\t\t | \r\n\t\t\t116 | \r\n\t\t\t116 | \r\n\t\t
| \r\n\t\t\t The entered department cannot be more than 256 characters \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t354 | \r\n\t\t
| \r\n\t\t\t The entered ifpartner attribute is invalid \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t355 | \r\n\t\t
| \r\n\t\t\t The entered systemuser attribute is invalid \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t356 | \r\n\t\t
| \r\n\t\t\t The entered usertypeid attribute is invalid \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t357 | \r\n\t\t
| \r\n\t\t\t The entered langcode attribute is invalid \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t358 | \r\n\t\t
| \r\n\t\t\t The entered sourcetype attribute is invalid. Valid values are System, Active directory or System default \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t359 | \r\n\t\t
| \r\n\t\t\t Please enter valid phone number \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t360 | \r\n\t\t
| \r\n\t\t\t Please enter valid phone number in format {countrycode} ${areacode}${number}. \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t361 | \r\n\t\t
| \r\n\t\t\t Please enter valid mobile number in format {countrycode}${number}. \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t362 | \r\n\t\t
| \r\n\t\t\t Enter a valid office phone country code \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t363 | \r\n\t\t
| \r\n\t\t\t The office phone country code can have a maximum of 4 digits \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t364 | \r\n\t\t
| \r\n\t\t\t Enter a valid office phone area code \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t365 | \r\n\t\t
| \r\n\t\t\t The office phone area code can have a maximum of 5 Digits \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t366 | \r\n\t\t
| \r\n\t\t\t Office phone number should have Maximum 15 digits \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t368 | \r\n\t\t
| \r\n\t\t\t Enter a valid mobile phone country code \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t369 | \r\n\t\t
| \r\n\t\t\t The mobile phone country code can have a maximum of 4 Digits \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t372 | \r\n\t\t
| \r\n\t\t\t Please enter valid mobile number \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t373 | \r\n\t\t
| \r\n\t\t\t Mobile phone number should have Maximum 20 digits \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t374 | \r\n\t\t
| \r\n\t\t\t Domain does not exist \r\n\t\t\t | \r\n\t\t\t105 | \r\n\t\t\t105 | \r\n\t\t
| \r\n\t\t\t Email already exists in the system \r\n\t\t\t | \r\n\t\t\t111 | \r\n\t\t\t111 | \r\n\t\t
| \r\n\t\t\t Mention organisation in the case of an exceptional domain \r\n\t\t\t | \r\n\t\t\t115 | \r\n\t\t\t115 | \r\n\t\t
| \r\n\t\t\t Org ID is not in proper format \r\n\t\t\t | \r\n\t\t\t112 | \r\n\t\t\t112 | \r\n\t\t
| \r\n\t\t\t Organisation does not exist \r\n\t\t\t | \r\n\t\t\t106 | \r\n\t\t\t106 | \r\n\t\t
| \r\n\t\t\t Domain exists in other organisation \r\n\t\t\t | \r\n\t\t\t114 | \r\n\t\t\t114 | \r\n\t\t
| \r\n\t\t\t Entered Address ID is not valid \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t308 | \r\n\t\t
| \r\n\t\t\t Social link name not found in system \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t375 | \r\n\t\t
| \r\n\t\t\t The social link name is required \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t376 | \r\n\t\t
| \r\n\t\t\t The social link value is required \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t377 | \r\n\t\t
| \r\n\t\t\t Maximum characters for social link value must be between 1 to 500 \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t378 | \r\n\t\t
| \r\n\t\t\t Enter the name for the custom link \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t379 | \r\n\t\t
| \r\n\t\t\t The custom link value is required \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t380 | \r\n\t\t
| \r\n\t\t\t Maximum characters for custom link name must be between 1 to 500 \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t381 | \r\n\t\t
| \r\n\t\t\t Maximum characters for custom link value must be between 1 to 500 \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t382 | \r\n\t\t
| \r\n\t\t\t The message link name is required \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t383 | \r\n\t\t
| \r\n\t\t\t Message link name not found in system. \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t384 | \r\n\t\t
| \r\n\t\t\t The message link value is required \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t385 | \r\n\t\t
| \r\n\t\t\t Maximum characters for message link value must be between 1 to 500 \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t386 | \r\n\t\t
| \r\n\t\t\t The social link is disabled \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t408 | \r\n\t\t
| \r\n\t\t\t The message link is disabled \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t409 | \r\n\t\t
| \r\n\t\t\t The custom link is disabled \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t410 | \r\n\t\t
JIRA Ticket : https://dev.highq.com/jira/browse/COL-65687
This API call is used to archive a user within the system.
Error Codes
| Summary | \r\n\t\t\tRef Code (before V4) | \r\n\t\t\tRef Code (V4) | \r\n\t\t
| \r\n\t\t\t The following users do not exist within the system \r\n\t\t\t | \r\n\t\t\t110 | \r\n\t\t\t110 | \r\n\t\t
| \r\n\t\t\t A User ID is required \r\n\t\t\t | \r\n\t\t\t109 | \r\n\t\t\t109 | \r\n\t\t
| \r\n\t\t\t User ID is not in the proper format \r\n\t\t\t | \r\n\t\t\t113 | \r\n\t\t\t113 | \r\n\t\t
| \r\n\t\t\t The User's ID length cannot exceeds 50 characters \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t304 | \r\n\t\t
JIRA Ticket : https://dev.highq.com/jira/browse/COL-67441
Get a list of users\r\n
This API call is used to retrieve a list of users from the system.\r\n
Note:\r\n
1. New query parameters introduced with this version are:\r\n
neverlogin, neverinvited, notingroup, ordertype, orderby, orgid, groupid, externalid, firstname, lastname, email, search\r\n
2. Introduced fields totalcount, total\r\n
3. Introduced the following fields for the response body \r\n
emaildomain, org, invitationsent, createdby, createddate, modifiedby, modifieddate, ifpartner, lastlogindate, invalidlogins, externalid, publicwebsiteprofileid, systemuser, resetpassworddate, usertypeid, avatar, practicegroup, langcode, publicprofile, dateOfBirth\r\n
4. The \"location\" tag has been renamed to \"address\" tag to make it consistent with the Collaborate UI \r\n
5. In every GET API # value for search is not supported because the jersey framework itself does not support #. After # all the parameters/values will be ignored.The response will now display the address as:\r\n
<address>
\r\n<addressid>1</addressid>
\r\n<addressline1>2nd floor</addressline1>
\r\n<addressline2>additional</addressline2>
\r\n<city>london</city>
\r\n<state>state</state>
\r\n<country>uk</country>
\r\n<postCode>EC4R</postCode>
\r\n</address>
\r\nInstead of
<location>\r\n<addressline1>2nd floor, 55 King William Street</addressline1>\r\n<addressline2>additional</addressline2>\r\n<addressline3>state</addressline3>\r\n<city>London</city>\r\n<country>United Kingdom</country>\r\n<postcode>EC4R 9AD</postcode>\r\n</location>
Notes :
\r\n\r\n| Summary | \r\n\t\t\tRef Code (before V4) | \r\n\t\t\tRef Code (V4) | \r\n\t\t
| \r\n\t\t\t Invalid input for user status. It would be ACTIVE,ARCHIVED or INACTIVE \r\n\t\t\t | \r\n\t\t\t147 | \r\n\t\t\t147 | \r\n\t\t
| \r\n\t\t\t The Organisation id is invalid \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t260 | \r\n\t\t
| \r\n\t\t\t The neverinvited value is invalid. True and false are supported neverinvited values. \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t387 | \r\n\t\t
| \r\n\t\t\t The neverlogin value is invalid. True and false are supported neverlogin values. \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t388 | \r\n\t\t
| \r\n\t\t\t The groupids are invalid. \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t214 | \r\n\t\t
| \r\n\t\t\t The notingroup value is invalid. True and false are supported notingroup values. \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t\r\n\t\t\t 389 \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t The ordertype is invalid. name, organisation, status, invited,lastlogin,lname,fname,email,jobtitle,department, \r\n\t\t\tcreateddate,modifieddate and userid are supported ordertypes \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t289 | \r\n\t\t
| \r\n\t\t\t The orderby value is invalid. asc and desc are supported orderby values. \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t290 | \r\n\t\t
| \r\n\t\t\t The offset value is invalid. \r\n\t\t\t | \r\n\t\t\t138 | \r\n\t\t\t138 | \r\n\t\t
| \r\n\t\t\t The limit value is invalid. \r\n\t\t\t | \r\n\t\t\t137 | \r\n\t\t\t137 | \r\n\t\t
JIRA Ticket : https://dev.highq.com/jira/browse/COL-65899
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 | \r\n\t\t\tRef Code (before V4) | \r\n\t\t\tRef Code (V4) | \r\n\t\t
| \r\n\t\t\t Email address is required \r\n\t\t\t | \r\n\t\t\t101 | \r\n\t\t\t101 | \r\n\t\t
| \r\n\t\t\t Invalid email address \r\n\t\t\t | \r\n\t\t\t104 | \r\n\t\t\t104 | \r\n\t\t
| \r\n\t\t\t First name is required \r\n\t\t\t | \r\n\t\t\t102 | \r\n\t\t\t102 | \r\n\t\t
| \r\n\t\t\t Maximum allowed characters for the first name must be between 1 to 100 \r\n\t\t\t | \r\n\t\t\t102 | \r\n\t\t\t352 | \r\n\t\t
| \r\n\t\t\t The secretary's email address is not valid \r\n\t\t\t | \r\n\t\t\t104 | \r\n\t\t\t353 | \r\n\t\t
| \r\n\t\t\t Status must be active or inactive \r\n\t\t\t | \r\n\t\t\t116 | \r\n\t\t\t116 | \r\n\t\t
| \r\n\t\t\t The entered department cannot be more than 256 characters \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t354 | \r\n\t\t
| \r\n\t\t\t The entered ifpartner attribute is invalid \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t355 | \r\n\t\t
| \r\n\t\t\t The entered systemuser attribute is invalid \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t356 | \r\n\t\t
| \r\n\t\t\t The entered usertypeid attribute is invalid \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t357 | \r\n\t\t
| \r\n\t\t\t The entered langcode attribute is invalid \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t358 | \r\n\t\t
| \r\n\t\t\t The entered sourcetype attribute is invalid.Valid values are System, Active directory or System default . \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t359 | \r\n\t\t
| \r\n\t\t\t Please enter valid phone number \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t360 | \r\n\t\t
| \r\n\t\t\t Please enter valid phone number in format {countrycode} ${areacode}${number}. \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t361 | \r\n\t\t
| \r\n\t\t\t Please enter valid mobile number in format {countrycode}${number}. \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t362 | \r\n\t\t
| \r\n\t\t\t Enter a valid office phone country code \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t363 | \r\n\t\t
| \r\n\t\t\t The office phone country code can have a maximum of 4 digits \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t364 | \r\n\t\t
| \r\n\t\t\t Enter a valid office phone area code \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t365 | \r\n\t\t
| \r\n\t\t\t The office phone area code can have a maximum of 5 Digits \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t366 | \r\n\t\t
| \r\n\t\t\t Office phone number should have maximum of 15 digits \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t368 | \r\n\t\t
| \r\n\t\t\t Enter a valid mobile phone country code \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t369 | \r\n\t\t
| \r\n\t\t\t The mobile phone country code can have a maximum of 4 Digits \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t372 | \r\n\t\t
| \r\n\t\t\t Please enter a valid mobile number \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t373 | \r\n\t\t
| \r\n\t\t\t Mobile phone number should have maximum of 20 digits \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t374 | \r\n\t\t
| \r\n\t\t\t Domain does not exist \r\n\t\t\t | \r\n\t\t\t105 | \r\n\t\t\t105 | \r\n\t\t
| \r\n\t\t\t Email already exists in the system \r\n\t\t\t | \r\n\t\t\t111 | \r\n\t\t\t111 | \r\n\t\t
| \r\n\t\t\t Mention organisation in case of self registered domain \r\n\t\t\t | \r\n\t\t\t187 | \r\n\t\t\t187 | \r\n\t\t
| \r\n\t\t\t Mention organisation in case of exceptional domain \r\n\t\t\t | \r\n\t\t\t115 | \r\n\t\t\t115 | \r\n\t\t
| \r\n\t\t\t Org id is not in the proper format \r\n\t\t\t | \r\n\t\t\t112 | \r\n\t\t\t112 | \r\n\t\t
| \r\n\t\t\t Organisation does not exist \r\n\t\t\t | \r\n\t\t\t106 | \r\n\t\t\t106 | \r\n\t\t
| \r\n\t\t\t Domain exist in other organisation \r\n\t\t\t | \r\n\t\t\t114 | \r\n\t\t\t114 | \r\n\t\t
| \r\n\t\t\t Entered Address Id is not valid \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t308 | \r\n\t\t
| \r\n\t\t\t Social link name not found in system. \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t375 | \r\n\t\t
| \r\n\t\t\t The social link name is required \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t376 | \r\n\t\t
| \r\n\t\t\t The social link value is required \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t377 | \r\n\t\t
| \r\n\t\t\t Maximum characters for social link value must be between 1 to 500 \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t378 | \r\n\t\t
| \r\n\t\t\t Enter the name for the custom link \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t379 | \r\n\t\t
| \r\n\t\t\t The custom link value required \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t380 | \r\n\t\t
| \r\n\t\t\t Max characters for custom link name must be between 1 to 500 \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t381 | \r\n\t\t
| \r\n\t\t\t Max characters for custom link value must be between 1 to 500 \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t382 | \r\n\t\t
| \r\n\t\t\t The message link name required \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t383 | \r\n\t\t
| \r\n\t\t\t Message link name not found in system \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t384 | \r\n\t\t
| \r\n\t\t\t The message link value required \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t385 | \r\n\t\t
| \r\n\t\t\t Max characters for message link value must be between 1 to 500 \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t386 | \r\n\t\t
| \r\n\t\t\t The social link is disabled \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t408 | \r\n\t\t
| \r\n\t\t\t The message link is disabled \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t409 | \r\n\t\t
| \r\n\t\t\t The custom link is disabled \r\n\t\t\t | \r\n\t\t\tN/A | \r\n\t\t\t410 | \r\n\t\t
JIRA Ticket : https://dev.highq.com/jira/browse/COL-65685
","operationId":"createUser","consumes":["text/plain","application/json","application/xml"],"produces":["application/xml","application/json"],"parameters":[{"name":"version","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/IntegrationUserDBO"}}],"responses":{"201":{"description":"OK [userid,firstname,lastname,link]","schema":{"$ref":"#/definitions/IntegrationUserDBO"}},"400":{"description":"","schema":{"$ref":"#/definitions/ErrorDBO"}},"500":{"description":"","schema":{"$ref":"#/definitions/ErrorDBO"}}},"security":[{"OAuth":[]}]},"put":{"tags":["User"],"summary":"Update user status","description":"Activate a user within Collaborate\r\nThis API call is used to activate/inactive/anonymise a user within the system. The user identifier is the user ID of the user.
This API call is also used to unlock (users who are locked), invite or resetpassword
Error Codes
| Summary | \r\n\t\t\tRef Code (V4) | \r\n\t\t\tRef Code (before V4) | \r\n\t\t
| \r\n\t\t\t A User ID is required \r\n\t\t\t | \r\n\t\t\t109 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The following users do not exist within the system \r\n\t\t\t | \r\n\t\t\t110 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The status of following anonymised user(s) cannot be changed. \r\n\t\t\t | \r\n\t\t\t325 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t User ID is not in the proper format \r\n\t\t\t | \r\n\t\t\t113 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t This given action is invalid. Please use unlock,invite or resetpassword \r\n\t\t\t | \r\n\t\t\t367 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The following users are not active in the system \r\n\t\t\t | \r\n\t\t\t395 | \r\n\t\t\t\r\n\t\t |
JIRA Ticket : https://dev.highq.com/jira/browse/COL-62810
Add a profile image for a user in Publisher
This API call is used to add a new profile image(avatar)
Note:
1. Following form-data parameters are optional: avatarXPosition, avatarYPosition,avatarWidth, avatarHeight
Error Codes
| Summary | \r\n\t\t\tRef Code (V5) | \r\n\t\t
| \r\n\t\t\t Please enter valid numbers \r\n\t\t\t | \r\n\t\t\t396 | \r\n\t\t
| \r\n\t\t\t The file was not found \r\n\t\t\t | \r\n\t\t\t397 | \r\n\t\t
| \r\n\t\t\t Upload an image which has a size greater than 0 \r\n\t\t\t | \r\n\t\t\t406 | \r\n\t\t
| \r\n\t\t\t The image type you are trying to upload is not supported \r\n\t\t\t | \r\n\t\t\t398 | \r\n\t\t
| \r\n\t\t\t Due to a system error, this {0} cannot be uploaded \r\n\t\t\t | \r\n\t\t\t399 | \r\n\t\t
| \r\n\t\t\t This file is unsupported, the file upload has been terminated \r\n\t\t\t | \r\n\t\t\t400 | \r\n\t\t
| \r\n\t\t\t This image is too small. Ensure the shortest side is at least 256 pixels long. \r\n\t\t\t | \r\n\t\t\t401 | \r\n\t\t
| \r\n\t\t\t Please enter valid x position or width. The sum of x position and width should not exceed the actual width of an image. \r\n\t\t\t | \r\n\t\t\t402 | \r\n\t\t
| \r\n\t\t\t Please enter valid y position or height. The sum of y position and height should not exceed the actual height of an image. \r\n\t\t\t | \r\n\t\t\t403 | \r\n\t\t
| \r\n\t\t\t Image height and width must be same. Only a square image can be uploaded for a user avatar. \r\n\t\t\t | \r\n\t\t\t404 | \r\n\t\t
| \r\n\t\t\t Error occurred while transferring data to repository or updating database \r\n\t\t\t | \r\n\t\t\t405 | \r\n\t\t
JIRA Ticket : https://dev.highq.com/jira/browse/COL-66662
Delete a profile image for a user
This API call is used to delete a profile image.
Error Codes
| Summary | \r\n\t\t\tRef Code (V4) | \r\n\t\t\tRef Code (before V4) | \r\n\t\t
| \r\n\t\t\t The following users do not exist within the system \r\n\t\t\t | \r\n\t\t\t110 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The given action cannot be performed on anonymised user(s). \r\n\t\t\t | \r\n\t\t\t325 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t User ID is not in proper format \r\n\t\t\t | \r\n\t\t\t113 | \r\n\t\t\t\r\n\t\t |
JIRA Ticket : https://dev.highq.com/jira/browse/COL-66663
This API call is used to get an experience object in the system.\r\n
Error Codes
| Summary | \r\n\t\t\tRef Code (V4) | \r\n\t\t\tRef Code (before V4) | \r\n\t\t
| \r\n\t\t\t The experience id is invalid \r\n\t\t\t | \r\n\t\t\t326 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t User id is not in the proper format \r\n\t\t\t | \r\n\t\t\t113 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The given userid is invalid \r\n\t\t\t | \r\n\t\t\t342 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The experience id is not associated with the given user id \r\n\t\t\t | \r\n\t\t\t343 | \r\n\t\t\tN/A | \r\n\t\t
JIRA Ticket : https://dev.highq.com/jira/browse/COL-66710
This API call is used to change a experience.\r\n
Error Codes
| Summary | \r\n\t\t\tRef Code (V4) | \r\n\t\t\tRef Code (before V4) | \r\n\t\t
| \r\n\t\t\t User id is not in proper format \r\n\t\t\t | \r\n\t\t\t113 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The given userid is invalid \r\n\t\t\t | \r\n\t\t\t342 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The experience id is invalid \r\n\t\t\t | \r\n\t\t\t326 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The experience id is not associated with the given user id \r\n\t\t\t | \r\n\t\t\t343 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The company name is required \r\n\t\t\t | \r\n\t\t\t328 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The job title is required \r\n\t\t\t | \r\n\t\t\t329 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The Experience From month field is required \r\n\t\t\t | \r\n\t\t\t330 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The Experience From year field is required \r\n\t\t\t | \r\n\t\t\t331 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The Experience To month field is required \r\n\t\t\t | \r\n\t\t\t332 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The Experience To year field is required \r\n\t\t\t | \r\n\t\t\t333 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The information in the Experience From month field is not valid \r\n\t\t\t | \r\n\t\t\t335 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The information in the Experience To month field is not valid \r\n\t\t\t | \r\n\t\t\t336 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t Please enter a year between 1900 and the current year as your start date \r\n\t\t\t | \r\n\t\t\t337 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t Please enter a year between 1900 and the current year as your end date \r\n\t\t\t | \r\n\t\t\t338 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The information in the Experience from year field is not formatted correctly \r\n\t\t\t | \r\n\t\t\t339 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The information in the Experience To year field is not formatted correctly \r\n\t\t\t | \r\n\t\t\t340 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The information in the Currently working value field is not valid \r\n\t\t\t | \r\n\t\t\t341 | \r\n\t\t\t\r\n\t\t |
JIRA Ticket : https://dev.highq.com/jira/browse/COL-66712
This API call is used to delete an experience.\r\n
Error Codes
| Summary | \r\n\t\t\tRef Code (V4) | \r\n\t\t\tRef Code (before V4) | \r\n\t\t
| \r\n\t\t\t The experience id is invalid \r\n\t\t\t | \r\n\t\t\t326 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t User id is not in the proper format \r\n\t\t\t | \r\n\t\t\t113 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The given userid is invalid \r\n\t\t\t | \r\n\t\t\t342 | \r\n\t\t\tN/A | \r\n\t\t
| \r\n\t\t\t The experience id is not associated with the given user id \r\n\t\t\t | \r\n\t\t\t343 | \r\n\t\t\tN/A | \r\n\t\t
JIRA Ticket : https://dev.highq.com/jira/browse/COL-66713
Move an existing domain from one organisation to another within Collaborate\r\nThis API call is used to move a domain to a new organisation object in the system. This in turn will move all users who have an email address associated with that domain to the new organisation.
Error Codes
| Summary | \r\n\t\t\tRef Code (V4) | \r\n\t\t\tRef Code (before V4) | \r\n\t\t
| \r\n\t\t\t The given domain ID is invalid \r\n\t\t\t | \r\n\t\t\t263 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t A User ID is required \r\n\t\t\t | \r\n\t\t\t109 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t User ID is not in proper format \r\n\t\t\t | \r\n\t\t\t113 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The following users do not exist within the system \r\n\t\t\t | \r\n\t\t\t110 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t Moving the selected users to 'bidder' will turn the users into bidders. Delete the following files and retry this operation. \r\n\t\t\t | \r\n\t\t\t334 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The given action cannot be performed on anonymised user(s). \r\n\t\t\t | \r\n\t\t\t325 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The specified organisation does not exist \r\n\t\t\t | \r\n\t\t\t100 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The organisation ID does not match with the domain ID \r\n\t\t\t | \r\n\t\t\t411 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The Organisation ID is required \r\n\t\t\t | \r\n\t\t\t322 | \r\n\t\t\t\r\n\t\t |
| \r\n\t\t\t The Organisation ID is invalid \r\n\t\t\t | \r\n\t\t\t260 | \r\n\t\t\t\r\n\t\t |
JIRA Ticket : https://dev.highq.com/jira/browse/COL-75419