openapi: 3.2.0 info: title: Adobe Workfront Work 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: Work paths: /work/{id}: get: summary: Get for Work operationId: getWork 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: ./Work.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: - Work /work: get: summary: Bulk Get for Work operationId: getWorks 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: ./Work.json - type: array items: $ref: ./Work.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: - Work /work/count: get: summary: Count of work operationId: countWorks 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: - Work /work/search: get: summary: Search of work operationId: searchWorks 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: ./Work.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: - Work /work/report: get: summary: Report of work operationId: reportWorks 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: - Work /work/getMyAccomplishmentsCount: summary: getMyAccomplishmentsCount put: operationId: workGetMyAccomplishmentsCount responses: '200': description: Great Success content: application/json: schema: 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: - Work /work/getMyWorkCount: summary: getMyWorkCount put: operationId: workGetMyWorkCount responses: '200': description: Great Success content: application/json: schema: 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: - Work /work/getMyWorkCountFiltered: summary: getMyWorkCountFiltered put: operationId: workGetMyWorkCountFiltered parameters: - name: filters in: query description: filters required: false schema: type: object additionalProperties: type: string responses: '200': description: Great Success content: application/json: schema: 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: - Work /work/getWFHomeObjects: summary: getWFHomeObjects put: operationId: workGetWFHomeObjects parameters: - name: show in: query description: show required: false schema: type: string - name: view in: query description: view required: false schema: type: string - name: search in: query description: search required: false schema: type: string - name: first in: query description: first required: false schema: type: string - name: limit in: query description: limit required: false schema: type: string - name: startDate in: query description: startDate required: false schema: type: string format: date-time - name: endDate in: query description: endDate required: false schema: type: string format: date-time - name: actionGroup in: query description: actionGroup 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: - Work /work/getWFHomeObjectsFilterSortBy: summary: getWFHomeObjectsFilterSortBy put: operationId: workGetWFHomeObjectsFilterSortBy parameters: - name: filter in: query description: filter required: false schema: type: string - name: sortBy in: query description: sortBy required: false schema: type: string - name: search in: query description: search required: false schema: type: string - name: first in: query description: first required: false schema: type: string - name: limit in: query description: limit required: false schema: type: string - name: isAscending in: query description: isAscending required: false schema: type: string - name: includeUndated in: query description: includeUndated required: false schema: type: string - name: startDate in: query description: startDate required: false schema: type: string format: date-time - name: endDate in: query description: endDate required: false schema: type: string format: date-time 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: - Work /work/getWFHomeObjectsListWithoutDate: summary: getWFHomeObjectsListWithoutDate put: operationId: workGetWFHomeObjectsListWithoutDate parameters: - name: filter in: query description: filter required: false schema: type: string - name: sortBy in: query description: sortBy required: false schema: type: string - name: first in: query description: first required: false schema: type: string - name: limit in: query description: limit required: false schema: type: string - name: isAscending in: query description: isAscending 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: - Work /work/getWFHomeObjectsProjectItemList: summary: getWFHomeObjectsProjectItemList put: operationId: workGetWFHomeObjectsProjectItemList parameters: - name: filter in: query description: filter required: false schema: type: string - name: projectID in: query description: projectID required: false schema: type: string - name: search in: query description: search required: false schema: type: string - name: first in: query description: first required: false schema: type: string - name: limit in: query description: limit required: false schema: type: string - name: isAscending in: query description: isAscending required: false schema: type: string - name: includeUndated in: query description: includeUndated required: false schema: type: string - name: startDate in: query description: startDate required: false schema: type: string format: date-time - name: endDate in: query description: endDate required: false schema: type: string format: date-time 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: - Work /work/getWFHomeObjectsProjectList: summary: getWFHomeObjectsProjectList put: operationId: workGetWFHomeObjectsProjectList parameters: - name: filter in: query description: filter required: false schema: type: string - name: isAscending in: query description: isAscending required: false schema: type: string - name: includeUndated in: query description: includeUndated required: false schema: type: string - name: search in: query description: search required: false schema: type: string - name: startDate in: query description: startDate required: false schema: type: string format: date-time - name: endDate in: query description: endDate required: false schema: type: string format: date-time 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: - Work /work/getWorkRequestsCount: summary: getWorkRequestsCount put: operationId: workGetWorkRequestsCount parameters: - name: filters in: query description: filters required: false schema: type: object additionalProperties: type: string responses: '200': description: Great Success content: application/json: schema: 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: - Work /work/teamRequestCount: summary: teamRequestCount put: operationId: workTeamRequestCount parameters: - name: filters in: query description: filters required: false schema: type: object additionalProperties: type: string responses: '200': description: Great Success content: application/json: schema: 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: - Work /work/teamRequestsCount: summary: teamRequestsCount put: operationId: workTeamRequestsCount 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: - Work /work/workItemStatusLabels: summary: workItemStatusLabels put: operationId: workWorkItemStatusLabels parameters: - name: items in: query description: items required: false schema: type: object additionalProperties: 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: - Work /work/myAccomplishments: summary: myAccomplishments get: operationId: getWorkMyAccomplishments 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: array items: $ref: ./Work.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: - Work /work/myAwaitingFeedbackRequests: summary: myAwaitingFeedbackRequests get: operationId: getWorkMyAwaitingFeedbackRequests 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: array items: $ref: ./Work.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: - Work /work/myCompletedRequests: summary: myCompletedRequests get: operationId: getWorkMyCompletedRequests 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: array items: $ref: ./Work.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: - Work /work/myOpenRequests: summary: myOpenRequests get: operationId: getWorkMyOpenRequests 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: array items: $ref: ./Work.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: - Work /work/myWork: summary: myWork get: operationId: getWorkMyWork 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: array items: $ref: ./Work.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: - Work /work/teamRequests: summary: teamRequests get: operationId: getWorkTeamRequests 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: array items: $ref: ./Work.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: - Work /work/workRequests: summary: workRequests get: operationId: getWorkWorkRequests 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: array items: $ref: ./Work.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: - Work components: responses: 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