openapi.city
Sign in

staffing

Workday staffing and workforce management API

community.workday.com/api ↗
Version
v6
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 11 endpoints

PATCH /jobChanges/{ID}/administrative/{subresourceID}

Partially updates the administrative options for the specified job change ID.
The {subResourceID} path parameter must be the same as the {ID} value.

You can call GET /jobChanges/{ID}/administrative/{subResourceID} to get the existing data to update.

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

Note that there are no localization constraints in this API version. You can update the workingFTE and paidFTE fields even if the fields have not been localized.

To retrieve a positionWorkerType ID, you can call the GET /values/jobChangesGroup/employeeTypes prompt endpoint, with staffingEvent and location query parameters. If you specify the staffingEvent parameter, it returns HREF links to employee types by country. By default, it returns all employee types, excluding contingent workers.

For the positionWorkerType ID, you can also call the GET /values/jobChangesGroup/contingentWorkerTypes prompt endpoint, with staffingEvent and location query parameters. If you specify the staffingEvent parameter, it returns HREF links to contingent worker types for staffing event. If you specify location, it returns HREF links to contingent worker types by location or country. By default, it returns all contingent worker types.

To retrieve a workersCompensationCodeOverride ID, call the GET /values/jobChangesGroup/workersCompensationCodeOverrides prompt endpoint, which takes the job change ID as the staffing Event query parameter.

To retrieve a payRateType ID, call the GET /values/jobChangesGroup/payRateTypes prompt endpoint, which takes the job change ID as the staffingEvent query parameter. It returns all pay rate types based on staffing event for contingent workers. By default, it returns all pay rate types in the tenant.

To retrieve companyInsiderType IDs, call the GET /values/jobChangesGroup/companyInsiderTypes prompt endpoint, which returns all company insider types in the tenant.

To retrieve an assignmentType ID, call the GET /values/jobChangesGroup/assignmentTypes prompt endpoint, which takes the job change ID as the staffingEvent query parameter. If you specify the staffingEvent parameter, it returns assignmentTypes for the staffingEvent. By default, it returns all active assignment types.

To retrieve a workStudy ID, call the GET /values/jobChangesGroup/workStudyAwards prompt endpoint, which takes the job change ID as the staffingEvent query parameter. If you specify the staffingEvent parameter, it returns work study awards for the staffingEvent. By default, it returns all work studies in the tenant.

To retrieve a timeType ID, call the GET /values/jobChangesGroup/timeTypes prompt endpoint, which takes the job change ID as the staffingEvent query parameter. If you specify the staffingEvent parameter, it returns time types for the staffingEvent. By default, it returns all time types based on the Relax Hiring Restrictions tenant configuration.

Secured by: Staffing Actions: Administrator

Scope: Staffing

operationId: JobChanges_updateAdministrativeOptions

Parameters

Name In Required Type Description
ID path required string

The Workday ID of the resource.
subresourceID path required string

The Workday ID of the subresource.

Request Body

required
application/json
schema changeJobAdministrativeDetailsData_f8f20079bc5a1000089ccb7f6a8800ea
Property Type Required
fte integer optional
paidFte integer optional
notifyBy string optional
timeType object optional
└ id string required
└ href string optional
└ descriptor string optional
workStudy object optional
└ id string required
└ href string optional
└ descriptor string optional
workingFte integer optional
payRateType object optional
└ id string required
└ href string optional
└ descriptor string optional
assignmentType object optional
└ id string required
└ href string optional
└ descriptor string optional
firstDayOfWork string optional
specifyPaidFte boolean optional
endEmploymentDate string optional
specifyWorkingFte boolean optional
defaultWeeklyHours integer optional
positionWorkerType object optional
└ id string required
└ href string optional
└ descriptor string optional
companyInsiderTypes array optional
└ id string optional
└ descriptor string optional
expectedAssignmentEndDate string optional
workersCompensationCodeOverride object optional
└ id string required
└ href string optional
└ descriptor string optional

Responses

default

An error occurred.
200

Successful response. A successful response can return no matched data. Updating resource.
400

Invalid request. (https://community.workday.com/rest/error-messages)
Error Code | Validation Message
— | —
A368 | This operation is only available to the person who initiated the Change Job operation.
A403 | Submit this operation before the event Initiation step.
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)
PATCH /jobChanges/{ID}/administrative/{subresourceID}
PATCH /jobChanges/{ID}/businessTitle/{subresourceID}

Partially updates the businessTitle options for the specified change job ID.

The {subResourceID} path parameter must be the same as the {ID} value.

You can call GET /jobChanges/{ID}/businessTitle/{subResourceID} to get the existing data to update.

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

Secured by: Staffing Actions: Business Title

Scope: Staffing

operationId: JobChanges_updateBusinessTitleOptions

Parameters

Name In Required Type Description
ID path required string

The Workday ID of the resource.
subresourceID path required string

The Workday ID of the subresource.

Request Body

required
application/json
schema changeJobBusinessTitle_3db8095ffa18100013a5f96969ca0102
Property Type Required
businessTitle string optional

Responses

default

An error occurred.
200

Successful response. A successful response can return no matched data. Updating resource.
400

Invalid request. (https://community.workday.com/rest/error-messages)
Error Code | Validation Message
— | —
A368 | This operation is only available to the person who initiated the Change Job operation.
A403 | Submit this operation before the event Initiation step.
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)
PATCH /jobChanges/{ID}/businessTitle/{subresourceID}
PATCH /jobChanges/{ID}/comment/{subresourceID}

Updates the comment for the specified change job ID.
The {subResourceID} path parameter must be the same as the {ID} value.

The data updates in this PATCH method do not persist until you call POST /jobChanges/{ID}/submit.

You can call GET /jobChanges/{ID}/comment/{subResourceID} to get the existing data to update.

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

Scope: Staffing

operationId: JobChanges_updateComment

Parameters

Name In Required Type Description
ID path required string

The Workday ID of the resource.
subresourceID path required string

The Workday ID of the subresource.

Request Body

application/json
schema comments_7d98fd55aeee100022968e52a1b31c60
Property Type Required
comment string optional

Responses

default

An error occurred.
200

Successful response. A successful response can return no matched data. Updating resource.
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)
PATCH /jobChanges/{ID}/comment/{subresourceID}
PATCH /jobChanges/{ID}/contract/{subresourceID}

Partially updates the contract details options for the specified job change ID.
The {subResourceID} path parameter must be the same as the {ID} value.

You can call GET /jobChanges/{ID}/contract/{subResourceID} to get the existing data to update.

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

To retrieve a frequency ID, call the GET /values/jobChangesGroup/frequencies prompt endpoint, which takes the job change ID as the staffingEvent query parameter. It returns all frequencies based on staffing event for contingent workers. By default, it returns all frequencies in the tenant.

To retrieve a currency ID, call the GET /values/jobChangesGroup/currencies prompt endpoint, which takes the job change ID as the staffingEvent query parameter. If you specify the staffingEvent parameter, it returns HREF links to active currencies by prompt category. By default, it returns all active currencies.

Secured by: Staffing Actions: Contract Details

Scope: Staffing

operationId: JobChanges_partiallyUpdateContractOptions

Parameters

Name In Required Type Description
ID path required string

The Workday ID of the resource.
subresourceID path required string

The Workday ID of the subresource.

Request Body

required
application/json
schema changeJobContractDetailsData_27ec818d10d010000386ce823ac20107
Property Type Required
currency object optional
└ id string required
└ href string optional
└ descriptor string optional
frequency object optional
└ id string required
└ href string optional
└ descriptor string optional
purchaseOrder object optional
└ id string required
└ href string optional
└ descriptor string optional
contractEndDate string optional
contractPayRate object optional
assignmentDetails string optional

Responses

default

An error occurred.
200

Successful response. A successful response can return no matched data. Updating resource.
400

Invalid request. (https://community.workday.com/rest/error-messages)
Error Code | Validation Message
— | —
A368 | This operation is only available to the person who initiated the Change Job operation.
A403 | Submit this operation before the event Initiation step.
A425 | You can’t submit this operation on events that are in the Initiation or Review by Current ~Manager~ steps.
A440 | You can’t submit this operation on events that are initiated by the Change Location task.
A451 | The Contract section is only available on ~contingent workers~. You can’t submit this operation on an ~employee~.
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)
PATCH /jobChanges/{ID}/contract/{subresourceID}
PATCH /jobChanges/{ID}/jobClassification/{subresourceID}

Partially updates the job classifications for the specified job change ID.
The {subResourceID} path parameter must be the same as the {ID} value.

You can call GET /jobChanges/{ID}/jobClassification/{subResourceID} to get the existing data to update.

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

In the request body, specify at least this required field: additionalJobClassifications[ {id} ].

To retrieve an additionalJobClassifications ID, call the GET /values/jobChangesGroup/jobClassifications prompt endpoint with the location and/or staffingEvent query parameter. It returns HREF links to job classifications by location for the staffing event. It returns an empty result if both location and staffingEvent are not specified. You can filter the results by effectiveDate. By default, it returns job classifications on the current date.

Secured by: Staffing Actions: Additional Job Classifications

Scope: Staffing

operationId: JobChanges_updateJobClassificationOptions

Parameters

Name In Required Type Description
ID path required string

The Workday ID of the resource.
subresourceID path required string

The Workday ID of the subresource.

Request Body

required
application/json
schema changeJobJobClassificationData_354103f196361000084489bcb281017f
Property Type Required
additionalJobClassifications array optional
└ id string optional
└ descriptor string optional

Responses

default

An error occurred.
200

Successful response. A successful response can return no matched data. Updating resource.
400

Invalid request. (https://community.workday.com/rest/error-messages)
Error Code | Validation Message
— | —
A368 | This operation is only available to the person who initiated the Change Job operation.
A403 | Submit this operation before the event Initiation step.
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)
PATCH /jobChanges/{ID}/jobClassification/{subresourceID}
PATCH /jobChanges/{ID}/jobProfile/{subresourceID}

Partially updates the job profile options for the specified job change ID.

The {subResourceID} path parameter must be the same as the {ID} value.

You can call GET /jobChanges/{ID}/jobProfile/{subResourceID} to get the existing data to update.

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

In the request body, specify at least this required field: jobProfile{id}

To retrieve a jobProfile ID, call the GET /values/jobChangesGroup/jobProfiles prompt endpoint, which takes the job change ID as the staffingEvent query parameter. If you specify the staffingEvent parameter, it returns HREF links to the job profiles by the prompt category. If you don’t specify the staffingEvent parameter, it returns all job profiles, regardless of their categories. You can also filter the job profiles by the effectiveDate query parameter. The default is the current date.

Secured by: Staffing Actions: Job Profile

Scope: Staffing

operationId: JobChanges_updateJobProfileOptions

Parameters

Name In Required Type Description
ID path required string

The Workday ID of the resource.
subresourceID path required string

The Workday ID of the subresource.

Request Body

required
application/json
schema changeJobJobProfileData_3db8095ffa18100013f019a27a1f0115
Property Type Required
jobTitle string optional
jobProfile object optional
└ id string required
└ href string optional
└ descriptor string optional

Responses

default

An error occurred.
200

Successful response. A successful response can return no matched data. Updating resource.
400

Invalid request. (https://community.workday.com/rest/error-messages)
Error Code | Validation Message
— | —
A368 | This operation is only available to the person who initiated the Change Job operation.
A403 | Submit this operation before the event Initiation step.
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)
PATCH /jobChanges/{ID}/jobProfile/{subresourceID}
PATCH /jobChanges/{ID}/location/{subresourceID}

Partially updates the location options for the specified job change ID.
The {subResourceID} path parameter must be the same as the {ID} value.

You can call GET /jobChanges/{ID}/location/{subResourceID} to get the existing data to update.

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

In the request body, specify at least this request field: location{id}.

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

To retrieve a workShift ID, call the GET /values/jobChangesGroup/workShifts prompt endpoint with the location query parameter. It returns work shifts by location. If you don’t specify the location parameter, it returns an empty result.

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

Secured by: Staffing Actions: Location

Scope: Staffing

operationId: JobChanges_partialUpdateLocationOptions

Parameters

Name In Required Type Description
ID path required string

The Workday ID of the resource.
subresourceID path required string

The Workday ID of the subresource.

Request Body

required
application/json
schema changeJobLocation_90151d6c4ff110001b4a46091678025c
Property Type Required
location object optional
└ id string required
└ href string optional
└ descriptor string optional
workShift object optional
└ id string required
└ href string optional
└ descriptor string optional
workSpace object optional
└ id string required
└ href string optional
└ descriptor string optional
scheduledHours integer optional

Responses

default

An error occurred.
200

Successful response. A successful response can return no matched data. Updating resource.
400

Invalid request. (https://community.workday.com/rest/error-messages)
Error Code | Validation Message
— | —
A368 | This operation is only available to the person who initiated the Change Job operation.
A401 | [Invalid In Progress Work Space Change]
A403 | Submit this operation before the event Initiation step.
A443 | [Invalid Complete Work Space Change]
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)
PATCH /jobChanges/{ID}/location/{subresourceID}
PATCH /jobChanges/{ID}/moveTeam/{subresourceID}

Partially updates the moveTeam options for the specified change job ID.

The {subResourceID} path parameter must be the same as the {ID} value.

You can call GET /jobChanges/{ID}/moveTeam/{subResourceID} to get the existing data to update.

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

Secured by: Staffing Actions: Move Manager’s Team

Scope: Staffing

operationId: JobChanges_updateMoveTeamOptions

Parameters

Name In Required Type Description
ID path required string

The Workday ID of the resource.
subresourceID path required string

The Workday ID of the subresource.

Request Body

required
application/json
schema changeJobMoveTeamData_544fdf5c01da1000238ad82d26d90146
Property Type Required
moveTeam boolean optional

Responses

default

An error occurred.
200

Successful response. A successful response can return no matched data. Updating resource.
400

Invalid request. (https://community.workday.com/rest/error-messages)
Error Code | Validation Message
— | —
A368 | This operation is only available to the person who initiated the Change Job operation.
A369 | You can only submit the Move Team operation on ~managers~ who change supervisory organizations.
A403 | Submit this operation before the event Initiation step.
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)
PATCH /jobChanges/{ID}/moveTeam/{subresourceID}
PATCH /jobChanges/{ID}/opening/{subresourceID}

Partially updates the opening options for the specified job change ID.
The {subResourceID} path parameter must be the same as the {ID} value.

You can call GET /jobChanges/{ID}/opening/{subResourceID} to get the existing data to update.

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

In the request body, specify at least this required field: headcountOption{id}

To retrieve a headcountOption ID, call the GET /values/jobChangesGroup/headcountOptions prompt endpoint, which takes the job change ID as the staffingEvent query parameter. By default, it returns all headcount options.

Secured by: Staffing Actions: Change Job Date and Reason

Scope: Staffing

operationId: JobChanges_updateOpeningOptions

Parameters

Name In Required Type Description
ID path required string

The Workday ID of the resource.
subresourceID path required string

The Workday ID of the subresource.

Request Body

required
application/json
schema changeJobOpeningData_97af9049a5fd10001c4888d654170000
Property Type Required
id string optional
descriptor string optional
headcountOption object optional
└ id string required
└ href string optional
└ descriptor string optional
openingAvailableForOverlap boolean optional

Responses

default

An error occurred.
200

Successful response. A successful response can return no matched data. Updating resource.
400

Invalid request. (https://community.workday.com/rest/error-messages)
Error Code | Validation Message
— | —
A368 | This operation is only available to the person who initiated the Change Job operation.
A403 | Submit this operation before the event Initiation step.
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)
PATCH /jobChanges/{ID}/opening/{subresourceID}
PATCH /jobChanges/{ID}/position/{subresourceID}

Partially updates the position options for the specified job change ID.
The {subResourceID} path parameter must be the same as the {ID} value.

You can call GET /jobChanges/{ID}/startDetails/{subResourceID} to get the existing data to update.

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

In the request body, specify at least these request fields: position{id}, createPosition, closePosition, availableForOverlap

To retrieve a position ID, call the GET /values/jobChangesGroup/proposedPosition prompt endpoint, which takes the job change ID as the staffingEvent query parameter. It returns HREF links to proposed positions based on staffing event for contingent workers. You can filter the results by effectiveDate. By default, it returns all proposed positions on current date.

Secured by: Staffing Actions: Select or Create Position

Scope: Staffing

operationId: JobChanges_updatePositionOptions

Parameters

Name In Required Type Description
ID path required string

The Workday ID of the resource.
subresourceID path required string

The Workday ID of the subresource.

Request Body

required
application/json
schema changeJobPositionData_dfc4e58f7308100018bd1c459f435221
Property Type Required
id string optional
position object optional
└ id string required
└ href string optional
└ descriptor string optional
descriptor string optional
closePosition boolean optional
createPosition boolean optional
jobRequisition object optional
└ id string required
└ href string optional
└ descriptor string optional
availableForOverlap boolean optional

Responses

default

An error occurred.
200

Successful response. A successful response can return no matched data. Updating resource.
400

Invalid request. (https://community.workday.com/rest/error-messages)
Error Code | Validation Message
— | —
A368 | This operation is only available to the person who initiated the Change Job operation.
A396 | You can’t close a position that’s currently filled. Submit a different position or submit a false value on the Close Position field.
A402 | Proposed Position is Required or Create Position must be selected.
A403 | Submit this operation before the event Initiation step.
A412 | You can’t submit Position section operations on this Change Job.
A432 | You can only propose a position if the Create Position field is false. Submit a false value on Create Position.
A945 | Set either the Close Position or Job Overlap Allowed field to True, but not both.
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)
PATCH /jobChanges/{ID}/position/{subresourceID}
PATCH /jobChanges/{ID}/startDetails/{subresourceID}

Partially updates the start details for the specified job change ID.
The {subResourceID} path parameter must be the same as the {ID} value.

You can call GET /jobChanges/{ID}/startDetails/{subResourceID} to get the existing data to update.

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

In the request body, specify at least these request fields: date, reason{id}.

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.

Secured by: Staffing Actions: Change Job Date and Reason

Scope: Staffing

operationId: JobChanges_updateStartDetails

Parameters

Name In Required Type Description
ID path required string

The Workday ID of the resource.
subresourceID path required string

The Workday ID of the subresource.

Request Body

required
application/json
schema jobChangesStartDetailsData_ce861a6a360d10002d40f176b7180020
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
worker 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
useNextPayPeriod boolean optional
supervisoryOrganization object optional
└ id string required
└ href string optional
└ descriptor string optional

Responses

default

An error occurred.
200

Successful response. A successful response can return no matched data. Updating resource.
400

Invalid request. (https://community.workday.com/rest/error-messages)
Error Code | Validation Message
— | —
A368 | This operation is only available to the person who initiated the Change Job operation.
A390 | You cannot run this task on yourself.
A391 | Enter a date that is after [lastUpdatedDate], the date the position was last updated.
A403 | Submit this operation before the event Initiation step.
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.
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]
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)
PATCH /jobChanges/{ID}/startDetails/{subresourceID}

Organizationassignmentchanges 8 endpoints

PATCH /organizationAssignmentChanges/{ID}/businessUnit/{subresourceID}

Partially updates the business unit option for the specified change organization assignment ID.
The {subResourceID} path parameter must be the same as the {ID} value.

You can call GET /organizationAssignmentChanges/{ID}/businessUnit/{subResourceID} to get the existing data to update.

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

In the request body, specify the Workday ID of the business unit.

To retrieve a businessUnit ID, call the GET /values/organizationAssignmentChangesGroup/businessUnit prompt endpoint, which takes the change organization assignment ID as the event query parameter. If you specify the event parameter, it returns HREF links to the business units by organization, as of the event’s effective date. If you don’t specify the event parameter, it returns HREF links to the business units by active organization based on the current date.

Secured by: Staffing Organizations: Business Unit

Scope: Staffing

operationId: OrganizationAssignmentChanges_updateBusinessUnit

Parameters

Name In Required Type Description
ID path required string

The Workday ID of the resource.
subresourceID path required string

The Workday ID of the subresource.

Request Body

required
application/json
schema organizationAssignmentChangesBusinessUnitData_5aabf8e28cb310002520b2a2b31d0365
Property Type Required
businessUnit object optional
└ id string required
└ href string optional
└ descriptor string optional

Responses

default

An error occurred.
200

Successful response. A successful response can return no matched data. Updating resource.
400

Invalid request. (https://community.workday.com/rest/error-messages)
Error Code | Validation Message
— | —
A403 | Submit this operation before the event Initiation step.
A499 | This operation is only available to the person who initiated the Change Organization Assignment operation.
A1599 | [You can’t select Staff because it will override the existing Organization Type 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]
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)
PATCH /organizationAssignmentChanges/{ID}/businessUnit/{subresourceID}
PATCH /organizationAssignmentChanges/{ID}/comment/{subresourceID}

Partially updates the comment for the organization assignment change ID.
The {subResourceID} path parameter must be the same as the {ID} value.

The data updates in this PATCH method don’t persist until you call POST/organizationAssignmentChanges/{ID}/submit.

To get the exising data to update, call GET/organizationAssignmentChanges/{ID}/comment/{subResourceID}.

Secured by: Change Organization Assignment (REST), Change Organization Assignments for ~Worker~ (Mass Action)

Scope: Organizations and Roles

operationId: OrganizationAssignmentChanges_updateComment

Parameters

Name In Required Type Description
ID path required string

The Workday ID of the resource.
subresourceID path required string

The Workday ID of the subresource.

Request Body

application/json
schema comments_7d98fd55aeee100022968e52a1b31c60
Property Type Required
comment string optional

Responses

default

An error occurred.
200

Successful response. A successful response can return no matched data. Updating resource.
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)
PATCH /organizationAssignmentChanges/{ID}/comment/{subresourceID}
PATCH /organizationAssignmentChanges/{ID}/company/{subresourceID}

Partially updates the company for the specified organization assignment change ID.
The {subResourceID} path parameter must be the same as the {ID} value.

You can call GET /organizationAssignmentChanges/{ID}/company/{subResourceID} to get the existing data to update.

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

In the request body, specify the Workday ID of the company.

To retrieve a companies ID, call the GET /values/organizationAssignmentChangesGroup/companies prompt endpoint, which takes the change organization assignment ID as the event query parameter. If you specify the event parameter, it returns HREF links to the companies by organization, as of the event’s effective date. If you don’t specify the event parameter, it returns HREF links to the companies by active organization based on the current date.

Secured by: Staffing Organizations: Company

Scope: Staffing

operationId: OrganizationAssignmentChanges_partiallyUpdateCompany

Parameters

Name In Required Type Description
ID path required string

The Workday ID of the resource.
subresourceID path required string

The Workday ID of the subresource.

Request Body

required
application/json
schema organizationAssignmentChangesCompanyData_652d516fdff41000086e0b9c96950354
Property Type Required
company object optional
└ id string required
└ href string optional
└ descriptor string optional

Responses

default

An error occurred.
200

Successful response. A successful response can return no matched data. Updating resource.
400

Invalid request. (https://community.workday.com/rest/error-messages)
Error Code | Validation Message
— | —
A403 | Submit this operation before the event Initiation step.
A499 | This operation is only available to the person who initiated the Change Organization Assignment operation.
A1593 | [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.]
A1594 | [The changes you have 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.]
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)
PATCH /organizationAssignmentChanges/{ID}/company/{subresourceID}
PATCH /organizationAssignmentChanges/{ID}/costCenter/{subresourceID}

Partially updates the cost center for the specified organization assignment change ID.
The {subResourceID} path parameter must be the same as the {ID} value.

You can call GET /organizationAssignmentChanges/{ID}/costCenter/{subResourceID} to get the existing data to update.

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

In the request body, specify the Workday ID of the cost center.

To retrieve a costCenter ID, call the GET /values/organizationAssignmentChangesGroup/costCenters prompt endpoint, which takes the change organization assignment ID as the event query parameter. If you specify the event parameter, it returns HREF links to the cost centers by organization, as of the event’s effective date. If you don’t specify the event parameter, it returns HREF links to the cost centers by active organization based on the current date.

Secured by: Staffing Organizations: Cost Center

Scope: Staffing

operationId: OrganizationAssignmentChanges_updateCostCenter

Parameters

Name In Required Type Description
ID path required string

The Workday ID of the resource.
subresourceID path required string

The Workday ID of the subresource.

Request Body

required
application/json
schema organizationAssignmentChangesCostCenterData_5aabf8e28cb3100010a999db2700024e
Property Type Required
costCenter object optional
└ id string required
└ href string optional
└ descriptor string optional

Responses

default

An error occurred.
200

Successful response. A successful response can return no matched data. Updating resource.
400

Invalid request. (https://community.workday.com/rest/error-messages)
Error Code | Validation Message
— | —
A403 | Submit this operation before the event Initiation step.
A499 | This operation is only available to the person who initiated the Change Organization Assignment operation.
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]
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]
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)
PATCH /organizationAssignmentChanges/{ID}/costCenter/{subresourceID}
PATCH /organizationAssignmentChanges/{ID}/costing/{subresourceID}

Partially updates the costing organizations for the specified organization assignment change ID. Costing organizations include: Grants, Funds, Programs, and Gifts.
The {subResourceID} path parameter must be the same as the {ID} value.

You can call GET /organizationAssignmentChanges/{ID}/costing/{subResourceID} to get the existing data to update.

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

In the request body, specify the Workday ID of the grant, program, gift, or fund you want to update.

To retrieve a grants ID, call the GET /values/organizationAssignmentChangesGroup/grants prompt endpoint, which takes the change organization assignment ID as the event query parameter. If you specify the event parameter, it returns HREF links to the grants by organization, as of the event’s effective date. If you don’t specify the event parameter, it returns HREF links to the grants by active organization based on the current date.

To retrieve a funds ID, call the GET /values/organizationAssignmentChangesGroup/funds prompt endpoint, which takes the change organization assignment ID as the event query parameter. If you specify the event parameter, it returns HREF links to the funds by organization, as of the event’s effective date. If you don’t specify the event parameter, it returns HREF links to the funds by active organization based on the current date.

To retrieve a programs ID, call the GET /values/organizationAssignmentChangesGroup/programs prompt endpoint, which takes the change organization assignment ID as the event query parameter. If you specify the event parameter, it returns HREF links to the programs by organization, as of the event’s effective date. If you don’t specify the event parameter, it returns HREF links to the programs by active organization based on the current date.

To retrieve a gifts ID, call the GET /values/organizationAssignmentChangesGroup/gifts prompt endpoint, which takes the change organization assignment ID as the event query parameter. If you specify the event parameter, it returns HREF links to the gifts by organization, as of the event’s effective date. If you don’t specify the event parameter, it returns HREF links to the gifts by active organization based on the current date.

Secured by: Staffing Organizations: Grant, Fund, Program, Gift

Scope: Staffing

operationId: OrganizationAssignmentChanges_partiallyUpdateCostingOptions

Parameters

Name In Required Type Description
ID path required string

The Workday ID of the resource.
subresourceID path required string

The Workday ID of the subresource.

Request Body

required
application/json
schema organizationAssignmentChangesCostingData_a18edb56aca0100014a4a09dc57e045a
Property Type Required
fund object optional
└ id string required
└ href string optional
└ descriptor string optional
gift object optional
└ id string required
└ href string optional
└ descriptor string optional
grant object optional
└ id string required
└ href string optional
└ descriptor string optional
program object optional
└ id string required
└ href string optional
└ descriptor string optional

Responses

default

An error occurred.
200

Successful response. A successful response can return no matched data. Updating resource.
400

Invalid request. (https://community.workday.com/rest/error-messages)
Error Code | Validation Message
— | —
A403 | Submit this operation before the event Initiation step.
A499 | This operation is only available to the person who initiated the Change Organization Assignment operation.
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]
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]
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)
PATCH /organizationAssignmentChanges/{ID}/costing/{subresourceID}
PATCH /organizationAssignmentChanges/{ID}/customOrganizations/{subresourceID}

Partially updates the custom organizations for the specified organization assignment change ID.
The {subResourceID} path parameter must be the same as the {ID} value.

You can call GET /organizationAssignmentChanges/{ID}/customorganization/{subResourceID} to get the existing data to update.

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

In the request body, specify the Workday ID of the custom organization {id}

To retrieve a custom organization ID, call the GET /values/organizationAssignmentChangesGroup/customs prompt endpoint, which takes the change organization assignment ID as the event query parameter. If you specify the event parameter, it returns HREF links to the custom organizations, as of the event’s effective date. If you don’t specify the event parameter, it returns HREF links to the active custom organizations based on the current date.

Secured by: Staffing Organizations: Custom Organization

Scope: Staffing

operationId: OrganizationAssignmentChanges_updateCustomOrganizations

Parameters

Name In Required Type Description
ID path required string

The Workday ID of the resource.
subresourceID path required string

The Workday ID of the subresource.

Request Body

required
application/json
schema organizationAssignmentChangesCustomOrganizationDetailsData_53cd2b632146100011e9bf4e7041551f
Property Type Required
customOrganizations array optional
└ id string optional
└ descriptor string optional
└ organizationType object optional
└ id string required
└ href string optional
└ descriptor string optional

Responses

default

An error occurred.
200

Successful response. A successful response can return no matched data. Updating resource.
400

Invalid request. (https://community.workday.com/rest/error-messages)
Error Code | Validation Message
— | —
A403 | Submit this operation before the event Initiation step.
A499 | This operation is only available to the person who initiated the Change Organization Assignment operation.
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].
A542 | Submit at least 1 custom organization for these organization types: [orgTypesInvalid].
A1592 | [You can’t select list of custom orgs because it will override the existing organizations 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]
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.]
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)
PATCH /organizationAssignmentChanges/{ID}/customOrganizations/{subresourceID}
PATCH /organizationAssignmentChanges/{ID}/region/{subresourceID}

Partially updates the region for the specified organization assignment change ID.

The {subResourceID} path parameter must be the same as the {ID} value.

In the request body, specify the Workday ID of the region.

To retrieve a regions ID, call the GET /values/organizationAssignmentChangesGroup/regions prompt endpoint, which takes the change organization assignment ID as the event query parameter. If you specify the event parameter, it returns HREF links to the regions by organization, as of the event’s effective date. If you don’t specify the event parameter, it returns HREF links to the regions by active organization based on the current date.

Secured by: Staffing Organizations: Region

Scope: Staffing

operationId: OrganizationAssignmentChanges_updateRegion

Parameters

Name In Required Type Description
ID path required string

The Workday ID of the resource.
subresourceID path required string

The Workday ID of the subresource.

Request Body

required
application/json
schema organizationAssignmentChangesRegionData_a18edb56aca0100006997e68e5780373
Property Type Required
region object optional
└ id string required
└ href string optional
└ descriptor string optional

Responses

default

An error occurred.
200

Successful response. A successful response can return no matched data. Updating resource.
400

Invalid request. (https://community.workday.com/rest/error-messages)
Error Code | Validation Message
— | —
A403 | Submit this operation before the event Initiation step.
A499 | This operation is only available to the person who initiated the Change Organization Assignment operation.
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]
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]
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)
PATCH /organizationAssignmentChanges/{ID}/region/{subresourceID}
PATCH /organizationAssignmentChanges/{ID}/startDetails/{subresourceID}

Partially updates the start details for the specified organization assignment change ID.
The {subResourceID} path parameter must be the same as the {ID} value.

In the request body, specify the effective date for the event.

You can call GET /organizationAssignmentChanges/{ID}/startDetails/{subResourceID} to get the existing data to update.

You can only update the date field once the event is initiated. These fields are read-only: worker, supervisoryOrganization, and position.

The same Workday UI validations apply with this PATCH method.

The updates in this PATCH method do not persist until you call POST /organizationAssignmentChanges/{ID}/submit.

Secured by: Staffing Organizations: Header

Scope: Staffing

operationId: OrganizationAssignmentChanges_partiallyUpdateStartDetails

Parameters

Name In Required Type Description
ID path required string

The Workday ID of the resource.
subresourceID path required string

The Workday ID of the subresource.

Request Body

required
application/json
schema organizationAssignmentChangesStartDetailsData_90009f2bfc49100017b10cd07d19063b
Property Type Required
date string optional
worker object optional
└ id string required
└ href string optional
└ descriptor string optional
position object required
└ id string required
└ href string optional
└ descriptor string optional
supervisoryOrganization object optional
└ id string required
└ href string optional
└ descriptor string optional

Responses

default

An error occurred.
200

Successful response. A successful response can return no matched data. Updating resource.
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.
A394 | Enter an Effective Date that is on or after the hire date for the ~worker~: [date].
A403 | Submit this operation before the event Initiation step.
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.
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].
A516 | This position will be vacated or closed as of the effective date. Organization assignments cannot be made.
A531 | Select an Effective Date that is on or after the move date: [date].
A1546 | [Complete or cancel all pending actions for worker before initiating this action]
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)
PATCH /organizationAssignmentChanges/{ID}/startDetails/{subresourceID}

Workers 4 endpoints

PATCH /workers/{ID}/checkInTopics/{subresourceID}

Partially updates an existing Check-In topic instance with the specified ID and the specified data in the request body (name, privateNotes, sharedNotes, checkInTopicAttachments, or associatedCheckIns). This can only be done by the creator or participant of the Check-In.

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

Secured by: Self-Service: Check-Ins

Scope: Performance Enablement

Contains attachment(s)

operationId: Workers_partiallyUpdateCheckInTopic

Parameters

Name In Required Type Description
ID path required string

The Workday ID of the resource.
subresourceID path required string

The Workday ID of the subresource.

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.
200

Successful response. A successful response can return no matched data. Updating file.
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 modify an archived Check-In topic.
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)
PATCH /workers/{ID}/checkInTopics/{subresourceID}
PATCH /workers/{ID}/checkInTopics/{subresourceID}?type=archive

Partially updates an existing Check-In topic instance with the specified ID and the specified data in the request body (archive). This can only be done by the creator or participant of the Check-In.

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

Secured by: Self-Service: Check-Ins, Worker Data: Check-Ins

Scope: Performance Enablement

operationId: Workers_updateCheckInTopicState

Parameters

Name In Required Type Description
ID path required string

The Workday ID of the resource.
subresourceID path required string

The Workday ID of the subresource.

Request Body

required
application/json
schema checkInTopicArchiveDetail_1163fe23102e10001f72d77b213401a2
Property Type Required
id string optional
archive boolean required
descriptor string optional

Responses

default

An error occurred.
200

Successful response. A successful response can return no matched data. Updating resource.
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)
PATCH /workers/{ID}/checkInTopics/{subresourceID}?type=archive
PATCH /workers/{ID}/checkIns/{subresourceID}

Partially updates an existing Check-In instance with the specified ID and the specified data in the request body (date, description, or associated topics). This can only be done by the creator or participant of the Check-In.

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

Secured by: Self-Service: Check-Ins

Scope: Performance Enablement

Contains attachment(s)

operationId: Workers_updateCheckIn

Parameters

Name In Required Type Description
ID path required string

The Workday ID of the resource.
subresourceID path required string

The Workday ID of the subresource.

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.
200

Successful response. A successful response can return no matched data. Updating file.
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 include Check-In Topics that have a different participant.
A161 | You can’t modify an archived Check-In.
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)
PATCH /workers/{ID}/checkIns/{subresourceID}
PATCH /workers/{ID}/checkIns/{subresourceID}?type=archive

Partially updates an existing Check-In instance with the specified ID and the specified data in the request body (archive). This can only be done by the creator or participant of the Check-In.

This endpoint is equivalent to the Archive Check-Ins task in Workday.

Secured by: Self-Service: Check-Ins, Worker Data: Check-Ins

Scope: Performance Enablement

operationId: Workers_partiallyUpdateCheckIn

Parameters

Name In Required Type Description
ID path required string

The Workday ID of the resource.
subresourceID path required string

The Workday ID of the subresource.

Request Body

required
application/json
schema checkInArchiveDetail_1163fe23102e10001df342088f8a018e
Property Type Required
id string optional
archive boolean required
descriptor string optional

Responses

default

An error occurred.
200

Successful response. A successful response can return no matched data. Updating resource.
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)
PATCH /workers/{ID}/checkIns/{subresourceID}?type=archive
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