The Performance Management service enables applications to access and create feedback about workers in the system.
- Installation
- Getting Started
- Reference
workdayperformanceenablement.promptValues.getInstancesworkdayperformanceenablement.promptValues.getInstances_0workdayperformanceenablement.promptValues.getInstances_1workdayperformanceenablement.promptValues.getInstances_2workdayperformanceenablement.promptValues.getInstances_3workdayperformanceenablement.feedbackBadges.getByIdworkdayperformanceenablement.feedbackBadges.getCollectionworkdayperformanceenablement.giveRequestedFeedbackEvents.getCollectionFeedbackEventsworkdayperformanceenablement.giveRequestedFeedbackEvents.getInstanceworkdayperformanceenablement.giveRequestedFeedbackEvents.updateEventworkdayperformanceenablement.workers.createFeedbackEventworkdayperformanceenablement.workers.getCollectionStaffingworkdayperformanceenablement.workers.getFeedbackEventworkdayperformanceenablement.workers.getFeedbackEventsworkdayperformanceenablement.workers.getGoalsworkdayperformanceenablement.workers.getRequestedEventworkdayperformanceenablement.workers.getRequestedFeedbackEventsworkdayperformanceenablement.workers.getSelfRequestedFeedbackworkdayperformanceenablement.workers.getSelfRequestedFeedbackEventworkdayperformanceenablement.workers.getSingleGoalworkdayperformanceenablement.workers.getStaffingInformationworkdayperformanceenablement.workers.requestFeedbackOnSelfEventsworkdayperformanceenablement.workers.requestFeedbackOnWorkerEvents
import { WorkdayPerformanceEnablement } from "workday-performance-enablement-typescript-sdk";
const workdayperformanceenablement = new WorkdayPerformanceEnablement({
// Defining the base path is optional and defaults to https://<tenantHostname>/performanceEnablement/v5
// basePath: "https://<tenantHostname>/performanceEnablement/v5",
accessToken: "ACCESS_TOKEN",
});
const getInstancesResponse =
await workdayperformanceenablement.promptValues.getInstances({});
console.log(getInstancesResponse);Retrieves instances that can be used as values for other endpoint parameters in this service.
const getInstancesResponse =
await workdayperformanceenablement.promptValues.getInstances({});The maximum number of objects in a single response. The default and maximum is 1000.
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
MULTIPLEINSTANCEMODELREFERENCE
/values/workersToNotify/workersToNotify GET
Retrieves instances that can be used as values for other endpoint parameters in this service.
const getInstances_0Response =
await workdayperformanceenablement.promptValues.getInstances_0({});The maximum number of objects in a single response. The default and maximum is 1000.
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
The feedback template type for this feedback event, either Feedback on Self, 133de7d11fea10001dbb45a701140098 or Feedback on Worker 133de7d11fea10001dbb45973dec0097. This field is required.
The worker WID. This field is required for the Feedback on Worker template and not supported for the Feedback on Self template. It can't be the processing worker.
MULTIPLEINSTANCEMODELREFERENCE
/values/feedbackTemplate/feedbackTemplate GET
Retrieves instances that can be used as values for other endpoint parameters in this service.
const getInstances_1Response =
await workdayperformanceenablement.promptValues.getInstances_1({});The maximum number of objects in a single response. The default and maximum is 1000.
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
MULTIPLEINSTANCEMODELREFERENCE
/values/feedbackOnWorker/feedbackOnWorker GET
Retrieves instances that can be used as values for other endpoint parameters in this service.
const getInstances_2Response =
await workdayperformanceenablement.promptValues.getInstances_2({});The maximum number of objects in a single response. The default and maximum is 1000.
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
The feedback template type for this feedback event, either Feedback on Self, 133de7d11fea10001dbb45a701140098 or Feedback on Worker 133de7d11fea10001dbb45973dec0097. This field is required.
The worker WID. This field is required for the Feedback on Worker templateType and not supported for the Feedback on Self templateType. It can't be the processing worker.
MULTIPLEINSTANCEMODELREFERENCE
/values/feedbackResponder/feedbackResponder GET
Retrieves instances that can be used as values for other endpoint parameters in this service.
const getInstances_3Response =
await workdayperformanceenablement.promptValues.getInstances_3({});The maximum number of objects in a single response. The default and maximum is 1000.
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
The talent tag linked to the feedback question.
MULTIPLEINSTANCEMODELREFERENCE
/values/relatesTo/relatesTo GET
Retrieves a single Feedback Badge instance
Secured by: Give Feedback
Scope: Performance Enablement, Worker Profile and Skills
const getByIdResponse =
await workdayperformanceenablement.feedbackBadges.getById({
iD: "iD_example",
});The Workday ID of the resource.
FeedbackBadgeDetail9eab868ca81410001402525d054211f7
/feedbackBadges/{ID} GET
Retrieves all active Feedback Badges.
Secured by: Give Feedback
Scope: Performance Enablement, Worker Profile and Skills
const getCollectionResponse =
await workdayperformanceenablement.feedbackBadges.getCollection({});The maximum number of objects in a single response. The default is 20. The maximum is 100.
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
FeedbackBadgesGetCollectionResponse
/feedbackBadges GET
Retrieves all requested feedback given events for the user that responded to the feedback request.
Secured by: Self-Service: Role Requested Feedback, Self-Service: Self Requested Feedback
Scope: Performance Enablement, Worker Profile and Skills
const getCollectionFeedbackEventsResponse =
await workdayperformanceenablement.giveRequestedFeedbackEvents.getCollectionFeedbackEvents(
{}
);The maximum number of objects in a single response. The default is 20. The maximum is 100.
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
GiveRequestedFeedbackEventsGetCollectionFeedbackEventsResponse
/giveRequestedFeedbackEvents GET
Retrieves a single requested feedback given event instance for the user that responded to the feedback request.
Secured by: Self-Service: Role Requested Feedback, Self-Service: Self Requested Feedback
Scope: Performance Enablement, Worker Profile and Skills
const getInstanceResponse =
await workdayperformanceenablement.giveRequestedFeedbackEvents.getInstance({
iD: "iD_example",
});The Workday ID of the resource.
GiveRequestedFeedbackDetailsD396fd5bffec10000e3eba1a70440000
/giveRequestedFeedbackEvents/{ID} GET
Updates the Give Requested Feedback Event that matches the WID in the url, and the current authenticated user is a responder for the event. This endpoint is equivalent to the Give Requested Feedback task in Workday.
Secured by: Give Requested Feedback REST+TG
Scope: Performance Enablement, Worker Profile and Skills
const updateEventResponse =
await workdayperformanceenablement.giveRequestedFeedbackEvents.updateEvent({
iD: "iD_example",
dueDate: "2024-03-23T07:00:00.000Z",
feedbackGivenDate: "2024-03-23T07:00:00.000Z",
feedbackCreationDate: "2024-03-23T07:00:00.000Z",
expirationDate: "2024-03-23T07:00:00.000Z",
displayNameofResponder: true,
feedbackPrivate: true,
feedbackConfidential: true,
descriptor: "Lorem ipsum dolor sit ame",
});The Workday ID of the resource.
The date the business process needs to be completed.
The date the feedback was provided.
The date the feedback event was created.
requestedBy: RequestedByD396fd5bffec1000100f44a5808f0006
aboutWorker: AboutWorkerD396fd5bffec1000100f44a5808f0005
The date the feedback request expires.
True if the feedback provider\'s name is not displayed.
feedbackComments: RequestedFeedbackCommentsD396fd5bffec10001393477e77870000[]
The feedback comments for this feedback event. To include feedback comments in reports or notifications intended for Employees, use Feedback Comments for Self-Service Reporting instead.
businessProcessParameters: BusinessProcessParametersD396fd5bffec1000100f440bde4c0001
Yes if the feedback is private between the feedback provider and the worker.
Yes if the feedback is confidential between the feedback provider and the manager. Employees, or who the feedback is about, don\'t see confidential feedback.
Id of the instance
A preview of the instance
GiveRequestedFeedbackDetailsD396fd5bffec10000e3eba1a70440000
/giveRequestedFeedbackEvents/{ID} PATCH
Creates a single instance of feedback for each of the specified workers with the provided data. The worker is specified by the Workday ID of the worker. You can use a returned id from GET /workers in the Staffing service /staffing.
If you want to see the status of conditionally hidden attributes for this request, call this method with the wd-metadata-api-version header. Set the header value to v1 (or the latest Workday Metadata API version). When you specify the wd-metadata-api-version header, this method returns the response metadata, instead of the actual data.
This endpoint is equivalent to the Give Feedback task in Workday. This endpoint initiates the Give Feedback business process or the Give Feedback to Multiple Recipients business process based on the request.
Secured by: Give Feedback
Scope: Performance Enablement, Worker Profile and Skills
const createFeedbackEventResponse =
await workdayperformanceenablement.workers.createFeedbackEvent({
iD: "iD_example",
hiddenFromWorker: true,
hiddenFromManager: true,
comment:
"Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
feedbackGivenDate: "2024-03-23T07:00:00.000Z",
showFeedbackProviderName: true,
descriptor: "Lorem ipsum dolor sit ame",
});The Workday ID of the resource.
toWorker: ToWorkerF4946919a39f10000f03207b1f230000
workersToNotify: WorkersToNotify9e478586f65410001035b6c26a4c0000[]
The workers that were selected to be notified of the feedback given event.
relatesTo: RelatesTo9d12ad407f0f10001c3949add7d40000
businessProcessParameters: BusinessProcessParametersAfd6ac52d6251000117d0a60ed8b0000
feedbackAlsoAbout: GetWorkersFeedbackAlsoAbout3ab333661034100010b5635b2f7a0302[]
The other workers this feedback event is about.
hiddenFromWorker: boolean
True if the feedback event is confidential between the feedback provider and the manager. Workers don\'t see confidential feedback.
hiddenFromManager: boolean
True if the feedback event is private between the feedback provider and the worker. Private feedback isn\'t shared with managers.
The comment text for an anytime feedback event.
fromWorker: FromWorkerAfd6ac52d62510001357f891ccfd0001
relatedFeedbackEvents: RelatedFeedbackEvents9708c966f04f10000e1e9b7f9a5c0000[]
The anytime feedback events for the multiple recipients event.
The date the feedback was provided.
True if the feedback provider\'s name has chosen to be displayed. Names not chosen to be displayed are not shared.
A link to the instance
Id of the instance
A preview of the instance
FeedbackEventDetailAfd6ac52d62510001086b5c85cd50000
/workers/{ID}/anytimeFeedbackEvents POST
Retrieves a collection of workers and current staffing information.
Secured by: Self-Service: Current Staffing Information, Worker Data: Public Worker Reports
Scope: Staffing
const getCollectionStaffingResponse =
await workdayperformanceenablement.workers.getCollectionStaffing({});Include terminated workers in the output
The maximum number of objects in a single response. The default is 20. The maximum is 100.
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search.
WorkersGetCollectionStaffingResponse
/workers GET
Retrieves a single feedback given event instance with the specified ID.
This endpoint is equivalent to the View Feedback task in Workday.
Secured by: Self-Service: Anytime Feedback, Worker Data: Anytime Feedback
Scope: Performance Enablement, Worker Profile and Skills
const getFeedbackEventResponse =
await workdayperformanceenablement.workers.getFeedbackEvent({
iD: "iD_example",
subresourceID: "subresourceID_example",
});The Workday ID of the resource.
The Workday ID of the subresource.
FeedbackEventDetailAfd6ac52d62510001086b5c85cd50000
/workers/{ID}/anytimeFeedbackEvents/{subresourceID} GET
Retrieves all feedback given events about the specified worker. Could also return a feedback multiple recipient event.
This endpoint is equivalent to the View Feedback task in Workday.
Secured by: Self-Service: Anytime Feedback, Worker Data: Anytime Feedback
Scope: Performance Enablement, Worker Profile and Skills
const getFeedbackEventsResponse =
await workdayperformanceenablement.workers.getFeedbackEvents({
iD: "iD_example",
});The Workday ID of the resource.
The maximum number of objects in a single response. The default is 20. The maximum is 100.
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
WorkersGetFeedbackEventsResponse
/workers/{ID}/anytimeFeedbackEvents GET
Retrieves all goals for a worker with the specified ID. You can use a returned id from GET /workers in the Staffing service. The goal data includes name, description, category, tags, associated reviews, due date, completed date, status, creator, worker it is for, supporting organization goal, locked reason, and activity streamable item.
Secured by: Self-Service: Employee Goals, Worker Data: Employee Goals
Scope: Performance Enablement
const getGoalsResponse = await workdayperformanceenablement.workers.getGoals({
iD: "iD_example",
});The Workday ID of the resource.
The maximum number of objects in a single response. The default is 20. The maximum is 100.
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
/workers/{ID}/goals GET
Retrieves a single requested feedback event instance for the specified worker. This endpoint is equivalent to the View Feedback and View Feedback by Request tasks in Workday.
Secured by: Self-Service: Role Requested Feedback, Worker Data: Role Requested Feedback
Scope: Performance Enablement, Worker Profile and Skills
const getRequestedEventResponse =
await workdayperformanceenablement.workers.getRequestedEvent({
iD: "iD_example",
subresourceID: "subresourceID_example",
});The Workday ID of the resource.
The Workday ID of the subresource.
RequestedFeedbackOnWorkerEventDetail2b4c8a6ca069100035b8586e16c20000
/workers/{ID}/requestedFeedbackOnWorkerEvents/{subresourceID} GET
Retrieves all requested feedback events for the specified worker. This endpoint is equivalent to the View Feedback task in Workday.
Secured by: Self-Service: Role Requested Feedback, Worker Data: Role Requested Feedback
Scope: Performance Enablement, Worker Profile and Skills
const getRequestedFeedbackEventsResponse =
await workdayperformanceenablement.workers.getRequestedFeedbackEvents({
iD: "iD_example",
});The Workday ID of the resource.
The maximum number of objects in a single response. The default is 20. The maximum is 100.
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
WorkersGetRequestedFeedbackEventsResponse
/workers/{ID}/requestedFeedbackOnWorkerEvents GET
Retrieves all self-requested feedback events for the specified worker. This endpoint is equivalent to the View Feedback task in Workday.
Secured by: Self-Service: Self Requested Feedback, Worker Data: Self Requested Feedback
Scope: Performance Enablement, Worker Profile and Skills
const getSelfRequestedFeedbackResponse =
await workdayperformanceenablement.workers.getSelfRequestedFeedback({
iD: "iD_example",
});The Workday ID of the resource.
The maximum number of objects in a single response. The default is 20. The maximum is 100.
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
WorkersGetSelfRequestedFeedbackResponse
/workers/{ID}/requestedFeedbackOnSelfEvents GET
Retrieves a single self-requested feedback event instance for the specified worker. This endpoint is equivalent to the View Feedback and View Feedback by Request tasks in Workday.
Secured by: Self-Service: Self Requested Feedback, Worker Data: Self Requested Feedback
Scope: Performance Enablement, Worker Profile and Skills
const getSelfRequestedFeedbackEventResponse =
await workdayperformanceenablement.workers.getSelfRequestedFeedbackEvent({
iD: "iD_example",
subresourceID: "subresourceID_example",
});The Workday ID of the resource.
The Workday ID of the subresource.
RequestedFeedbackOnSelfEventDetail19acce0101b310002e6bf03e1bbc0000
/workers/{ID}/requestedFeedbackOnSelfEvents/{subresourceID} GET
Retrieves a single goal instance for a worker with the specified ID. The goal data includes name, description, category, tags, associated reviews, due date, completed date, status, creator, worker it is for, supporting organization goal, locked reason, and activity streamable item.
Secured by: Self-Service: Employee Goals, Worker Data: Employee Goals
Scope: Performance Enablement
const getSingleGoalResponse =
await workdayperformanceenablement.workers.getSingleGoal({
iD: "iD_example",
subresourceID: "subresourceID_example",
});The Workday ID of the resource.
The Workday ID of the subresource.
GoalsSummary2c793e888bcd100033e663075a2b0000
/workers/{ID}/goals/{subresourceID} GET
Retrieves a collection of workers and current staffing information.
Secured by: Self-Service: Current Staffing Information, Worker Data: Public Worker Reports
Scope: Staffing
const getStaffingInformationResponse =
await workdayperformanceenablement.workers.getStaffingInformation({
iD: "iD_example",
});The Workday ID of the resource.
WorkerDataC2466b0778c610000d1936006720000e
/workers/{ID} GET
Secured by: Get Feedback on Self REST+TG
Scope: Performance Enablement, Worker Profile and Skills
const requestFeedbackOnSelfEventsResponse =
await workdayperformanceenablement.workers.requestFeedbackOnSelfEvents({
iD: "iD_example",
expirationDate: "2024-03-23T07:00:00.000Z",
requestDate: "2024-03-23T07:00:00.000Z",
feedbackOverallStatus:
"Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
feedbackPrivate: true,
feedbackResponders: [
{
descriptor: "Lorem ipsum dolor sit ame",
},
],
showFeedbackProviderName: true,
descriptor: "Lorem ipsum dolor sit ame",
});The Workday ID of the resource.
businessProcessParameters: BusinessProcessParameters4db9c44d36231000134c7a5b6f3b0000
feedbackQuestions: RequestedFeedbackQuestionFfdd5de32f7f1000144df0c21e640000[]
Feedback questions used in requested feedback events.
feedbackAbout: FeedbackAbout4db9c44d36231000134c7b8eb3800003
feedbackTemplate: FeedbackTemplate4db9c44d36231000134c7b8eb3800000
The date the feedback request expires.
The date the feedback request was initiated.
Overall status of the requested feedback process.
Private feedback between the feedback provider and the worker. Private feedback isn\'t shared with managers.
feedbackResponders: FeedbackRespondersFfdd5de32f7f100016dbb1b188d70000[]
The respondents who\'ve been requested to provide feedback.
Whether to display the name of the responders or have them remain anonymous.
A preview of the instance
Id of the instance
RequestedFeedbackOnSelfEventDetail19acce0101b310002e6bf03e1bbc0000
/workers/{ID}/requestedFeedbackOnSelfEvents POST
Not applicable.
Secured by: Get Feedback on ~Worker~ REST+TG
Scope: Performance Enablement, Worker Profile and Skills
const requestFeedbackOnWorkerEventsResponse =
await workdayperformanceenablement.workers.requestFeedbackOnWorkerEvents({
iD: "iD_example",
feedbackConfidential: true,
feedbackOverallStatus:
"Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
showFeedbackProviderName: true,
requestDate: "2024-03-23T07:00:00.000Z",
expirationDate: "2024-03-23T07:00:00.000Z",
feedbackResponders: [
{
descriptor: "Lorem ipsum dolor sit ame",
},
],
descriptor: "Lorem ipsum dolor sit ame",
});The Workday ID of the resource.
feedbackAbout: FeedbackAbout2b4c8a6ca069100035b85907ae2c0002
Yes if the feedback is confidential between the feedback provider and the manager. Workers don\'t see confidential feedback.
Overall status of the requested feedback process.
Whether to display the name of the responders or have them remain anonymous.ccc
The date the feedback request was initiated.
The date the feedback request expires.
feedbackQuestions: RequestedFeedbackQuestionFfdd5de32f7f1000144df0c21e640000[]
Feedback questions used in requested feedback events.
feedbackTemplate: FeedbackTemplate2b4c8a6ca069100035b859a141200001
feedbackResponders: FeedbackRespondersFfdd5de32f7f100016dbb1b188d70000[]
The respondents who\'ve been requested to provide feedback.
businessProcessParameters: BusinessProcessParameters2b4c8a6ca069100035b85907ae2c0000
A preview of the instance
Id of the instance
RequestedFeedbackOnWorkerEventDetail2b4c8a6ca069100035b8586e16c20000
/workers/{ID}/requestedFeedbackOnWorkerEvents POST
This TypeScript package is automatically generated by Konfig