openapi: 3.2.0 info: title: Adobe Workfront Group API version: v19.0 servers: - url: https://{domain}.my.workfront.com/attask/api/v19.0 description: Production environment - url: https://{domain}.preview.workfront.com/attask/api/v19.0 description: Preview environment security: - ApiKeyHeader: [] - SessionIDHeader: [] - AtTaskCookie: [] - WFAuthCookie: [] tags: - name: Group paths: /group/{id}: get: summary: Get for Group operationId: getGroup parameters: - name: id in: path description: Object ID required: true schema: type: string - name: fields in: query description: JSON array defining the fields to retrieve required: false example: '["ID", "name"]' content: application/json: schema: type: array items: type: string responses: '200': description: Great Success content: application/json: schema: type: object properties: data: $ref: ./Group.json '422': $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY' '400': $ref: '#/components/responses/400_BAD_REQUEST' '429': $ref: '#/components/responses/429_TOO_MANY_REQUESTS' '403': $ref: '#/components/responses/403_FORBIDDEN' '401': $ref: '#/components/responses/401_UNAUTHORIZED' '404': $ref: '#/components/responses/404_NOT_FOUND' '500': $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR' '410': $ref: '#/components/responses/410_GONE' tags: - Group put: summary: Edit a Group operationId: editGroup parameters: - name: id in: path description: Object ID required: true schema: type: string - name: fields in: query description: JSON array defining the fields to retrieve required: false example: '["ID", "name"]' content: application/json: schema: type: array items: type: string responses: '200': description: Great Success content: application/json: schema: type: object properties: data: $ref: ./Group.json '422': $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY' '400': $ref: '#/components/responses/400_BAD_REQUEST' '429': $ref: '#/components/responses/429_TOO_MANY_REQUESTS' '403': $ref: '#/components/responses/403_FORBIDDEN' '401': $ref: '#/components/responses/401_UNAUTHORIZED' '404': $ref: '#/components/responses/404_NOT_FOUND' '500': $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR' '410': $ref: '#/components/responses/410_GONE' tags: - Group delete: summary: Delete for Group operationId: deleteGroup parameters: - name: id in: path description: Object ID required: true schema: type: string - name: force in: query description: force delete flag required: false schema: type: boolean responses: '200': $ref: '#/components/responses/200_OK' '422': $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY' '400': $ref: '#/components/responses/400_BAD_REQUEST' '429': $ref: '#/components/responses/429_TOO_MANY_REQUESTS' '403': $ref: '#/components/responses/403_FORBIDDEN' '401': $ref: '#/components/responses/401_UNAUTHORIZED' '404': $ref: '#/components/responses/404_NOT_FOUND' '500': $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR' '410': $ref: '#/components/responses/410_GONE' tags: - Group /group: get: summary: Bulk Get for Group operationId: getGroups parameters: - name: id in: query description: Object IDs required: true schema: type: string example: id1,id2,id3 - name: fields in: query description: JSON array defining the fields to retrieve required: false example: '["ID", "name"]' content: application/json: schema: type: array items: type: string responses: '200': description: Great Success content: application/json: schema: type: object properties: data: anyOf: - $ref: ./Group.json - type: array items: $ref: ./Group.json '422': $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY' '400': $ref: '#/components/responses/400_BAD_REQUEST' '429': $ref: '#/components/responses/429_TOO_MANY_REQUESTS' '403': $ref: '#/components/responses/403_FORBIDDEN' '401': $ref: '#/components/responses/401_UNAUTHORIZED' '404': $ref: '#/components/responses/404_NOT_FOUND' '500': $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR' '410': $ref: '#/components/responses/410_GONE' tags: - Group put: summary: Bulk Edit for Group operationId: editGroups parameters: - name: fields in: query description: JSON array defining the fields to retrieve required: false example: '["ID", "name"]' content: application/json: schema: type: array items: type: string requestBody: content: application/json: schema: anyOf: - $ref: ./Group.json - type: array items: $ref: ./Group.json responses: '200': description: Great Success content: application/json: schema: type: object properties: data: anyOf: - $ref: ./Group.json - type: array items: $ref: ./Group.json '422': $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY' '400': $ref: '#/components/responses/400_BAD_REQUEST' '429': $ref: '#/components/responses/429_TOO_MANY_REQUESTS' '403': $ref: '#/components/responses/403_FORBIDDEN' '401': $ref: '#/components/responses/401_UNAUTHORIZED' '404': $ref: '#/components/responses/404_NOT_FOUND' '500': $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR' '410': $ref: '#/components/responses/410_GONE' tags: - Group post: summary: Create or copy a group operationId: addGroups parameters: - name: fields in: query description: JSON array defining the fields to retrieve required: false example: '["ID", "name"]' content: application/json: schema: type: array items: type: string - name: copySourceID in: query description: Source object ID for copy required: false schema: type: string requestBody: content: application/json: schema: anyOf: - $ref: ./Group.json - type: array items: $ref: ./Group.json responses: '200': description: Great Success content: application/json: schema: type: object properties: data: anyOf: - $ref: ./Group.json - type: array items: $ref: ./Group.json '422': $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY' '400': $ref: '#/components/responses/400_BAD_REQUEST' '429': $ref: '#/components/responses/429_TOO_MANY_REQUESTS' '403': $ref: '#/components/responses/403_FORBIDDEN' '401': $ref: '#/components/responses/401_UNAUTHORIZED' '404': $ref: '#/components/responses/404_NOT_FOUND' '500': $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR' '410': $ref: '#/components/responses/410_GONE' tags: - Group delete: summary: Bulk Delete for Group operationId: deleteGroups parameters: - name: id in: query description: Object IDs required: true schema: type: string example: id1,id2,id3 - name: force in: query description: force delete flag required: false schema: type: boolean responses: '200': $ref: '#/components/responses/200_OK' '422': $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY' '400': $ref: '#/components/responses/400_BAD_REQUEST' '429': $ref: '#/components/responses/429_TOO_MANY_REQUESTS' '403': $ref: '#/components/responses/403_FORBIDDEN' '401': $ref: '#/components/responses/401_UNAUTHORIZED' '404': $ref: '#/components/responses/404_NOT_FOUND' '500': $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR' '410': $ref: '#/components/responses/410_GONE' tags: - Group /group/replace: put: summary: Replace of group operationId: replaceGroups parameters: - name: id in: query description: Object IDs to be replaced required: true schema: type: string example: id1,id2,id3 - name: replacementID in: query description: Object ID to replace with required: true schema: type: string responses: '200': $ref: '#/components/responses/200_OK' '422': $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY' '400': $ref: '#/components/responses/400_BAD_REQUEST' '429': $ref: '#/components/responses/429_TOO_MANY_REQUESTS' '403': $ref: '#/components/responses/403_FORBIDDEN' '401': $ref: '#/components/responses/401_UNAUTHORIZED' '404': $ref: '#/components/responses/404_NOT_FOUND' '500': $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR' '410': $ref: '#/components/responses/410_GONE' tags: - Group /group/count: get: summary: Count of group operationId: countGroups parameters: - name: filters in: query description: JSON representing the filtering conditions required: false content: application/json: schema: type: object responses: '200': description: Great Success content: application/json: schema: type: object properties: data: type: object properties: count: type: integer format: int32 '422': $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY' '400': $ref: '#/components/responses/400_BAD_REQUEST' '429': $ref: '#/components/responses/429_TOO_MANY_REQUESTS' '403': $ref: '#/components/responses/403_FORBIDDEN' '401': $ref: '#/components/responses/401_UNAUTHORIZED' '404': $ref: '#/components/responses/404_NOT_FOUND' '500': $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR' '410': $ref: '#/components/responses/410_GONE' tags: - Group /group/search: get: summary: Search of group operationId: searchGroups parameters: - name: filters in: query description: JSON representing the filtering conditions required: false content: application/json: schema: type: object - name: fields in: query description: JSON array defining the fields to retrieve required: false example: '["ID", "name"]' content: application/json: schema: type: array items: type: string - name: listOptions in: query description: JSON object defining the list options required: false content: application/json: schema: $ref: ./ListOptions.json responses: '200': description: Great Success content: application/json: schema: type: object properties: data: type: array items: $ref: ./Group.json '422': $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY' '400': $ref: '#/components/responses/400_BAD_REQUEST' '429': $ref: '#/components/responses/429_TOO_MANY_REQUESTS' '403': $ref: '#/components/responses/403_FORBIDDEN' '401': $ref: '#/components/responses/401_UNAUTHORIZED' '404': $ref: '#/components/responses/404_NOT_FOUND' '500': $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR' '410': $ref: '#/components/responses/410_GONE' tags: - Group /group/report: get: summary: Report of group operationId: reportGroups parameters: - name: filters in: query description: JSON representing the filtering conditions required: false content: application/json: schema: type: object - name: listOptions in: query description: JSON object defining the list options required: false content: application/json: schema: $ref: ./ListOptions.json responses: '200': description: Great Success content: application/json: schema: type: object properties: data: type: object '422': $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY' '400': $ref: '#/components/responses/400_BAD_REQUEST' '429': $ref: '#/components/responses/429_TOO_MANY_REQUESTS' '403': $ref: '#/components/responses/403_FORBIDDEN' '401': $ref: '#/components/responses/401_UNAUTHORIZED' '404': $ref: '#/components/responses/404_NOT_FOUND' '500': $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR' '410': $ref: '#/components/responses/410_GONE' tags: - Group /group/{id}/share: put: summary: Sharing of a Group operationId: shareGroup parameters: - name: id in: path description: Object ID required: true schema: type: string - name: accessorObjCode in: query required: true schema: type: string - name: accessorID in: query required: true schema: type: string - name: coreAction in: query required: true schema: type: string enum: - VIEW - EDIT - DELETE - name: forbiddenActions in: query schema: type: array items: type: string enum: - SHARE - SHARE_SYSTEMWIDE responses: '200': $ref: '#/components/responses/200_OK' '422': $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY' '400': $ref: '#/components/responses/400_BAD_REQUEST' '429': $ref: '#/components/responses/429_TOO_MANY_REQUESTS' '403': $ref: '#/components/responses/403_FORBIDDEN' '401': $ref: '#/components/responses/401_UNAUTHORIZED' '404': $ref: '#/components/responses/404_NOT_FOUND' '500': $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR' '410': $ref: '#/components/responses/410_GONE' tags: - Group /group/share: put: summary: Batch sharing of a Group operationId: batchShareGroup parameters: - name: id in: query description: Object IDs required: true schema: type: string example: id1,id2,id3 - name: accessorObjCode in: query required: true schema: type: string - name: accessorID in: query required: true schema: type: string - name: coreAction in: query required: true schema: type: string enum: - VIEW - EDIT - DELETE - name: forbiddenActions in: query schema: type: array items: type: string enum: - SHARE - SHARE_SYSTEMWIDE responses: '200': $ref: '#/components/responses/200_OK' '422': $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY' '400': $ref: '#/components/responses/400_BAD_REQUEST' '429': $ref: '#/components/responses/429_TOO_MANY_REQUESTS' '403': $ref: '#/components/responses/403_FORBIDDEN' '401': $ref: '#/components/responses/401_UNAUTHORIZED' '404': $ref: '#/components/responses/404_NOT_FOUND' '500': $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR' '410': $ref: '#/components/responses/410_GONE' tags: - Group /group/{id}/unshare: put: summary: Un-sharing of a Group operationId: unshareGroup parameters: - name: id in: path description: Object ID required: true schema: type: string - name: accessorObjCode in: query required: true schema: type: string - name: accessorID in: query required: true schema: type: string responses: '200': $ref: '#/components/responses/200_OK' '422': $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY' '400': $ref: '#/components/responses/400_BAD_REQUEST' '429': $ref: '#/components/responses/429_TOO_MANY_REQUESTS' '403': $ref: '#/components/responses/403_FORBIDDEN' '401': $ref: '#/components/responses/401_UNAUTHORIZED' '404': $ref: '#/components/responses/404_NOT_FOUND' '500': $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR' '410': $ref: '#/components/responses/410_GONE' tags: - Group /group/unshare: put: summary: Batch un-sharing of a Group operationId: batchUnshareGroup parameters: - name: id in: query description: Object IDs required: true schema: type: string example: id1,id2,id3 - name: accessorObjCode in: query required: true schema: type: string - name: accessorID in: query required: true schema: type: string responses: '200': $ref: '#/components/responses/200_OK' '422': $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY' '400': $ref: '#/components/responses/400_BAD_REQUEST' '429': $ref: '#/components/responses/429_TOO_MANY_REQUESTS' '403': $ref: '#/components/responses/403_FORBIDDEN' '401': $ref: '#/components/responses/401_UNAUTHORIZED' '404': $ref: '#/components/responses/404_NOT_FOUND' '500': $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR' '410': $ref: '#/components/responses/410_GONE' tags: - Group /group/{id}/sharePublic: put: summary: Public share of a Group operationId: sharePublicGroup parameters: - name: id in: path description: Object ID required: true schema: type: string - name: coreAction in: query required: true schema: type: string enum: - VIEW - EDIT - DELETE - name: forbiddenActions in: query schema: type: array items: type: string enum: - SHARE - SHARE_SYSTEMWIDE responses: '200': $ref: '#/components/responses/200_OK' '422': $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY' '400': $ref: '#/components/responses/400_BAD_REQUEST' '429': $ref: '#/components/responses/429_TOO_MANY_REQUESTS' '403': $ref: '#/components/responses/403_FORBIDDEN' '401': $ref: '#/components/responses/401_UNAUTHORIZED' '404': $ref: '#/components/responses/404_NOT_FOUND' '500': $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR' '410': $ref: '#/components/responses/410_GONE' tags: - Group /group/sharePublic: put: summary: Batch public share of a Group operationId: batchSharePublicGroup parameters: - name: id in: query description: Object IDs required: true schema: type: string example: id1,id2,id3 - name: coreAction in: query required: true schema: type: string enum: - VIEW - EDIT - DELETE - name: forbiddenActions in: query schema: type: array items: type: string enum: - SHARE - SHARE_SYSTEMWIDE responses: '200': $ref: '#/components/responses/200_OK' '422': $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY' '400': $ref: '#/components/responses/400_BAD_REQUEST' '429': $ref: '#/components/responses/429_TOO_MANY_REQUESTS' '403': $ref: '#/components/responses/403_FORBIDDEN' '401': $ref: '#/components/responses/401_UNAUTHORIZED' '404': $ref: '#/components/responses/404_NOT_FOUND' '500': $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR' '410': $ref: '#/components/responses/410_GONE' tags: - Group /group/{id}/unsharePublic: put: summary: Public un-share of a Group operationId: unsharePublicGroup parameters: - name: id in: path description: Object ID required: true schema: type: string responses: '200': $ref: '#/components/responses/200_OK' '422': $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY' '400': $ref: '#/components/responses/400_BAD_REQUEST' '429': $ref: '#/components/responses/429_TOO_MANY_REQUESTS' '403': $ref: '#/components/responses/403_FORBIDDEN' '401': $ref: '#/components/responses/401_UNAUTHORIZED' '404': $ref: '#/components/responses/404_NOT_FOUND' '500': $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR' '410': $ref: '#/components/responses/410_GONE' tags: - Group /group/unsharePublic: put: summary: Batch public un-share of a Group operationId: batchUnsharePublicGroup parameters: - name: id in: query description: Object IDs required: true schema: type: string example: id1,id2,id3 responses: '200': $ref: '#/components/responses/200_OK' '422': $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY' '400': $ref: '#/components/responses/400_BAD_REQUEST' '429': $ref: '#/components/responses/429_TOO_MANY_REQUESTS' '403': $ref: '#/components/responses/403_FORBIDDEN' '401': $ref: '#/components/responses/401_UNAUTHORIZED' '404': $ref: '#/components/responses/404_NOT_FOUND' '500': $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR' '410': $ref: '#/components/responses/410_GONE' tags: - Group /group/addRemoveLicenseTypeLimits: summary: addRemoveLicenseTypeLimits put: operationId: groupAddRemoveLicenseTypeLimits parameters: - name: addGroupIDs in: query description: addGroupIDs required: false schema: type: array items: type: string - name: removeGroupIDs in: query description: removeGroupIDs required: false schema: type: array items: type: string responses: '200': description: Great Success '422': $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY' '400': $ref: '#/components/responses/400_BAD_REQUEST' '429': $ref: '#/components/responses/429_TOO_MANY_REQUESTS' '403': $ref: '#/components/responses/403_FORBIDDEN' '401': $ref: '#/components/responses/401_UNAUTHORIZED' '404': $ref: '#/components/responses/404_NOT_FOUND' '500': $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR' '410': $ref: '#/components/responses/410_GONE' tags: - Group /group/addSubgroups: summary: addSubgroups put: operationId: groupAddSubgroups parameters: - name: ID in: query description: Object ID required: false schema: type: string - name: newSubgroupIDs in: query description: newSubgroupIDs required: false schema: type: array items: type: string responses: '200': description: Great Success content: application/json: schema: type: object additionalProperties: type: object '422': $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY' '400': $ref: '#/components/responses/400_BAD_REQUEST' '429': $ref: '#/components/responses/429_TOO_MANY_REQUESTS' '403': $ref: '#/components/responses/403_FORBIDDEN' '401': $ref: '#/components/responses/401_UNAUTHORIZED' '404': $ref: '#/components/responses/404_NOT_FOUND' '500': $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR' '410': $ref: '#/components/responses/410_GONE' tags: - Group /group/assignMultiple: summary: assignMultiple put: operationId: groupAssignMultiple parameters: - name: ID in: query description: Object ID required: false schema: type: string - name: userIDs in: query description: userIDs required: false schema: type: array items: type: string - name: roleIDs in: query description: roleIDs required: false schema: type: array items: type: string - name: teamID in: query description: teamID required: false schema: type: string responses: '200': description: Great Success '422': $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY' '400': $ref: '#/components/responses/400_BAD_REQUEST' '429': $ref: '#/components/responses/429_TOO_MANY_REQUESTS' '403': $ref: '#/components/responses/403_FORBIDDEN' '401': $ref: '#/components/responses/401_UNAUTHORIZED' '404': $ref: '#/components/responses/404_NOT_FOUND' '500': $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR' '410': $ref: '#/components/responses/410_GONE' tags: - Group /group/calculateDataExtension: summary: calculateDataExtension put: operationId: groupCalculateDataExtension parameters: - name: ID in: query description: Object ID required: false schema: type: string responses: '200': description: Great Success '422': $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY' '400': $ref: '#/components/responses/400_BAD_REQUEST' '429': $ref: '#/components/responses/429_TOO_MANY_REQUESTS' '403': $ref: '#/components/responses/403_FORBIDDEN' '401': $ref: '#/components/responses/401_UNAUTHORIZED' '404': $ref: '#/components/responses/404_NOT_FOUND' '500': $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR' '410': $ref: '#/components/responses/410_GONE' tags: - Group /group/checkDelete: summary: checkDelete put: operationId: groupCheckDelete parameters: - name: ids in: query description: ids required: false schema: type: array items: type: string responses: '200': description: Great Success '422': $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY' '400': $ref: '#/components/responses/400_BAD_REQUEST' '429': $ref: '#/components/responses/429_TOO_MANY_REQUESTS' '403': $ref: '#/components/responses/403_FORBIDDEN' '401': $ref: '#/components/responses/401_UNAUTHORIZED' '404': $ref: '#/components/responses/404_NOT_FOUND' '500': $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR' '410': $ref: '#/components/responses/410_GONE' tags: - Group /group/completeGroupInfo: summary: completeGroupInfo put: operationId: groupCompleteGroupInfo parameters: - name: groupId in: query description: groupId required: false schema: type: string responses: '200': description: Great Success content: application/json: schema: type: object additionalProperties: type: object '422': $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY' '400': $ref: '#/components/responses/400_BAD_REQUEST' '429': $ref: '#/components/responses/429_TOO_MANY_REQUESTS' '403': $ref: '#/components/responses/403_FORBIDDEN' '401': $ref: '#/components/responses/401_UNAUTHORIZED' '404': $ref: '#/components/responses/404_NOT_FOUND' '500': $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR' '410': $ref: '#/components/responses/410_GONE' tags: - Group /group/getGroupMembers: summary: getGroupMembers put: operationId: groupGetGroupMembers parameters: - name: ID in: query description: Object ID required: false schema: type: string responses: '200': description: Great Success content: application/json: schema: type: array items: type: object '422': $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY' '400': $ref: '#/components/responses/400_BAD_REQUEST' '429': $ref: '#/components/responses/429_TOO_MANY_REQUESTS' '403': $ref: '#/components/responses/403_FORBIDDEN' '401': $ref: '#/components/responses/401_UNAUTHORIZED' '404': $ref: '#/components/responses/404_NOT_FOUND' '500': $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR' '410': $ref: '#/components/responses/410_GONE' tags: - Group /group/getParents: summary: getParents put: operationId: groupGetParents parameters: - name: ID in: query description: Object ID required: false schema: type: string responses: '200': description: Great Success content: application/json: schema: type: array items: type: object '422': $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY' '400': $ref: '#/components/responses/400_BAD_REQUEST' '429': $ref: '#/components/responses/429_TOO_MANY_REQUESTS' '403': $ref: '#/components/responses/403_FORBIDDEN' '401': $ref: '#/components/responses/401_UNAUTHORIZED' '404': $ref: '#/components/responses/404_NOT_FOUND' '500': $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR' '410': $ref: '#/components/responses/410_GONE' tags: - Group /group/linkExternalObject: summary: linkExternalObject put: operationId: groupLinkExternalObject parameters: - name: objID in: query description: objID required: false schema: type: string - name: linkedObjectID in: query description: linkedObjectID required: false schema: type: string - name: integrationType in: query description: integrationType required: false schema: type: string - name: URL in: query description: URL required: false schema: type: string - name: params in: query description: params required: false schema: type: array items: type: string responses: '200': description: Great Success '422': $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY' '400': $ref: '#/components/responses/400_BAD_REQUEST' '429': $ref: '#/components/responses/429_TOO_MANY_REQUESTS' '403': $ref: '#/components/responses/403_FORBIDDEN' '401': $ref: '#/components/responses/401_UNAUTHORIZED' '404': $ref: '#/components/responses/404_NOT_FOUND' '500': $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR' '410': $ref: '#/components/responses/410_GONE' tags: - Group /group/replaceDeleteGroups: summary: replaceDeleteGroups put: operationId: groupReplaceDeleteGroups parameters: - name: ids in: query description: ids required: false schema: type: array items: type: string - name: replaceGroupID in: query description: replaceGroupID required: false schema: type: string responses: '200': description: Great Success '422': $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY' '400': $ref: '#/components/responses/400_BAD_REQUEST' '429': $ref: '#/components/responses/429_TOO_MANY_REQUESTS' '403': $ref: '#/components/responses/403_FORBIDDEN' '401': $ref: '#/components/responses/401_UNAUTHORIZED' '404': $ref: '#/components/responses/404_NOT_FOUND' '500': $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR' '410': $ref: '#/components/responses/410_GONE' tags: - Group /group/setLicenseTypeLimit: summary: setLicenseTypeLimit put: operationId: groupSetLicenseTypeLimit parameters: - name: groupID in: query description: groupID required: false schema: type: string - name: licenseType in: query description: licenseType required: false schema: type: string enum: - F - T - C - L - R - X - F - C - R - X - name: ltLimit in: query description: ltLimit required: false schema: type: integer format: int32 responses: '200': description: Great Success '422': $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY' '400': $ref: '#/components/responses/400_BAD_REQUEST' '429': $ref: '#/components/responses/429_TOO_MANY_REQUESTS' '403': $ref: '#/components/responses/403_FORBIDDEN' '401': $ref: '#/components/responses/401_UNAUTHORIZED' '404': $ref: '#/components/responses/404_NOT_FOUND' '500': $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR' '410': $ref: '#/components/responses/410_GONE' tags: - Group /group/unlinkExternalObject: summary: unlinkExternalObject put: operationId: groupUnlinkExternalObject parameters: - name: objID in: query description: objID required: false schema: type: string - name: linkedObjectID in: query description: linkedObjectID required: false schema: type: string - name: integrationType in: query description: integrationType required: false schema: type: string responses: '200': description: Great Success '422': $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY' '400': $ref: '#/components/responses/400_BAD_REQUEST' '429': $ref: '#/components/responses/429_TOO_MANY_REQUESTS' '403': $ref: '#/components/responses/403_FORBIDDEN' '401': $ref: '#/components/responses/401_UNAUTHORIZED' '404': $ref: '#/components/responses/404_NOT_FOUND' '500': $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR' '410': $ref: '#/components/responses/410_GONE' tags: - Group /group/updateMembersList: summary: updateMembersList put: operationId: groupUpdateMembersList parameters: - name: ID in: query description: Object ID required: false schema: type: string - name: newMemberIDs in: query description: newMemberIDs required: false schema: type: array items: type: string - name: removedMemberIDs in: query description: removedMemberIDs required: false schema: type: array items: type: string responses: '200': description: Great Success content: application/json: schema: type: object additionalProperties: type: object '422': $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY' '400': $ref: '#/components/responses/400_BAD_REQUEST' '429': $ref: '#/components/responses/429_TOO_MANY_REQUESTS' '403': $ref: '#/components/responses/403_FORBIDDEN' '401': $ref: '#/components/responses/401_UNAUTHORIZED' '404': $ref: '#/components/responses/404_NOT_FOUND' '500': $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR' '410': $ref: '#/components/responses/410_GONE' tags: - Group components: responses: 200_OK: description: Great Success content: application/json: schema: type: object properties: data: type: object properties: success: type: boolean 429_TOO_MANY_REQUESTS: description: Too many concurrent API requests for the given customer. content: application/json: schema: type: object properties: error: type: object properties: class: type: string message: type: string 500_INTERNAL_SERVER_ERROR: description: An unexpected error occurred. content: application/json: schema: type: object properties: error: type: object properties: class: type: string message: type: string 422_UNPROCESSABLE_ENTITY: description: The request contains invalid data. content: application/json: schema: type: object properties: error: type: object properties: class: type: string message: type: string 401_UNAUTHORIZED: description: The request is not authenticated. content: application/json: schema: type: object properties: error: type: object properties: class: type: string message: type: string 400_BAD_REQUEST: description: The operation is not supported. content: application/json: schema: type: object properties: error: type: object properties: class: type: string message: type: string 404_NOT_FOUND: description: The requested resource was not found. content: application/json: schema: type: object properties: error: type: object properties: class: type: string message: type: string 403_FORBIDDEN: description: The user does not have permission to perform the operation. content: application/json: schema: type: object properties: error: type: object properties: class: type: string message: type: string 410_GONE: description: The requested resource is no longer available in this API version. content: application/json: schema: type: object properties: error: type: object properties: class: type: string message: type: string securitySchemes: SessionIDHeader: type: apiKey name: sessionID in: header AtTaskCookie: type: apiKey name: attask in: cookie WFAuthCookie: type: apiKey name: wf-auth in: cookie ApiKeyHeader: type: apiKey name: apiKey in: header