POST data
Api-docs for RC: https://api-rc.quinyx.com/v2/docs (select “collaboration-groups” definition)
Api-docs: https://api.quinyx.com/v2/docs (select “collaboration-groups” definition)
Base URL can be found on links above for both environments. The remainder of this article should be considered a complement to the above Open API documentation.
POST/groups
This API call creates new collaboration groups for a domain within Quinyx.
Field description
Mandatory fields will be marked with a * icon.
Endpoint
This API call has no fields in the endpoint.
Body
- name*: The name of the new collaboration group.
- domainId*: The ID of the domain for which you want to create the collaboration group in.
- parentId*: The ID of the parent collaboration group.
- labelId*: The ID of the label you want to associate with the new collaboration group.
- domoDashboardId: The ID of the Domo dashboard you want to associate the new collaboration group with.
Response
- id: Displays the collaboration group ID.
- name: Displays the name of the collaboration group.
- parentId: Displays the ID of the parent collaboration group associated with the fetched collaboration group.
- domainId:
- labelId: Displays the label ID of the label associated with the fetched collaboration group.
- domoDashboardId: Displays the Domo dashboard ID associated with the fetched collaboration group.
Example
End point
For the RC environment: https://api-rc.quinyx.com/v2/collaboration-groups/groups
Request body
{
"name" : "string",
"domainId" : 0,
"parentId" : 0,
"labelId" : 0,
"domoDashboardId" : "string"
}Responses
{
"id" : 0,
"name" : "Name of Collaboration group",
"parentId" : 0,
"domainId" : 0,
"labelId" : 0,
"domoDashboardId" : "string"
}POST/associate-groups
This API call associates groups with a collaboration group.
Field description
Mandatory fields will be marked with a * icon.
Endpoint
This API call has no fields in the endpoint.
Body
- collaborationGroupId*: The ID of the collaboration group you want to associate with the list of groups.
- groupIds*: A list of IDs from groups you want to associate with a collaboration group.
Response
- collaborationGroupId: Displays the collaboration group ID.
- groupIds: Displays all group IDs associated with the collaboration group.
Example
End point
For the RC environment: https://api-rc.quinyx.com/v2/collaboration-groups/associate-groups
Request body
{
"collaborationGroupId": 0,
"groupIds": [0]
}Responses
{
"collaborationGroupId": 0,
"groupIds": [0]
}POST/associate-employees
This API call associates employees to a collaboration group.
Field description
Mandatory fields will be marked with a * icon.
Endpoint
This API call has no fields in the endpoint.
Body
- collaborationGroupId*: The ID of the collaboration group you want to associate with the list of employees.
- employeeIds*: A list of IDs from employees you want to associate with a collaboration group.
Response
- collaborationGroupId: Displays the collaboration group ID.
- employeeIds: Displays all employee IDs associated with the collaboration group.
Example
End point
For the RC environment: https://api-rc.quinyx.com/v2/collaboration-groups/associate-employees
Request body
{
"collaborationGroupId": 0,
"employeeIds": [0]
}Responses
{
"collaborationGroupId": 0,
"employeeIds": [0]
}