openapi: 3.2.0 info: title: Adobe Workfront Task 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: Task paths: /task/{id}: get: summary: Get for Task operationId: getTask 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: ./Task.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: - Task put: summary: Edit a Task operationId: editTask 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: ./Task.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: - Task delete: summary: Delete for Task operationId: deleteTask 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: - Task /task: get: summary: Bulk Get for Task operationId: getTasks 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: ./Task.json - type: array items: $ref: ./Task.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: - Task put: summary: Bulk Edit for Task operationId: editTasks 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: ./Task.json - type: array items: $ref: ./Task.json responses: '200': description: Great Success content: application/json: schema: type: object properties: data: anyOf: - $ref: ./Task.json - type: array items: $ref: ./Task.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: - Task post: summary: Create or copy a task operationId: addTasks 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: ./Task.json - type: array items: $ref: ./Task.json responses: '200': description: Great Success content: application/json: schema: type: object properties: data: anyOf: - $ref: ./Task.json - type: array items: $ref: ./Task.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: - Task delete: summary: Bulk Delete for Task operationId: deleteTasks 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: - Task /task/count: get: summary: Count of task operationId: countTasks 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: - Task /task/search: get: summary: Search of task operationId: searchTasks 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: ./Task.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: - Task /task/report: get: summary: Report of task operationId: reportTasks 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: - Task /task/{id}/share: put: summary: Sharing of a Task operationId: shareTask 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 - LIMITED_EDIT - EDIT - DELETE - name: forbiddenActions in: query schema: type: array items: type: string enum: - CHANGE_STATUS - EDIT_CUSTOMDATA - EDIT_APPROVALPROCESS - ADD_TASKS - ADD_ISSUES - EDIT_ASSIGNMENTS - ADD_DOCUMENTS - EDIT_FINANCE - VIEW_FINANCE - ADD_HOURS - ADD_EXPENSES - SHARE - SHARE_SYSTEMWIDE - ADD_BOOKINGS 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: - Task /task/share: put: summary: Batch sharing of a Task operationId: batchShareTask 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 - LIMITED_EDIT - EDIT - DELETE - name: forbiddenActions in: query schema: type: array items: type: string enum: - CHANGE_STATUS - EDIT_CUSTOMDATA - EDIT_APPROVALPROCESS - ADD_TASKS - ADD_ISSUES - EDIT_ASSIGNMENTS - ADD_DOCUMENTS - EDIT_FINANCE - VIEW_FINANCE - ADD_HOURS - ADD_EXPENSES - SHARE - SHARE_SYSTEMWIDE - ADD_BOOKINGS 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: - Task /task/{id}/unshare: put: summary: Un-sharing of a Task operationId: unshareTask 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: - Task /task/unshare: put: summary: Batch un-sharing of a Task operationId: batchUnshareTask 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: - Task /task/{id}/sharePublic: put: summary: Public share of a Task operationId: sharePublicTask parameters: - name: id in: path description: Object ID required: true schema: type: string - name: coreAction in: query required: true schema: type: string enum: - VIEW - LIMITED_EDIT - EDIT - DELETE - name: forbiddenActions in: query schema: type: array items: type: string enum: - CHANGE_STATUS - EDIT_CUSTOMDATA - EDIT_APPROVALPROCESS - ADD_TASKS - ADD_ISSUES - EDIT_ASSIGNMENTS - ADD_DOCUMENTS - EDIT_FINANCE - VIEW_FINANCE - ADD_HOURS - ADD_EXPENSES - SHARE - SHARE_SYSTEMWIDE - ADD_BOOKINGS 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: - Task /task/sharePublic: put: summary: Batch public share of a Task operationId: batchSharePublicTask 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 - LIMITED_EDIT - EDIT - DELETE - name: forbiddenActions in: query schema: type: array items: type: string enum: - CHANGE_STATUS - EDIT_CUSTOMDATA - EDIT_APPROVALPROCESS - ADD_TASKS - ADD_ISSUES - EDIT_ASSIGNMENTS - ADD_DOCUMENTS - EDIT_FINANCE - VIEW_FINANCE - ADD_HOURS - ADD_EXPENSES - SHARE - SHARE_SYSTEMWIDE - ADD_BOOKINGS 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: - Task /task/{id}/unsharePublic: put: summary: Public un-share of a Task operationId: unsharePublicTask 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: - Task /task/unsharePublic: put: summary: Batch public un-share of a Task operationId: batchUnsharePublicTask 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: - Task /task/acceptWork: summary: acceptWork put: operationId: taskAcceptWork parameters: - name: ID in: query description: Object ID required: false schema: type: string - name: status in: query description: status 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: - Task /task/approveApproval: summary: approveApproval put: operationId: taskApproveApproval parameters: - name: ID in: query description: Object ID required: false schema: type: string - name: userID in: query description: userID required: false schema: type: string - name: username in: query description: username required: false schema: type: string - name: password in: query description: password required: false schema: type: string - name: auditNote in: query description: auditNote required: false schema: type: string - name: auditUserIDs in: query description: auditUserIDs required: false schema: type: array items: type: string - name: sendNoteAsEmail in: query description: sendNoteAsEmail 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: - Task /task/assign: summary: assign put: operationId: taskAssign parameters: - name: ID in: query description: Object ID required: false schema: type: string - name: objID in: query description: objID required: false schema: type: string - name: objCode in: query description: objCode 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: - Task /task/assignMultiple: summary: assignMultiple put: operationId: taskAssignMultiple 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: teamIDs in: query description: teamIDs 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: - Task /task/bulkCopy: summary: bulkCopy put: operationId: taskBulkCopy parameters: - name: taskIDs in: query description: taskIDs required: false schema: type: array items: type: string - name: projectID in: query description: projectID required: false schema: type: string - name: parentID in: query description: parentID required: false schema: type: string - name: options in: query description: options required: false schema: type: array items: 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: - Task /task/bulkMove: summary: bulkMove put: operationId: taskBulkMove parameters: - name: taskIDs in: query description: taskIDs required: false schema: type: array items: type: string - name: projectID in: query description: projectID required: false schema: type: string - name: parentID in: query description: parentID required: false schema: type: string - name: options in: query description: options 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: - Task /task/calculateDataExtension: summary: calculateDataExtension put: operationId: taskCalculateDataExtension 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: - Task /task/calculateDataExtensions: summary: calculateDataExtensions put: operationId: taskCalculateDataExtensions 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: - Task /task/convertToProject: summary: convertToProject put: operationId: taskConvertToProject parameters: - name: ID in: query description: Object ID required: false schema: type: string - name: project in: query description: project required: false schema: $ref: ./Project.json - name: exchangeRate in: query description: exchangeRate required: false schema: $ref: ./ExchangeRate.json - name: copyCategories in: query description: copyCategories required: false schema: type: boolean responses: '200': description: Great Success content: application/json: schema: type: string '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: - Task /task/linkExternalObject: summary: linkExternalObject put: operationId: taskLinkExternalObject 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: - Task /task/markDone: summary: markDone put: operationId: taskMarkDone parameters: - name: ID in: query description: Object ID required: false schema: type: string - name: status in: query description: status 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: - Task /task/markNotDone: summary: markNotDone put: operationId: taskMarkNotDone parameters: - name: ID in: query description: Object ID required: false schema: type: string - name: assignmentID in: query description: assignmentID 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: - Task /task/move: summary: move put: operationId: taskMove parameters: - name: ID in: query description: Object ID required: false schema: type: string - name: projectID in: query description: projectID required: false schema: type: string - name: parentID in: query description: parentID required: false schema: type: string - name: options in: query description: options 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: - Task /task/recallApproval: summary: recallApproval put: operationId: taskRecallApproval 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: - Task /task/rejectApproval: summary: rejectApproval put: operationId: taskRejectApproval parameters: - name: ID in: query description: Object ID required: false schema: type: string - name: userID in: query description: userID required: false schema: type: string - name: username in: query description: username required: false schema: type: string - name: password in: query description: password required: false schema: type: string - name: auditNote in: query description: auditNote required: false schema: type: string - name: auditUserIDs in: query description: auditUserIDs required: false schema: type: array items: type: string - name: sendNoteAsEmail in: query description: sendNoteAsEmail 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: - Task /task/replyToAssignment: summary: replyToAssignment put: operationId: taskReplyToAssignment parameters: - name: ID in: query description: Object ID required: false schema: type: string - name: noteText in: query description: noteText required: false schema: type: string - name: commitDate in: query description: commitDate required: false schema: type: string format: date-time 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: - Task /task/unacceptWork: summary: unacceptWork put: operationId: taskUnacceptWork parameters: - name: ID in: query description: Object ID required: false schema: type: string - name: status in: query description: status 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: - Task /task/unassign: summary: unassign put: operationId: taskUnassign parameters: - name: ID in: query description: Object ID required: false schema: type: string - name: userID in: query description: userID 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: - Task /task/unassignOccurrences: summary: unassignOccurrences put: operationId: taskUnassignOccurrences parameters: - name: ID in: query description: Object ID required: false schema: type: string - name: userID in: query description: userID 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: - Task /task/unlinkExternalObject: summary: unlinkExternalObject put: operationId: taskUnlinkExternalObject 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: - Task /task/allTasksOnIterations: summary: allTasksOnIterations get: operationId: getTaskAllTasksOnIterations parameters: - name: iterationIDs in: query description: iterationIDs required: false schema: type: array items: type: string responses: '200': description: Great Success content: application/json: schema: type: object properties: data: type: array items: $ref: ./Task.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: - Task /task/defaultShownTimesheetTasks: summary: defaultShownTimesheetTasks get: operationId: getTaskDefaultShownTimesheetTasks parameters: - name: timesheetID in: query description: timesheetID required: false schema: type: string responses: '200': description: Great Success content: application/json: schema: type: object properties: data: type: array items: $ref: ./Task.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: - Task 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