staffing

Workday staffing and workforce management API

community.workday.com/api ↗

Version

OpenAPI

3.0.0

Endpoints

144

Schemas

214

93

Quality

Updated

3 days ago

Hr hr workforce enterprise

Use this API in your AI agent

Query structured spec data via REST or MCP. Get exactly what your agent needs.

Get API Key

Server URLs

https://<tenantHostname>/staffing/v6

Endpoints

Clear filters

GET POST PUT PATCH DELETE

Jobchanges 1 endpoints

POST /jobChanges/{ID}/submit Submit the specified change job ID.

Submits the specified change job ID.

To submit the Change Job event and initiate the Change Job business process, specify an empty request body: {}.
To save for later, specify this request body:
{
“businessProcessParameters”: {
“action”:{
“id”: “d9e41a8c446c11de98360015c5e6daf6”
}
}
}

The action id value is the Workday ID of the “Save for Later” action. If you submit this endpoint with the Save for Later action, you can no longer edit nor resubmit the Change Job event using the REST APIs. The user with correct permissions can edit and submit the saved Change Job event in the Workday UI.

Secured by: Change Job (Mass Action), Change Job (REST Service)

Scope: Staffing

operationId: JobChanges_submitChangeJob

Parameters

Name	In	Required	Type	Description
ID	path	required	string	The Workday ID of the resource.

Request Body

required

application/json

schema eventState_54e611eca2c910000fbc4579181c0111

Property	Type	Required
id	string	optional
status	object	optional
└ id	string	required
└ href	string	optional
└ descriptor	string	optional
descriptor	string	optional
validation	string	optional
businessProcessParameters	object	optional
└ for	object	optional
└ id	string	required
└ href	string	optional
└ descriptor	string	optional
└ action	object	required
└ id	string	required
└ href	string	optional
└ descriptor	string	optional
└ comment	string	optional
└ comments	array	optional
└ person	object	optional
└ id	string	required
└ href	string	optional
└ descriptor	string	optional
└ comment	string	optional
└ commentDate	string	optional
└ attachments	array	optional
└ id	string	optional
└ category	object	optional
└ id	string	required
└ href	string	optional
└ descriptor	string	optional
└ fileName	string	optional
└ fileLength	integer	optional
└ uploadDate	string	optional
└ uploadedBy	object	optional
└ id	string	required
└ href	string	optional
└ descriptor	string	optional
└ contentType	object	optional
└ id	string	required
└ href	string	optional
└ descriptor	string	optional
└ description	string	optional
└ overallStatus	string	optional
└ transactionStatus	object	optional
└ id	string	required
└ href	string	optional
└ descriptor	string	optional
└ warningValidations	string	optional
└ criticalValidations	string	optional
└ overallBusinessProcess	object	optional
└ id	string	required
└ href	string	optional
└ descriptor	string	optional

Responses

default

An error occurred.

201

Resource created.

400

Invalid request. (https://community.workday.com/rest/error-messages)
Error Code | Validation Message
— | —
A165 | The attachment category is invalid for this business process.
A175 | The file is required.
A178 | The business process has already been initiated.
A200 | You can’t comment on this business process type.
A205 | You don’t have the security permission on this business process to add attachments.
A206 | Attachments are not enabled for this business process.
A207 | You’ve exceeded the attachment file size limit of [tenant setup attachment limit]KB.
A211 | The attachment category is required.
A219 | The business process action isn’t valid.
A221 | The attachment category isn’t enabled for this business process.
A368 | This operation is only available to the person who initiated the Change Job operation.
A370 | Enter an active Pay Rate Type.
A374 | Submit a job profile.
A375 | [JobReqErrorMessageWithRecruitDate]
A376 | This position cannot be closed because it is in an overlap situation
A377 | Submit an active location.
A378 | Submit a valid work space for the location.
A379 | Submit a valid ~employee~ type.
A380 | Submit a date on which this change will become effective.
A381 | The job is not valid for the ~worker~.
A383 | Submit a position, this ~worker~ has more than one position you have access to.
A384 | The ~worker~ has pending events that conflict with this job change.
[InProgressMoveWorkerEvents]
[InProgressEventsonPosition]
[InProgressPromotionAdjustment]
[InProgressCompensationAdjustment]
[InProgressResignationEvents]
[InProgressPositionSwap]
A385 | Submit an active assignment type.
A386 | [EffectiveDateLessThanEarliestHireDateMessage]
A387 | Submit a ~supervisory organization~ or remove the field.
A388 | You can’t submit the selected headcount option when moving from a position management staffing organization to job management staffing organization.
A390 | You cannot run this task on yourself.
A391 | Enter a date that is after [lastUpdatedDate], the date the position was last updated.
A391 | Enter a date that is after [lastUpdatedDate], the date the position was last updated.
A392 | Working FTE cannot be greater than 999%.
A393 | Submit an international assignment type.
A395 | Submit a valid work shift for the location.
A401 | [Invalid In Progress Work Space Change]
A402 | Proposed Position is Required or Create Position must be selected.
A403 | Submit this operation before the event Initiation step.
A405 | Submit a valid position for the proposed organization.
A406 | Time Type is required.
A407 | Submit a valid ~contingent worker~ type.
A408 | The proposed position or job requisition is not valid for this ~worker~ type.
A409 | Submit an active ~workers’~ compensation code.
A410 | Submit a valid position time type.
A413 | The proposed ~supervisory organization~ is in a Hiring Freeze. It cannot be selected.
A414 | The current ~supervisory organization~ has changed for this position, and you can’t make additional changes. Cancel this request and submit a new transaction.
A416 | Submit a reason.
A417 | Submit a location or remove the field.
A418 | Expected Assignment End Date is required for fixed-term ~employees~ on assignment.
A419 | Select an End Employment Date that’s on or after the Start Date: [start_date].
A420 | Submit an effective date that’s on or after the last completed staffing organization change: [date].
A422 | You can’t submit a change job operation for this worker.
A423 | You can’t submit job overlap edits on this change job.
A424 | The ~supervisory organization~ is invalid on the specified date. Specify a different ~supervisory organization~ in a new Change Job operation.
A426 | You can’t close a position with a Create Job Requisition Event in progress.
A427 | Submit a location that meets the proposed hiring restrictions.
A429 | FTE cannot be greater than 999%.
A430 | Submit a valid business site.
A431 | You need to close the job requisition before you can close the position.
A435 | Submit a valid reason.
A437 | End Employment Date is required for a fixed-term ~employee~.
A438 | Submit a job profile that’s active as of the effective date.
A439 | This position’s ~supervisory organization~ cannot be changed because it is in an overlap situation.
A441 | Submit a job profile that meets the hiring restrictions.
A442 | Submit an ~employee~ type.
A443 | [Invalid Complete Work Space Change]
A446 | Submit a ~contingent worker~ type.
A447 | Submit a valid job requisition for this operation.
A448 | The hiring restrictions for the proposed ~supervisory organization~ do not allow this type of ~worker~.
A450 | Hiring restrictions are missing for the organization selected.
A452 | The Job Profile specified requires Work Shift, therefore Work Shift is required.
A453 | Submit active job classifications that are valid for the location.
A454 | Submit an expected assignment end date that’s after the start date: [start_date].
A455 | Submit an active company insider type.
A456 | Enter a Contract End Date that is after [timedate], the latest time entry submitted for its purchase order.
A457 | [EventEffectiveDateLessThanRecruitingDateMessage]
A457 | [EventEffectiveDateLessThanRecruitingDateMessage]
A460 | The Proposed Position or Headcount Group is frozen as of the effective date.
A461 | If you don’t select Move Headcount, select current and proposed positions that don’t match.
A462 | Enter a value of 168 hours or fewer.
A462 | Enter a value of 168 hours or fewer.
A464 | The proposed position is not fillable.
A465 | Paid FTE cannot be greater than 999%.
A466 | Enter a First Day of Work that is on or after the date that this job change takes effect.
A944 | You can’t complete this transaction because the ~worker~ is included in an in-progress compensation review process. You can remove the ~worker~ from the compensation review process, then complete the transaction, and optionally add the ~worker~ back to the compensation review process.
A1005 | Comments are not available for this business process. Remove your comment to continue.
A1716 | [This time type is inactive: time type. Specify an active time type for Time Type.]

401

Invalid resource or operation. (https://community.workday.com/rest/error-messages)

403

User has insufficient permissions. (https://community.workday.com/rest/error-messages)

404

Resource not found. (https://community.workday.com/rest/error-messages)

POST /jobChanges/{ID}/submit

Organizationassignmentchanges 2 endpoints

POST /organizationAssignmentChanges Creates a new change organization assignment event for a specific filled or unfilled position.

Creates a new change organization assignment event for a specific filled or unfilled position, which returns a new change organization assignment ID. Specify the new ID in subsequent requests that update or get information about the change organization assignment event.

In the request body, specify at least this required field: date, job {id}.”

Secured by: Change Organization Assignment (REST)

Scope: Organizations and Roles

operationId: OrganizationAssignmentChanges_createChangeEvent

Request Body

required

application/json

schema organizationAssignmentChangesPostPosition_cf97466f96d9100029bffcf91c120000

Property	Type	Required
id	string	optional
date	string	required
position	object	required
└ id	string	required
└ href	string	optional
└ descriptor	string	optional
descriptor	string	optional
massActionHeader	object	optional
└ id	string	required
└ href	string	optional
└ descriptor	string	optional
massActionWorksheet	object	optional
└ id	string	required
└ href	string	optional
└ descriptor	string	optional

Responses

default

An error occurred.

201

Resource created.

400

Invalid request. (https://community.workday.com/rest/error-messages)

401

Invalid resource or operation. (https://community.workday.com/rest/error-messages)

403

User has insufficient permissions. (https://community.workday.com/rest/error-messages)

404

Resource not found. (https://community.workday.com/rest/error-messages)

POST /organizationAssignmentChanges

POST /organizationAssignmentChanges/{ID}/submit Submits the organization changes request for the specified ID, and initiates the Change Organization Assignment business process.

Submits the organization assignment change event for the specified ID, and initiates the Change Organization Assignment business process.

Submitting this request with an empty request body { } is equivalent to clicking the Submit button on the Change Organization Assgingment task in Workday.

For the equivalent of clicking the Save For Later button, specify the Save for Later Workday ID, ““d9e41a8c446c11de98360015c5e6daf6””, in the status{id} request field.

Example:
{ ““status””: {
““id””: ““d9e41a8c446c11de98360015c5e6daf6””
}
}

Secured by: Change Organization Assignment (REST)

Scope: Organizations and Roles

operationId: OrganizationAssignmentChanges_submitChangeRequest

Parameters

Name	In	Required	Type	Description
ID	path	required	string	The Workday ID of the resource.

Request Body

required

application/json

schema eventStateOrganizationAssignment_f3e1ff305e2d100003327f7b7fa103f1

Property	Type	Required
id	string	optional
descriptor	string	optional
businessProcessParameters	object	optional
└ for	object	optional
└ id	string	required
└ href	string	optional
└ descriptor	string	optional
└ action	object	required
└ id	string	required
└ href	string	optional
└ descriptor	string	optional
└ comment	string	optional
└ comments	array	optional
└ person	object	optional
└ id	string	required
└ href	string	optional
└ descriptor	string	optional
└ comment	string	optional
└ commentDate	string	optional
└ attachments	array	optional
└ id	string	optional
└ category	object	optional
└ id	string	required
└ href	string	optional
└ descriptor	string	optional
└ fileName	string	optional
└ fileLength	integer	optional
└ uploadDate	string	optional
└ uploadedBy	object	optional
└ id	string	required
└ href	string	optional
└ descriptor	string	optional
└ contentType	object	optional
└ id	string	required
└ href	string	optional
└ descriptor	string	optional
└ description	string	optional
└ overallStatus	string	optional
└ transactionStatus	object	optional
└ id	string	required
└ href	string	optional
└ descriptor	string	optional
└ warningValidations	string	optional
└ criticalValidations	string	optional
└ overallBusinessProcess	object	optional
└ id	string	required
└ href	string	optional
└ descriptor	string	optional

Responses

default

An error occurred.

201

Resource created.

400

Invalid request. (https://community.workday.com/rest/error-messages)
Error Code | Validation Message
— | —
A165 | The attachment category is invalid for this business process.
A175 | The file is required.
A178 | The business process has already been initiated.
A178 | The business process has already been initiated.
A200 | You can’t comment on this business process type.
A205 | You don’t have the security permission on this business process to add attachments.
A206 | Attachments are not enabled for this business process.
A207 | You’ve exceeded the attachment file size limit of [tenant setup attachment limit]KB.
A211 | The attachment category is required.
A219 | The business process action isn’t valid.
A221 | The attachment category isn’t enabled for this business process.
A371 | You can’t change organizations for this position because it might conflict with completed transactions. Access the ~Worker~ History for a list of potential conflicts. For position management, view the business process history on the filled position and position restriction.
A394 | Enter an Effective Date that is on or after the hire date for the ~worker~: [date].
A497 | Position Restriction is closed as of the effective date. Organizations cannot be changed after it has been closed.
A499 | This operation is only available to the person who initiated the Change Organization Assignment operation.
A500 | Select only 1 Cost Center.
A501 | Select only 1 Gift.
A502 | Company is required.
A503 | Select an Effective Date that is before the move date: [date].
A504 | The Position Restriction isn’t available as of the Effective Date. You can’t assign to the organization until on or after [date].
A505 | Submit a valid Gift.
A506 | Submit a valid Fund.
A507 | Submit a valid Grant.
A509 | Cost Center is required.
A510 | Submit a valid Company.
A511 | Submit a valid Cost Center.
A512 | Business Unit is required.
A513 | Program is required.
A514 | Select only 1 Company.
A515 | Grant is required.
A516 | This position will be vacated or closed as of the effective date. Organization assignments cannot be made.
A517 | Select only 1 Grant.
A518 | Select only 1 Fund.
A522 | Select only 1 Business Unit.
A524 | Submit a valid Business Unit.
A526 | Submit a valid Program.
A527 | Submit a valid Region.
A529 | Region is required.
A530 | Select only 1 Region.
A531 | Select an Effective Date that is on or after the move date: [date].
A534 | Submit a valid custom organization for these organization types: [orgTypesInvalid].
A537 | The organization type has multiple custom organizations. Submit only 1 custom organization for these organization types: [orgTypesInvalid].
A538 | Select only 1 Program.
A539 | Gift is required.
A541 | Fund is required.
A542 | Submit at least 1 custom organization for these organization types: [orgTypesInvalid].
A1005 | Comments are not available for this business process. Remove your comment to continue.
A1546 | [Complete or cancel all pending actions for worker before initiating this action]
A1553 | [You cant change company details for this event. Making these changes out of order can cause payroll errors for workers based in the UK.]
A1556 | [The Effective Date must be on or after date. There is a completed event that conflicts with this date]
A1590 | [You cant select Staff because it will override the existing Cost Center on effective date and is not allowed for the Location Hierarchy or Supervisory Organization on that date. Correct or Rescind the Assign Organizations event effective on that date. If there are multiple Assign Organizations events on that date, rescind all of those events before continuing]
A1591 | [You cant select Staff because it will override the existing Region on effective date and is not allowed for the Location Hierarchy or Supervisory Organization on that date. Correct or Rescind the Assign Organizations event effective on that date. If there are multiple Assign Organizations events on that date, rescind all of those events before continuing]
A1592 | [You cant select Staff because it will override the existing Organization Type on effective date and is not allowed for the Location Hierarchy or Supervisory Organization on that date. Correct or Rescind the Assign Organizations event effective on that date. If there are multiple Assign Organizations events on that date, rescind all of those events before continuing.]
A1593 | [You cant select Staff because it will override the existing Company on effective date and is not allowed for the Location Hierarchy or Supervisory Organization on that date. Correct or Rescind the Assign Organizations event effective on that date. If there are multiple Assign Organizations events on that date, rescind all of those events before continuing]
A1594 | [The changes you’ve made to Company or Cost Center will override the existing Company or Cost Center on date and will be invalid due to restricted Companies by Cost Center. Correct or Rescind the Company or Cost Center on the Assign Organizations event on date to continue. If there are multiple organization assignment events on that date, rescind all of those events before continuing. If this value populated automatically and you are unable to edit the organization, contact your administrator]
A1595 | [1 or more of these custom organizations is inactive: custom orgs. Correct or rescind any Assign Organization events effective on the inactive date of the custom organizations to continue.]
A1596 | [You cant select Staff because it will override the existing Program on COA effective date and is not allowed for the Location Hierarchy or Supervisory Organization on that date. Correct or Rescind the Assign Organizations event effective on that date. If there are multiple Assign Organizations events on that date, rescind all of those events before continuing]
A1597 | [You cant select Staff because it will override the existing Grant on COA effective date and is not allowed for the Location Hierarchy or Supervisory Organization on that date. Correct or Rescind the Assign Organizations event effective on that date. If there are multiple Assign Organizations events on that date, rescind all of those events before continuing]
A1598 | [You cant select Staff because it will override the existing Fund on COA effective date and is not allowed for the Location Hierarchy or Supervisory Organization on that date. Correct or Rescind the Assign Organizations event effective on that date. If there are multiple Assign Organizations events on that date, rescind all of those events before continuing]
A1599 | [You cant select Staff because it will override the existing Business Unit on COA effective date and is not allowed for the Location Hierarchy or Supervisory Organization on that date. Correct or Rescind the Assign Organizations event effective on that date. If there are multiple Assign Organizations events on that date, rescind all of those events before continuing]
A1600 | [You cant select Staff because it will override the existing Gift on COA effective date and is not allowed for the Location Hierarchy or Supervisory Organization on that date. Correct or Rescind the Assign Organizations event effective on that date. If there are multiple Assign Organizations events on that date, rescind all of those events before continuing]
A1611 | [You cant select Staff because its inactive on inactive date and will override the existing Cost Center on COA effective date. Correct or Rescind the Assign Organization event effective on COA effective date. If there are multiple organization assignment events on that date rescind all of those events before continuing]
A1612 | [You cant select Staff because its inactive on inactive date and will override the existing Region on COA effective date. Correct or Rescind the Assign Organization event effective on COA effective date. If there are multiple organization assignment events on that date rescind all of those events before continuing]
A1613 | [You cant select Staff because its inactive on inactive date and will override the existing Company on COA effective date. Correct or Rescind the Assign Organization event effective on COA effective date. If there are multiple organization assignment events on that date rescind all of those events before continuing]

401

Invalid resource or operation. (https://community.workday.com/rest/error-messages)

403

User has insufficient permissions. (https://community.workday.com/rest/error-messages)

404

Resource not found. (https://community.workday.com/rest/error-messages)

POST /organizationAssignmentChanges/{ID}/submit

Workers 9 endpoints

POST /workers/{ID}/checkInTopics Creates Check-In topics.

Creates a single Check-In topic instance with the specified data with the specified worker. 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.

In the request body, specify at least these required fields: name.

This endpoint is equivalent to the Create Check-In Topic task in Workday.

Secured by: Worker Data: Check-Ins REST API

Scope: Performance Enablement

Contains attachment(s)

operationId: Workers_createCheckInTopic

Parameters

Name	In	Required	Type	Description
ID	path	required	string	The Workday ID of the resource.

Request Body

application/json

schema checkInTopicDetail_3267c0ba92a010001688d79b032b03b8

Property	Type	Required
id	string	optional
name	string	optional
sharedNotes	string	optional
privateNotes	string	optional
associatedCheckIns	array	optional
└ id	string	optional
checkInTopicAttachments	array	optional
└ id	string	optional
└ comment	string	optional
└ fileName	string	optional
└ descriptor	string	optional
└ fileLength	integer	optional
└ contentType	object	optional
└ id	string	required
└ href	string	optional
└ descriptor	string	optional

Responses

default

An error occurred.

201

Resource created.

400

Invalid request. (https://community.workday.com/rest/error-messages)
Error Code | Validation Message
— | —
A6 | Submit a File for attachments.
A6 | Topic name is required.
A161 | You can’t add a topic to a Check-In that has a different participant.
A161 | You can’t add a topic to a Check-In that’s been archived.
A161 | You can’t create a Check-In topic with a terminated worker.
A161 | You can’t create a Check-In topic with yourself.

401

Invalid resource or operation. (https://community.workday.com/rest/error-messages)

403

User has insufficient permissions. (https://community.workday.com/rest/error-messages)

404

Resource not found. (https://community.workday.com/rest/error-messages)

POST /workers/{ID}/checkInTopics

POST /workers/{ID}/checkIns Creates Check-Ins.

Creates a single Check-In instance with the specified data with the specified worker. 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.

In the request body, specify at least the required field: date.

This endpoint is equivalent to the Create Check-In task in Workday.

Secured by: Worker Data: Check-Ins REST API

Scope: Performance Enablement

Contains attachment(s)

operationId: Workers_createCheckIn

Parameters

Name	In	Required	Type	Description
ID	path	required	string	The Workday ID of the resource.

Request Body

application/json

schema checkInDetail_316b5a26cc3c10000ebdb0cb484602e1

Property	Type	Required
id	string	optional
date	string	required
description	string	optional
associatedTopics	array	optional
└ id	string	optional
checkInAttachments	array	optional
└ id	string	optional
└ comment	string	optional
└ fileName	string	optional
└ descriptor	string	optional
└ fileLength	integer	optional
└ contentType	object	optional
└ id	string	required
└ href	string	optional
└ descriptor	string	optional

Responses

default

An error occurred.

201

Resource created.

400

Invalid request. (https://community.workday.com/rest/error-messages)
Error Code | Validation Message
— | —
A6 | Check-In date is required.
A6 | Submit a File for attachments.
A161 | You can’t add a topic that’s been archived.
A161 | You can’t create a Check-In with a terminated worker.
A161 | You can’t create a Check-In with yourself.
A161 | You can’t include Check-In Topics that have a different participant.
A161 | You cannot have more than one ~check-in~ on the same date with the same participant.

401

Invalid resource or operation. (https://community.workday.com/rest/error-messages)

403

User has insufficient permissions. (https://community.workday.com/rest/error-messages)

404

Resource not found. (https://community.workday.com/rest/error-messages)

POST /workers/{ID}/checkIns

POST /workers/{ID}/explicitSkills Save skills a user has

Save skills a user has

Secured by: Self-Service: Skills

Scope: Worker Profile and Skills

operationId: Workers_saveUserSkills

Parameters

Name	In	Required	Type	Description
ID	path	required	string	The Workday ID of the resource.

Request Body

required

application/json

schema createSkillUsageRepresentation_98f198f5056b1000196313ffe9a0225e

Property	Type	Required
skills	array	optional
└ id	string	optional
└ remoteID	string	optional
└ skillItem	object	optional
└ id	string	required
└ href	string	optional
└ descriptor	string	optional
└ descriptor	string	optional
└ skillSources	array	optional
└ id	string	optional
└ descriptor	string	optional
└ sourceType	string	optional
└ dateCreated	string	optional
└ sourceTypeID	string	optional
skillItem	object	optional
└ id	string	optional
└ remoteID	string	optional
└ skillName	string	optional
skillSources	array	optional
└ id	string	optional
└ skillSource	object	optional
└ id	string	required
└ href	string	optional
└ descriptor	string	optional

Responses

default

An error occurred.

201

Resource created.

400

Invalid request. (https://community.workday.com/rest/error-messages)

401

Invalid resource or operation. (https://community.workday.com/rest/error-messages)

403

User has insufficient permissions. (https://community.workday.com/rest/error-messages)

404

Resource not found. (https://community.workday.com/rest/error-messages)

POST /workers/{ID}/explicitSkills

POST /workers/{ID}/externalSkillLevel Creates external skill levels.

Creates external skill levels.

Secured by: Self-Service: External Skill Source, Worker Data: External Skill Source

Scope: Worker Profile and Skills

operationId: Workers_createExternalSkillLevels

Parameters

Name	In	Required	Type	Description
ID	path	required	string	The Workday ID of the resource.

Request Body

application/json

schema externalSkillLevel_a39462f09c44100005d46fd77ef00000

Property	Type	Required
id	string	optional
context	string	optional
effectiveMoment	string	optional
externalSkillId	string	required
externalSkillLevel	integer	required

Responses

default

An error occurred.

201

Resource created.

400

Invalid request. (https://community.workday.com/rest/error-messages)
Error Code | Validation Message
— | —
A1977 | To submit POST and PUT, enable Skills Cloud in the tenant.
A2003 | Specify a date that isn’t in the future.
A2004 | Specify a Normalized Skill Level that’s greater than or equal to 1 and less than or equal to 5.
A2005 | Specify an External Skill ID that exists.
A2007 | This External Skill Level for the worker already exists: [EXTERNAL SKILL NAME]
A2008 | Specify a Free Context that doesn’t exceed 500 characters.
A2009 | Specify an External Skill ID that’s mapped to a Local Skill.

401

Invalid resource or operation. (https://community.workday.com/rest/error-messages)

403

User has insufficient permissions. (https://community.workday.com/rest/error-messages)

404

Resource not found. (https://community.workday.com/rest/error-messages)

POST /workers/{ID}/externalSkillLevel

POST /workers/{ID}/homeContactInformationChanges

Creates a new Home Contact Change business process event for the parent Person.

Secured by: Change Home Contact Information (REST Service)

Scope: Contact Information

operationId: Workers_createHomeContactChangeProcess

Parameters

Name	In	Required	Type	Description
ID	path	required	string	The Workday ID of the resource.

Request Body

required

application/json

schema homeContactChangeEvent_f42ba27d87ed10001aa58a5d231b1621

Property	Type	Required
id	string	optional
href	string	optional
descriptor	string	optional
effective_date	string	optional

Responses

default

An error occurred.

201

Resource created.

400

Invalid request. (https://community.workday.com/rest/error-messages)
Error Code | Validation Message
— | —
A602 | You cannot initialize a Home Contact Change Event for this Person.
A641 | There is already a Change Home Contact Information event in progress for this person. That event must be completed before another can be started.

401

Invalid resource or operation. (https://community.workday.com/rest/error-messages)

403

User has insufficient permissions. (https://community.workday.com/rest/error-messages)

404

Resource not found. (https://community.workday.com/rest/error-messages)

POST /workers/{ID}/homeContactInformationChanges

POST /workers/{ID}/jobChanges Initiates a job change request for a specific worker

Initiates a job change request for a specific worker
Call this method to start a new job change event, which returns a new job change ID. Use the new ID to reference the job change event in subsequent methods that update or get information about the same event.

The same Workday UI validations apply with this POST method. The updates in this POST method do not persist until you call POST /jobChanges/{ID}/submit.

In the request body, specify at least this required field: date, worker {id}, job {id}, reason {id}

To retrieve a worker ID, call the GET /values/jobChangesGroup/workers prompt endpoint with the effectiveDate query parameter. It returns HREF links to workers by category. You can filter the results by effectiveDate. By default, it returns workers on the current date. Only workers without blocking events or available for change job for the current user are returned.

To retrieve a job ID, call the GET /values/jobChangesGroup/jobs prompt endpoint with the worker query parameter. It returns all positions for the worker with current user access to do a job change. You can filter the results by effectiveDate. By default, it returns positions on the current date.

To retrieve a reason ID, call the GET /values/jobChangesGroup/reason prompt endpoint, which takes the job change ID as the staffingEvent query parameter. If you specify the staffingEvent parameter, it returns change job reasons for the staffingEvent, by the change job category. By default, it returns all change job categories and reasons.

To retrieve a supervisoryOrganization ID, call the GET /values/jobChangesGroup/supervisoryOrganization prompt endpoint, with proposedManager and effectiveDate query parameters. If you specify the proposedManager parameter, it returns HREF links to all supervisory organizations for that manager. If you specify effectiveDate, it filters the results by effective date. The default is the current date.

To retrieve a location ID, call the GET /values/jobChangesGroup/locations prompt endpoint, which takes the staffingEvent query parameter. It returns HREF links to locations by location categories for the specified location. You can filter the results by effectiveDate. By default, it returns locations on the current date.

Secured by: Change Job (REST Service)

Scope: Staffing

operationId: Workers_initiateJobChange

Parameters

Name	In	Required	Type	Description
ID	path	required	string	The Workday ID of the resource.

Request Body

required

application/json

schema jobChangesStartDetailsPOSTData_75e528a78e9a10000ab750ea156f0111

Property	Type	Required
id	string	optional
job	object	optional
└ id	string	required
└ href	string	optional
└ descriptor	string	optional
date	string	required
reason	object	optional
└ id	string	required
└ href	string	optional
└ descriptor	string	optional
location	object	optional
└ id	string	required
└ href	string	optional
└ descriptor	string	optional
template	object	optional
└ id	string	required
└ href	string	optional
└ descriptor	string	optional
descriptor	string	optional
supervisoryOrganization	object	optional
└ id	string	required
└ href	string	optional
└ descriptor	string	optional

Responses

default

An error occurred.

201

Resource created.

400

Invalid request. (https://community.workday.com/rest/error-messages)
Error Code | Validation Message
— | —
A390 | You cannot run this task on yourself.
A391 | Enter a date that is after [lastUpdatedDate], the date the position was last updated.
A391 | Enter a date that is after [lastUpdatedDate], the date the position was last updated.
A415 | Select another ~supervisory organization~. This ~supervisory organization~ can’t be used because it’s inactive on [date].
A420 | Submit an effective date that’s on or after the last completed staffing organization change: [date].
A422 | You can’t submit a change job operation for this worker.
A428 | The ~worker~ has pending events that conflict with this job change.
[InProgressMoveWorkerEvents]
[InProgressEventsonPosition]
[InProgressMerit]
[InProgressResignationEvents]
[InProgressPositionSwap]
A681 | You can’t update the reason for Change Job because it automatically populates from the template: [template].
A944 | You can’t complete this transaction because the ~worker~ is included in an in-progress compensation review process. You can remove the ~worker~ from the compensation review process, then complete the transaction, and optionally add the ~worker~ back to the compensation review process.

401

Invalid resource or operation. (https://community.workday.com/rest/error-messages)

403

User has insufficient permissions. (https://community.workday.com/rest/error-messages)

404

Resource not found. (https://community.workday.com/rest/error-messages)

POST /workers/{ID}/jobChanges

POST /workers/{ID}/organizationAssignmentChanges Initiates an organization assignment change for a specific worker.

Initiates an organization assignment change for a specific worker.
Call this method to start a new change organization assignment event, which returns a new change organization assignment ID. Use the new ID to reference the change organization assignment event in subsequent methods that update or get information about the same event.

The same Workday UI validations apply with this POST method. The updates in this POST method do not persist until you call POST /organizationAssignmentChanges/{ID}/submit.

In the request body, specify at least this required field: date, worker {id}, job {id}

To retrieve a worker ID, call the GET /values/organizationAssignmentChangesGroup/workers prompt endpoint with the effectiveDate query parameter. It returns HREF links to workers by category. You can filter the results by effectiveDate. By default, it returns workers on the current date. Only workers without blocking events or available for organization assignment change for the current user are returned.

To retrieve a job ID, call the /values/organizationAssignmentChangesGroup/jobs prompt endpoint with the worker query parameter. It returns all positions for the worker with current user access to do an organization assignment change . You can filter the results by effectiveDate. By default, it returns positions on the current date.

Secured by: Change Organization Assignment (REST)

Scope: Organizations and Roles

operationId: Workers_initiateOrganizationAssignmentChange

Parameters

Name	In	Required	Type	Description
ID	path	required	string	The Workday ID of the resource.

Request Body

required

application/json

schema organizationAssignmentChangesPost_cc45d62b623c1000132ac812c30a052e

Property	Type	Required
id	string	optional
date	string	required
position	object	optional
└ id	string	required
└ href	string	optional
└ descriptor	string	optional
descriptor	string	optional

Responses

default

An error occurred.

201

Resource created.

400

Invalid request. (https://community.workday.com/rest/error-messages)
Error Code | Validation Message
— | —
A371 | You can’t change organizations for this position because it might conflict with completed transactions. Access the ~Worker~ History for a list of potential conflicts. For position management, view the business process history on the filled position and position restriction.
A389 | There’s at least 1 conflicting in-progress or completed event. For in-progress events, cancel or complete the events. For completed events, specify a date that’s on or after the event, or rescind the event. [events]
A394 | Enter an Effective Date that is on or after the hire date for the ~worker~: [date].
A398 | ~Worker~ has more than one position. Position input required.
A411 | The position entered is not a valid position for the ~Worker~ as of the date entered.
A421 | There’s a conflicting in-progress event. Cancel the event. [event]
A449 | An organization assignment change can’t be submitted for this ~worker~ on this date.
A944 | You can’t complete this transaction because the ~worker~ is included in an in-progress compensation review process. You can remove the ~worker~ from the compensation review process, then complete the transaction, and optionally add the ~worker~ back to the compensation review process.

401

Invalid resource or operation. (https://community.workday.com/rest/error-messages)

403

User has insufficient permissions. (https://community.workday.com/rest/error-messages)

404

Resource not found. (https://community.workday.com/rest/error-messages)

POST /workers/{ID}/organizationAssignmentChanges

POST /workers/{ID}/skillItems

Secured by: Person Data: Skills, Self-Service: Skills

Scope: Worker Profile and Skills

operationId: Workers_createSkillItem

Parameters

Name	In	Required	Type	Description
ID	path	required	string	The Workday ID of the resource.

Request Body

required

application/json

schema skillItemsBulkDefinition_9d815bbfd67010000d6ed56204ab12de

Property	Type	Required
skillItems	array	optional
└ id	string	optional
└ remoteID	string	optional
└ skillItem	object	optional
└ id	string	required
└ href	string	optional
└ descriptor	string	optional
└ skillName	string	optional

Responses

default

An error occurred.

201

Resource created.

400

Invalid request. (https://community.workday.com/rest/error-messages)

401

Invalid resource or operation. (https://community.workday.com/rest/error-messages)

403

User has insufficient permissions. (https://community.workday.com/rest/error-messages)

404

Resource not found. (https://community.workday.com/rest/error-messages)

POST /workers/{ID}/skillItems

POST /workers/{ID}/workContactInformationChanges

Creates a new Home Contact Change business process event for the parent Person.

Secured by: Change Work Contact Information (REST Service)

Scope: Contact Information

operationId: Workers_createWorkContactInformationChanges

Parameters

Name	In	Required	Type	Description
ID	path	required	string	The Workday ID of the resource.

Request Body

required

application/json

schema workContactChangeEvent_5fca6c96c1c81000142fd03784140113

Property	Type	Required
id	string	optional
href	string	optional
descriptor	string	optional
effective_date	string	optional

Responses

default

An error occurred.

201

Resource created.

400

Invalid request. (https://community.workday.com/rest/error-messages)
Error Code | Validation Message
— | —
A635 | You cannot initialize a Work Contact Change Event for this Person.
A644 | There is already a Change Work Contact Information event in progress for this person. That event must be completed before another can be started.

401

Invalid resource or operation. (https://community.workday.com/rest/error-messages)

403

User has insufficient permissions. (https://community.workday.com/rest/error-messages)

404

Resource not found. (https://community.workday.com/rest/error-messages)

POST /workers/{ID}/workContactInformationChanges

Load more endpoints

Schemas

object ERROR_MODEL_REFERENCE

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "code": {
      "type": "string",
      "description": "The code that corresponds to the error message. Use the error code to drive programmatic error-handling behavior. Don't use error message strings for this purpose because they are subject to change"
    },
    "path": {
      "type": "string",
      "description": "The path of the field related to the error"
    },
    "error": {
      "type": "string",
      "description": "A description of the error"
    },
    "field": {
      "type": "string",
      "description": "The field related to the error"
    }
  }
}

array FACETS_MODEL_REFERENCE

{
  "type": "array",
  "items": {
    "type": "object",
    "readOnly": true,
    "properties": {
      "values": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "id"
          ],
          "properties": {
            "id": {
              "type": "string",
              "pattern": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
              "description": "wid / id / reference id"
            },
            "href": {
              "type": "string",
              "readOnly": true,
              "description": "A link to the instance"
            },
            "count": {
              "type": "integer",
              "format": "int32",
              "description": "The number of instances returned by this facet"
            },
            "descriptor": {
              "type": "string",
              "description": "A description of the facet"
            }
          }
        },
        "description": "the facet values"
      },
      "descriptor": {
        "type": "string",
        "description": "A description of the facet"
      },
      "facetParameter": {
        "type": "string",
        "description": "The alias used to select the facet"
      }
    },
    "description": "This object represents the possible facets for this resource"
  }
}

object INSTANCE_MODEL_REFERENCE

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
      "description": "wid / id / reference id"
    },
    "href": {
      "type": "string",
      "readOnly": true,
      "description": "A link to the instance"
    },
    "descriptor": {
      "type": "string",
      "readOnly": true,
      "description": "A description of the instance"
    }
  }
}

object JobChangesGetAdministrativeOptionsResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/changeJobAdministrativeDetailsData_f8f20079bc5a1000089ccb7f6a8800ea"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object JobChangesGetBusinessTitleResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/changeJobBusinessTitle_3db8095ffa18100013a5f96969ca0102"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object JobChangesGetCommentByIdResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/comments_7d98fd55aeee100022968e52a1b31c60"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object JobChangesGetContractOptionsResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/changeJobContractDetailsData_27ec818d10d010000386ce823ac20107"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object JobChangesGetJobClassificationResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/changeJobJobClassificationData_354103f196361000084489bcb281017f"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object JobChangesGetJobProfileResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/changeJobJobProfileData_3db8095ffa18100013f019a27a1f0115"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object JobChangesGetLocationInfoResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/changeJobLocation_90151d6c4ff110001b4a46091678025c"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object JobChangesGetMoveTeamOptionResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/changeJobMoveTeamData_544fdf5c01da1000238ad82d26d90146"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object JobChangesGetOpeningOptionsResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/changeJobOpeningData_97af9049a5fd10001c4888d654170000"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object JobChangesGetPositionByIdResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/changeJobPositionData_dfc4e58f7308100018bd1c459f435221"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object JobChangesGetStartDetailsResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/jobChangesStartDetailsData_ce861a6a360d10002d40f176b7180020"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object JobFamiliesListResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/jobFamilyView_51ed1475e9e6100005d10fcedc5a000a"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object JobProfilesListCollectionResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/jobProfileSummaryView_7deab99f645f10000b5152ce2d700034"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object JobsGetCollectionResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/jobData_1bfa8925c50510000ae4479925510026"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object JobsGetWorkspacesResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/jobWorkspaceData_1005157e3d631000144205466a6c13d3"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object MULTIPLE_INSTANCE_MODEL_REFERENCE

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
      }
    },
    "total": {
      "type": "integer"
    }
  }
}

object OrganizationAssignmentChangesGetBusinessUnitResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/organizationAssignmentChangesBusinessUnitData_5aabf8e28cb310002520b2a2b31d0365"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object OrganizationAssignmentChangesGetCommentResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/comments_7d98fd55aeee100022968e52a1b31c60"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object OrganizationAssignmentChangesGetCompanyResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/organizationAssignmentChangesCompanyData_652d516fdff41000086e0b9c96950354"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object OrganizationAssignmentChangesGetCostCenterResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/organizationAssignmentChangesCostCenterData_5aabf8e28cb3100010a999db2700024e"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object OrganizationAssignmentChangesGetCostingOrganizationsResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/organizationAssignmentChangesCostingData_a18edb56aca0100014a4a09dc57e045a"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object OrganizationAssignmentChangesGetCustomOrganizationsResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/organizationAssignmentChangesCustomOrganizationDetailsData_53cd2b632146100011e9bf4e7041551f"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object OrganizationAssignmentChangesGetRegionResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/organizationAssignmentChangesRegionData_a18edb56aca0100006997e68e5780373"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object OrganizationAssignmentChangesGetStartDetailsResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/organizationAssignmentChangesStartDetailsData_90009f2bfc49100017b10cd07d19063b"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object SupervisoryOrganizationsGetByIdResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/supervisoryOrganizationView_a02c2e1916fa100009e137235f1f0018"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object SupervisoryOrganizationsGetMembersResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/jobData_1bfa8925c50510000ae4479925510026"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object SupervisoryOrganizationsGetOrgChartResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/orgChartView_643e3a12629710000554e0338e670044"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object VALIDATION_ERROR_MODEL_REFERENCE

{
  "allOf": [
    {
      "type": "object",
      "required": [
        "error"
      ],
      "properties": {
        "error": {
          "type": "string",
          "description": "A description of the error"
        },
        "errors": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          },
          "description": "An array of validation errors"
        }
      }
    }
  ]
}

object WorkersGetCheckInTopicsResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/checkInTopicsSummary_d81c816de26f10000ef2c5cb2fdd0015"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object WorkersGetCheckInsResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/checkInsSummary_b3a69f47a499100010ce6be72bfe001d"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object WorkersGetCollectionStaffingResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/workerData_c2466b0778c610000d1936006720000e"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object WorkersGetExplicitSkillsResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/displayExplicitSkillRepresentation_d6ca778018011000182fa5be1ae901a8"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object WorkersGetExternalSkillLevelResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/externalSkillLevelDetail_1c67ac98c0f310002706be33dcdb0000"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object WorkersGetServiceDatesResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/serviceDatesData_6b1db753fd82100027b0c8519c860018"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object WorkersGetSkillItemsResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/skillItemDisplayDefinition_4b4b7d34b4a21000301eaf52086700d8"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object action_38ff08ab6736100010816009079d0126

{
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {}
  ],
  "description": "a set containing no instances"
}

object assignmentType_23929e1f68ca10000d6940d6bde56963

{
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {}
  ],
  "description": "For a past or current business process, the value of the Assignment Type field that is being (or was) proposed in the process.",
  "x-conditionally-hidden": true,
  "x-conditionally-required": true
}

object associatedCheckInDetail_3267c0ba92a0100016ed105476ad03c4

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the instance"
        }
      }
    }
  ]
}

object associatedCheckInTopicDetail_316b5a26cc3c100010a01184c23902ea

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the instance"
        }
      }
    }
  ]
}

object associatedCheckInsSummary_d81c816de26f10000f7a29ea89140020

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the instance"
        },
        "date": {
          "type": "string",
          "format": "date",
          "example": "2024-03-23T07:00:00.000Z",
          "description": "Date of check-in.",
          "x-workday-type": "Date"
        },
        "archived": {
          "type": "boolean",
          "example": true,
          "description": "Indicates that the check-in is archived.",
          "x-workday-type": "Boolean"
        }
      }
    }
  ]
}

object associatedTopicsSummary_b3a69f47a4991000171aae4c5a810040

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the instance"
        },
        "name": {
          "type": "string",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "description": "Topic name.",
          "x-workday-type": "Text"
        },
        "archived": {
          "type": "boolean",
          "example": true,
          "description": "Indicates that the topic is archived.",
          "x-workday-type": "Boolean"
        }
      }
    }
  ]
}

object businessProcessParameters_23782ad3f54110002073aab65def00fb

{
  "allOf": [
    {
      "$ref": "#/components/schemas/businessProcessParameters_2dcd9a4882b210000f7b2e0a85982265"
    },
    {}
  ],
  "description": "The Action Event instance to be used with businessProcessLinkable linked service representations."
}

object businessProcessParameters_2dcd9a4882b210000f7b2e0a85982265

{
  "allOf": [
    {
      "type": "object",
      "required": [
        "action"
      ],
      "properties": {
        "for": {
          "$ref": "#/components/schemas/for_5d688bd57bb910001815ab3dd10024a9"
        },
        "action": {
          "$ref": "#/components/schemas/action_38ff08ab6736100010816009079d0126"
        },
        "comment": {
          "type": "string",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "description": "Returns a null.",
          "x-workday-type": "Text"
        },
        "comments": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/comments_86093b8a932f10001499f356ff83012e"
          },
          "readOnly": true,
          "description": "Returns the comments for the current business process.",
          "x-workday-type": "Multi-instance"
        },
        "attachments": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/eventAttachmentsForToolbar_43b30ba735b8100011ee4767246d0143"
          },
          "description": "Returns attachments associated with this business process that are uploaded from the toolbar and are accessible to the processing person. Returns blank if either of these conditions are not met.",
          "x-workday-type": "Multi-instance"
        },
        "overallStatus": {
          "type": "string",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "readOnly": true,
          "description": "The current status of the business process.  For example: Successfully Completed, Denied, Terminated.",
          "x-workday-type": "Text"
        },
        "transactionStatus": {
          "$ref": "#/components/schemas/transactionStatus_7457adcbe0fa1000089b63ab3a510000"
        },
        "warningValidations": {
          "type": "string",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "readOnly": true,
          "description": "Warning message for an action event triggered by a condition.",
          "x-workday-type": "Text"
        },
        "criticalValidations": {
          "type": "string",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "readOnly": true,
          "description": "Validation message for an action event triggered by a condition.",
          "x-workday-type": "Text"
        },
        "overallBusinessProcess": {
          "$ref": "#/components/schemas/overallBusinessProcess_5d688bd57bb910001815ab49927724aa"
        }
      }
    }
  ]
}

object businessProcessParameters_5afc0b4b5a4610002aaebb8180cd2261

{
  "allOf": [
    {
      "$ref": "#/components/schemas/businessProcessParameters_2dcd9a4882b210000f7b2e0a85982265"
    },
    {}
  ],
  "description": "The Action Event instance to be used with businessProcessLinkable linked service representations."
}

object businessUnit_5aabf8e28cb310002520b2aabc470366

{
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {}
  ],
  "description": "The new business unit for the \\~worker\\~ as of the effective date.",
  "x-conditionally-hidden": true,
  "x-conditionally-required": true
}

object category_43b30ba735b8100011ee4781a9d50146

{
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {}
  ],
  "description": "Returns the category of a Business Process Attachment."
}

object changeJobAdditionalJobClassificationData_27ec818d10d0100003600115b5200102

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the instance"
        },
        "descriptor": {
          "type": "string",
          "example": "Lorem ipsum dolor sit ame",
          "description": "A preview of the instance"
        }
      }
    }
  ]
}

Load more schemas

Versions

Version	Endpoints	Schemas	Ingested	Status
v6	144	214	2026-05-18	current
v6	144	214	2026-04-16