openapi: 3.2.0 info: title: Adobe Workfront Assignment 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: Assignment paths: /assignment/{id}: get: summary: Get for Assignment operationId: getAssignment 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: ./Assignment.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: - Assignment put: summary: Edit a Assignment operationId: editAssignment 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: ./Assignment.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: - Assignment delete: summary: Delete for Assignment operationId: deleteAssignment 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: - Assignment /assignment: get: summary: Bulk Get for Assignment operationId: getAssignments 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: ./Assignment.json - type: array items: $ref: ./Assignment.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: - Assignment put: summary: Bulk Edit for Assignment operationId: editAssignments 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: ./Assignment.json - type: array items: $ref: ./Assignment.json responses: '200': description: Great Success content: application/json: schema: type: object properties: data: anyOf: - $ref: ./Assignment.json - type: array items: $ref: ./Assignment.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: - Assignment post: summary: Create a assignment operationId: addAssignments 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: ./Assignment.json - type: array items: $ref: ./Assignment.json responses: '200': description: Great Success content: application/json: schema: type: object properties: data: anyOf: - $ref: ./Assignment.json - type: array items: $ref: ./Assignment.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: - Assignment delete: summary: Bulk Delete for Assignment operationId: deleteAssignments 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: - Assignment /assignment/count: get: summary: Count of assignment operationId: countAssignments 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: - Assignment /assignment/search: get: summary: Search of assignment operationId: searchAssignments 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: ./Assignment.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: - Assignment /assignment/report: get: summary: Report of assignment operationId: reportAssignments 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: - Assignment /assignment/assignUserToRoleOnProjects: summary: assignUserToRoleOnProjects put: operationId: assignmentAssignUserToRoleOnProjects parameters: - name: projectIDs in: query description: projectIDs required: false schema: type: array items: type: string - name: swapUserID in: query description: swapUserID required: false schema: type: string - name: swapRoleID in: query description: swapRoleID required: false schema: type: string - name: lockToRole in: query description: lockToRole required: false schema: type: boolean - name: includeIssues in: query description: includeIssues required: false schema: type: boolean 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: - Assignment /assignment/assignUserToRoleOnTasks: summary: assignUserToRoleOnTasks put: operationId: assignmentAssignUserToRoleOnTasks parameters: - name: taskIDs in: query description: taskIDs required: false schema: type: array items: type: string - name: swapUserID in: query description: swapUserID required: false schema: type: string - name: swapRoleID in: query description: swapRoleID required: false schema: type: string - name: lockToRole in: query description: lockToRole required: false schema: type: boolean - name: includeIssues in: query description: includeIssues required: false schema: type: boolean 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: - Assignment /assignment/swapUsersOnProjects: summary: swapUsersOnProjects put: operationId: assignmentSwapUsersOnProjects parameters: - name: projectIDs in: query description: projectIDs required: false schema: type: array items: type: string - name: swapToUserID in: query description: swapToUserID required: false schema: type: string - name: swapFromUserID in: query description: swapFromUserID required: false schema: type: string - name: swapRoleIDs in: query description: swapRoleIDs required: false schema: type: array items: type: string - name: lockToRole in: query description: lockToRole required: false schema: type: boolean - name: includeIssues in: query description: includeIssues required: false schema: type: boolean 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: - Assignment /assignment/swapUsersOnTasks: summary: swapUsersOnTasks put: operationId: assignmentSwapUsersOnTasks parameters: - name: taskIDs in: query description: taskIDs required: false schema: type: array items: type: string - name: swapToUserID in: query description: swapToUserID required: false schema: type: string - name: swapFromUserID in: query description: swapFromUserID required: false schema: type: string - name: swapRoleIDs in: query description: swapRoleIDs required: false schema: type: array items: type: string - name: lockToRole in: query description: lockToRole required: false schema: type: boolean - name: includeIssues in: query description: includeIssues required: false schema: type: boolean 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: - Assignment /assignment/unassignUserFromProjects: summary: unassignUserFromProjects put: operationId: assignmentUnassignUserFromProjects parameters: - name: projectIDs in: query description: projectIDs required: false schema: type: array items: type: string - name: unassignUserID in: query description: unassignUserID required: false schema: type: string - name: swapRoleIDs in: query description: swapRoleIDs required: false schema: type: array items: type: string - name: includeIssues in: query description: includeIssues required: false schema: type: boolean 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: - Assignment /assignment/unassignUserFromTasks: summary: unassignUserFromTasks put: operationId: assignmentUnassignUserFromTasks parameters: - name: taskIDs in: query description: taskIDs required: false schema: type: array items: type: string - name: unassignUserID in: query description: unassignUserID required: false schema: type: string - name: swapRoleIDs in: query description: swapRoleIDs required: false schema: type: array items: type: string - name: includeIssues in: query description: includeIssues required: false schema: type: boolean 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: - Assignment /assignment/getAssignAssignmentsForTasks: summary: getAssignAssignmentsForTasks get: operationId: getAssignmentGetAssignAssignmentsForTasks parameters: - name: taskIDs in: query description: taskIDs required: false schema: type: array items: type: string - name: includeIssues in: query description: includeIssues required: false schema: type: boolean responses: '200': description: Great Success content: application/json: schema: type: object properties: data: type: array items: $ref: ./Assignment.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: - Assignment /assignment/getUnassignAssignmentsForTasks: summary: getUnassignAssignmentsForTasks get: operationId: getAssignmentGetUnassignAssignmentsForTasks parameters: - name: taskIDs in: query description: taskIDs required: false schema: type: array items: type: string - name: includeIssues in: query description: includeIssues required: false schema: type: boolean responses: '200': description: Great Success content: application/json: schema: type: object properties: data: type: array items: $ref: ./Assignment.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: - Assignment 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