openapi: 3.2.0 info: title: Adobe Workfront Usernote 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: Usernote paths: /usernote/{id}: get: summary: Get for UserNote operationId: getUserNote 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: ./UserNote.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: - Usernote /usernote: get: summary: Bulk Get for UserNote operationId: getUserNotes 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: ./UserNote.json - type: array items: $ref: ./UserNote.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: - Usernote post: summary: Create a usernote operationId: addUserNotes 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: ./UserNote.json - type: array items: $ref: ./UserNote.json responses: '200': description: Great Success content: application/json: schema: type: object properties: data: anyOf: - $ref: ./UserNote.json - type: array items: $ref: ./UserNote.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: - Usernote /usernote/count: get: summary: Count of usernote operationId: countUserNotes 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: - Usernote /usernote/search: get: summary: Search of usernote operationId: searchUserNotes 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: ./UserNote.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: - Usernote /usernote/report: get: summary: Report of usernote operationId: reportUserNotes 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: - Usernote /usernote/acknowledge: summary: acknowledge put: operationId: userNoteAcknowledge parameters: - name: ID in: query description: Object ID required: false schema: type: string 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: - Usernote /usernote/acknowledgeAll: summary: acknowledgeAll put: operationId: userNoteAcknowledgeAll 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: - Usernote /usernote/acknowledgeMany: summary: acknowledgeMany put: operationId: userNoteAcknowledgeMany parameters: - name: objIDs in: query description: objIDs 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: - Usernote /usernote/acknowledgeMyNotifications: summary: acknowledgeMyNotifications put: operationId: userNoteAcknowledgeMyNotifications parameters: - name: objIDs in: query description: objIDs 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: - Usernote /usernote/unacknowledge: summary: unacknowledge put: operationId: userNoteUnacknowledge 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: - Usernote /usernote/unacknowledgeMany: summary: unacknowledgeMany put: operationId: userNoteUnacknowledgeMany parameters: - name: objIDs in: query description: objIDs 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: - Usernote /usernote/unacknowledgedAllObjectTypesCount: summary: unacknowledgedAllObjectTypesCount put: operationId: userNoteUnacknowledgedAllObjectTypesCount 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: - Usernote /usernote/unacknowledgedAnnouncementCount: summary: unacknowledgedAnnouncementCount put: operationId: userNoteUnacknowledgedAnnouncementCount 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: - Usernote /usernote/unacknowledgedCount: summary: unacknowledgedCount put: operationId: userNoteUnacknowledgedCount 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: - Usernote /usernote/announcementNotifications: summary: announcementNotifications get: operationId: getUserNoteAnnouncementNotifications parameters: - name: pageNumber in: query description: pageNumber required: false schema: type: integer format: int32 responses: '200': description: Great Success content: application/json: schema: type: object properties: data: type: array items: $ref: ./UserNote.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: - Usernote /usernote/deletedAnnouncementNotes: summary: deletedAnnouncementNotes get: operationId: getUserNoteDeletedAnnouncementNotes parameters: - name: limit in: query description: limit required: false schema: type: integer format: int32 responses: '200': description: Great Success content: application/json: schema: type: object properties: data: type: array items: $ref: ./UserNote.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: - Usernote /usernote/myAllObjectTypesUnreadNotifications: summary: myAllObjectTypesUnreadNotifications get: operationId: getUserNoteMyAllObjectTypesUnreadNotifications parameters: - name: limit in: query description: limit required: false schema: type: integer format: int32 - name: first in: query description: first required: false schema: type: integer format: int32 - name: includeAll in: query description: includeAll required: false schema: type: boolean responses: '200': description: Great Success content: application/json: schema: type: object properties: data: type: array items: $ref: ./UserNote.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: - Usernote /usernote/myNewestAnnouncementNotification: summary: myNewestAnnouncementNotification get: operationId: getUserNoteMyNewestAnnouncementNotification responses: '200': description: Great Success content: application/json: schema: type: object properties: data: $ref: ./UserNote.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: - Usernote /usernote/myNewestNotification: summary: myNewestNotification get: operationId: getUserNoteMyNewestNotification responses: '200': description: Great Success content: application/json: schema: type: object properties: data: $ref: ./UserNote.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: - Usernote /usernote/myNotifications: summary: myNotifications get: operationId: getUserNoteMyNotifications 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: ./UserNote.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: - Usernote /usernote/myNotificationsQuickList: summary: myNotificationsQuickList get: operationId: getUserNoteMyNotificationsQuickList responses: '200': description: Great Success content: application/json: schema: type: object properties: data: type: array items: $ref: ./UserNote.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: - Usernote /usernote/myUnreadAnnouncementNotifications: summary: myUnreadAnnouncementNotifications get: operationId: getUserNoteMyUnreadAnnouncementNotifications parameters: - name: limit in: query description: limit required: false schema: type: integer format: int32 responses: '200': description: Great Success content: application/json: schema: type: object properties: data: type: array items: $ref: ./UserNote.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: - Usernote /usernote/myUnreadNotifications: summary: myUnreadNotifications get: operationId: getUserNoteMyUnreadNotifications parameters: - name: limit in: query description: limit required: false schema: type: integer format: int32 responses: '200': description: Great Success content: application/json: schema: type: object properties: data: type: array items: $ref: ./UserNote.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: - Usernote 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