Query structured spec data via REST or MCP. Get exactly what your agent needs.
https://<tenantHostname>/staffing/v6
/jobChanges/{ID}
Retrieves a change job event with the specified ID.
Secured by: Change Job (Mass Action), Change Job (REST Service), Staffing Actions, Staffing Actions: Academic Pay, Staffing Actions: Additional Job Classifications, Staffing Actions: Administrator, Staffing Actions: Attachments, Staffing Actions: Business Title, Staffing Actions: Change Job Date and Reason, Staffing Actions: Compensation for All Job Profiles, Staffing Actions: Contract Details, Staffing Actions: Hire Student, Staffing Actions: Job Profile, Staffing Actions: View ~Worker~ Start Date Correction
Scope: Staffing
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| ID | path | required | string | The Workday ID of the resource. |
An error occurred.
Successful response. A successful response can return no matched data.
Invalid request. (https://community.workday.com/rest/error-messages)
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
GET /jobChanges/{ID}
/jobChanges/{ID}/administrative
Retrieves the administrative options for the specified job change ID.
The {subResourceID} path parameter must be the same as the {ID} value.
Note that there are no localization constraints in this API version. This method returns the workingFTE and paidFTE fields even if the fields have not been localized.
Secured by: Staffing Actions: Administrator
Scope: Staffing
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| ID | path | required | string | The Workday ID of the resource. |
| limit | query | optional | integer | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
| offset | query | optional | integer | The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object. |
An error occurred.
Successful response. A successful response can return no matched data.
Invalid request. (https://community.workday.com/rest/error-messages)
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
GET /jobChanges/{ID}/administrative
/jobChanges/{ID}/administrative/{subresourceID}
Retrieves the administrative options for the specified job change ID.
The {subResourceID} path parameter must be the same as the {ID} value.
Note that there are no localization constraints in this API version. This method returns the workingFTE and paidFTE fields even if the fields have not been localized.
Secured by: Staffing Actions: Administrator
Scope: Staffing
| 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. |
An error occurred.
Successful response. A successful response can return no matched data.
Invalid request. (https://community.workday.com/rest/error-messages)
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
GET /jobChanges/{ID}/administrative/{subresourceID}
/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
| 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. |
application/json
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 |
An error occurred.
Successful response. A successful response can return no matched data. Updating resource.
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.]
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
PATCH /jobChanges/{ID}/administrative/{subresourceID}
/jobChanges/{ID}/businessTitle
Retrieves a business title for the specified specified job change ID.
The {subResourceID} path parameter must be the same as the {ID} value.
Secured by: Staffing Actions: Business Title
Scope: Staffing
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| ID | path | required | string | The Workday ID of the resource. |
| limit | query | optional | integer | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
| offset | query | optional | integer | The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object. |
An error occurred.
Successful response. A successful response can return no matched data.
Invalid request. (https://community.workday.com/rest/error-messages)
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
GET /jobChanges/{ID}/businessTitle
/jobChanges/{ID}/businessTitle/{subresourceID}
Retrieves a business title for the specified specified job change ID.
The {subResourceID} path parameter must be the same as the {ID} value.
Secured by: Staffing Actions: Business Title
Scope: Staffing
| 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. |
An error occurred.
Successful response. A successful response can return no matched data.
Invalid request. (https://community.workday.com/rest/error-messages)
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
GET /jobChanges/{ID}/businessTitle/{subresourceID}
/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
| 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. |
application/json
changeJobBusinessTitle_3db8095ffa18100013a5f96969ca0102
| Property | Type | Required |
|---|---|---|
| businessTitle | string | optional |
An error occurred.
Successful response. A successful response can return no matched data. Updating resource.
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.
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
PATCH /jobChanges/{ID}/businessTitle/{subresourceID}
/jobChanges/{ID}/comment
Returns the comment information for the specified job change ID.
The {subResourceID} path parameter must be the same as the {ID} value.
Secured by: Change Job (Mass Action), Change Job (REST Service)
Scope: Staffing
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| ID | path | required | string | The Workday ID of the resource. |
| limit | query | optional | integer | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
| offset | query | optional | integer | The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object. |
An error occurred.
Successful response. A successful response can return no matched data.
Invalid request. (https://community.workday.com/rest/error-messages)
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
GET /jobChanges/{ID}/comment
/jobChanges/{ID}/comment/{subresourceID}
Returns the comment information for the specified job change ID.
The {subResourceID} path parameter must be the same as the {ID} value.
Secured by: Change Job (Mass Action), Change Job (REST Service)
Scope: Staffing
| 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. |
An error occurred.
Successful response. A successful response can return no matched data.
Invalid request. (https://community.workday.com/rest/error-messages)
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
GET /jobChanges/{ID}/comment/{subresourceID}
/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
| 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. |
application/json
comments_7d98fd55aeee100022968e52a1b31c60
| Property | Type | Required |
|---|---|---|
| comment | string | optional |
An error occurred.
Successful response. A successful response can return no matched data. Updating resource.
Invalid request. (https://community.workday.com/rest/error-messages)
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
PATCH /jobChanges/{ID}/comment/{subresourceID}
/jobChanges/{ID}/contract
Returns the contract options for the specified job change ID.
The {subResourceID} path parameter must be the same as the {ID} value.
Secured by: Staffing Actions: Contract Details
Scope: Staffing
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| ID | path | required | string | The Workday ID of the resource. |
| limit | query | optional | integer | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
| offset | query | optional | integer | The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object. |
An error occurred.
Successful response. A successful response can return no matched data.
Invalid request. (https://community.workday.com/rest/error-messages)
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
GET /jobChanges/{ID}/contract
/jobChanges/{ID}/contract/{subresourceID}
Returns the contract options for the specified job change ID.
The {subResourceID} path parameter must be the same as the {ID} value.
Secured by: Staffing Actions: Contract Details
Scope: Staffing
| 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. |
An error occurred.
Successful response. A successful response can return no matched data.
Invalid request. (https://community.workday.com/rest/error-messages)
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
GET /jobChanges/{ID}/contract/{subresourceID}
/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
| 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. |
application/json
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 |
An error occurred.
Successful response. A successful response can return no matched data. Updating resource.
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~.
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
PATCH /jobChanges/{ID}/contract/{subresourceID}
/jobChanges/{ID}/jobClassification
Retrieves a job classification for the specified job change ID.
The {subResourceID} path parameter must be the same as the {ID} value.
Secured by: Staffing Actions: Additional Job Classifications
Scope: Staffing
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| ID | path | required | string | The Workday ID of the resource. |
| limit | query | optional | integer | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
| offset | query | optional | integer | The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object. |
An error occurred.
Successful response. A successful response can return no matched data.
Invalid request. (https://community.workday.com/rest/error-messages)
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
GET /jobChanges/{ID}/jobClassification
/jobChanges/{ID}/jobClassification/{subresourceID}
Retrieves a job classification for the specified job change ID.
The {subResourceID} path parameter must be the same as the {ID} value.
Secured by: Staffing Actions: Additional Job Classifications
Scope: Staffing
| 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. |
An error occurred.
Successful response. A successful response can return no matched data.
Invalid request. (https://community.workday.com/rest/error-messages)
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
GET /jobChanges/{ID}/jobClassification/{subresourceID}
/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
| 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. |
application/json
changeJobJobClassificationData_354103f196361000084489bcb281017f
| Property | Type | Required |
|---|---|---|
| additionalJobClassifications | array | optional |
| └ id | string | optional |
| └ descriptor | string | optional |
An error occurred.
Successful response. A successful response can return no matched data. Updating resource.
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.
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
PATCH /jobChanges/{ID}/jobClassification/{subresourceID}
/jobChanges/{ID}/jobProfile
Retrieves a job profile for the specified job change ID.
The {subResourceID} path parameter must be the same as the {ID} value.
Secured by: Staffing Actions: Job Profile
Scope: Staffing
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| ID | path | required | string | The Workday ID of the resource. |
| limit | query | optional | integer | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
| offset | query | optional | integer | The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object. |
An error occurred.
Successful response. A successful response can return no matched data.
Invalid request. (https://community.workday.com/rest/error-messages)
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
GET /jobChanges/{ID}/jobProfile
/jobChanges/{ID}/jobProfile/{subresourceID}
Retrieves a job profile for the specified job change ID.
The {subResourceID} path parameter must be the same as the {ID} value.
Secured by: Staffing Actions: Job Profile
Scope: Staffing
| 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. |
An error occurred.
Successful response. A successful response can return no matched data.
Invalid request. (https://community.workday.com/rest/error-messages)
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
GET /jobChanges/{ID}/jobProfile/{subresourceID}
/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
| 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. |
application/json
changeJobJobProfileData_3db8095ffa18100013f019a27a1f0115
| Property | Type | Required |
|---|---|---|
| jobTitle | string | optional |
| jobProfile | object | optional |
| └ id | string | required |
| └ href | string | optional |
| └ descriptor | string | optional |
An error occurred.
Successful response. A successful response can return no matched data. Updating resource.
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.
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
PATCH /jobChanges/{ID}/jobProfile/{subresourceID}
/jobChanges/{ID}/location
Returns the location information for the specified job change ID.
The {subResourceID} path parameter must be the same as the {ID} value.
Secured by: Staffing Actions: Location
Scope: Staffing
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| ID | path | required | string | The Workday ID of the resource. |
| limit | query | optional | integer | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
| offset | query | optional | integer | The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object. |
An error occurred.
Successful response. A successful response can return no matched data.
Invalid request. (https://community.workday.com/rest/error-messages)
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
GET /jobChanges/{ID}/location
/jobChanges/{ID}/location/{subresourceID}
Returns the location information for the specified job change ID.
The {subResourceID} path parameter must be the same as the {ID} value.
Secured by: Staffing Actions: Location
Scope: Staffing
| 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. |
An error occurred.
Successful response. A successful response can return no matched data.
Invalid request. (https://community.workday.com/rest/error-messages)
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
GET /jobChanges/{ID}/location/{subresourceID}
/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
| 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. |
application/json
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 |
An error occurred.
Successful response. A successful response can return no matched data. Updating resource.
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]
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
PATCH /jobChanges/{ID}/location/{subresourceID}
/jobChanges/{ID}/moveTeam
Retrieves a move team option from the specified job change ID.
The {subResourceID} path parameter must be the same as the {ID} value.
Secured by: Staffing Actions: Move Manager’s Team
Scope: Staffing
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| ID | path | required | string | The Workday ID of the resource. |
| limit | query | optional | integer | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
| offset | query | optional | integer | The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object. |
An error occurred.
Successful response. A successful response can return no matched data.
Invalid request. (https://community.workday.com/rest/error-messages)
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
GET /jobChanges/{ID}/moveTeam
/jobChanges/{ID}/moveTeam/{subresourceID}
Retrieves a move team option from the specified job change ID.
The {subResourceID} path parameter must be the same as the {ID} value.
Secured by: Staffing Actions: Move Manager’s Team
Scope: Staffing
| 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. |
An error occurred.
Successful response. A successful response can return no matched data.
Invalid request. (https://community.workday.com/rest/error-messages)
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
GET /jobChanges/{ID}/moveTeam/{subresourceID}
/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
| 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. |
application/json
changeJobMoveTeamData_544fdf5c01da1000238ad82d26d90146
| Property | Type | Required |
|---|---|---|
| moveTeam | boolean | optional |
An error occurred.
Successful response. A successful response can return no matched data. Updating resource.
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.
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
PATCH /jobChanges/{ID}/moveTeam/{subresourceID}
/jobChanges/{ID}/opening
Retrieves the opening options for the specified job change ID.
The {subResourceID} path parameter must be the same as the {ID} value.
Secured by: Staffing Actions: Change Job Date and Reason
Scope: Staffing
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| ID | path | required | string | The Workday ID of the resource. |
| limit | query | optional | integer | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
| offset | query | optional | integer | The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object. |
An error occurred.
Successful response. A successful response can return no matched data.
Invalid request. (https://community.workday.com/rest/error-messages)
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
GET /jobChanges/{ID}/opening
/jobChanges/{ID}/opening/{subresourceID}
Retrieves the opening options for the specified job change ID.
The {subResourceID} path parameter must be the same as the {ID} value.
Secured by: Staffing Actions: Change Job Date and Reason
Scope: Staffing
| 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. |
An error occurred.
Successful response. A successful response can return no matched data.
Invalid request. (https://community.workday.com/rest/error-messages)
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
GET /jobChanges/{ID}/opening/{subresourceID}
/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
| 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. |
application/json
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 |
An error occurred.
Successful response. A successful response can return no matched data. Updating resource.
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.
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
PATCH /jobChanges/{ID}/opening/{subresourceID}
/jobChanges/{ID}/position
Retrieves a position for the specified job change ID.
The {subResourceID} path parameter must be the same as the {ID} value.
Secured by: Staffing Actions: Select or Create Position
Scope: Staffing
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| ID | path | required | string | The Workday ID of the resource. |
| limit | query | optional | integer | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
| offset | query | optional | integer | The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object. |
An error occurred.
Successful response. A successful response can return no matched data.
Invalid request. (https://community.workday.com/rest/error-messages)
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
GET /jobChanges/{ID}/position
/jobChanges/{ID}/position/{subresourceID}
Retrieves a position for the specified job change ID.
The {subResourceID} path parameter must be the same as the {ID} value.
Secured by: Staffing Actions: Select or Create Position
Scope: Staffing
| 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. |
An error occurred.
Successful response. A successful response can return no matched data.
Invalid request. (https://community.workday.com/rest/error-messages)
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
GET /jobChanges/{ID}/position/{subresourceID}
/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
| 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. |
application/json
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 |
An error occurred.
Successful response. A successful response can return no matched data. Updating resource.
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.
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
PATCH /jobChanges/{ID}/position/{subresourceID}
/jobChanges/{ID}/startDetails
Retrieves the start details for the specified job change ID.
Secured by: Staffing Actions: Change Job Date and Reason
Scope: Staffing
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| ID | path | required | string | The Workday ID of the resource. |
| limit | query | optional | integer | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
| offset | query | optional | integer | The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object. |
An error occurred.
Successful response. A successful response can return no matched data.
Invalid request. (https://community.workday.com/rest/error-messages)
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
GET /jobChanges/{ID}/startDetails
/jobChanges/{ID}/startDetails/{subresourceID}
Retrieves the start details for the specified job change ID.
Secured by: Staffing Actions: Change Job Date and Reason
Scope: Staffing
| 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. |
An error occurred.
Successful response. A successful response can return no matched data.
Invalid request. (https://community.workday.com/rest/error-messages)
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
GET /jobChanges/{ID}/startDetails/{subresourceID}
/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
| 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. |
application/json
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 |
An error occurred.
Successful response. A successful response can return no matched data. Updating resource.
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.
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
PATCH /jobChanges/{ID}/startDetails/{subresourceID}
/jobChanges/{ID}/submit
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
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| ID | path | required | string | The Workday ID of the resource. |
application/json
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 |
An error occurred.
Resource created.
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.]
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
POST /jobChanges/{ID}/submit
/jobFamilies
Retrieves a collection of job families.
Secured by: Job Information
Scope: Jobs & Positions
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| inactive | query | optional | boolean | If true, the method returns inactive job families. Default is false. |
| jobFamilyGroup | query | optional | array | The job family group for the job family. You can specify more than 1 jobFamilyGroup query parameter. |
| jobProfile | query | optional | array | The job profile for the job family. You can specify more than 1 jobFamilyGroup query parameter. For possible values, you can use a returned id from GET /jobProfiles. |
| limit | query | optional | integer | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
| offset | query | optional | integer | The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object. |
An error occurred.
Successful response. A successful response can return no matched data.
Invalid request. (https://community.workday.com/rest/error-messages)
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
GET /jobFamilies
/jobFamilies/{ID}
Retrieves a job family with the specified ID.
Secured by: Job Information
Scope: Jobs & Positions
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| ID | path | required | string | The Workday ID of the resource. |
An error occurred.
Successful response. A successful response can return no matched data.
Invalid request. (https://community.workday.com/rest/error-messages)
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
GET /jobFamilies/{ID}
/jobProfiles
Retrieves a collection of job profiles.
Secured by: Job Profile: View, Public Job: View
Scope: Jobs & Positions
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| includeInactive | query | optional | boolean | If true, the method returns inactive job profiles. Default is false. |
| limit | query | optional | integer | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
| offset | query | optional | integer | The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object. |
An error occurred.
Successful response. A successful response can return no matched data.
Invalid request. (https://community.workday.com/rest/error-messages)
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
GET /jobProfiles
/jobProfiles/{ID}
Retrieves a job profile with the specified ID.
Secured by: Job Profile: View, Public Job: View
Scope: Jobs & Positions
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| ID | path | required | string | The Workday ID of the resource. |
An error occurred.
Successful response. A successful response can return no matched data.
Invalid request. (https://community.workday.com/rest/error-messages)
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
GET /jobProfiles/{ID}
/jobs
Retrieves a collection of jobs.
Secured by: Worker Position: View
Scope: Staffing
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| limit | query | optional | integer | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
| offset | query | optional | integer | The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object. |
An error occurred.
Successful response. A successful response can return no matched data.
Invalid request. (https://community.workday.com/rest/error-messages)
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
GET /jobs
/jobs/{ID}
Retrieves a job with the specified job ID.
Secured by: Worker Position: View
Scope: Staffing
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| ID | path | required | string | The Workday ID of the resource. |
An error occurred.
Successful response. A successful response can return no matched data.
Invalid request. (https://community.workday.com/rest/error-messages)
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
GET /jobs/{ID}
/jobs/{ID}/workspace
Retrieves a collection of workspaces for the specified job ID.
Secured by: Worker Data: Public Worker Reports
Scope: Staffing
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| ID | path | required | string | The Workday ID of the resource. |
| limit | query | optional | integer | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
| offset | query | optional | integer | The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object. |
An error occurred.
Successful response. A successful response can return no matched data.
Invalid request. (https://community.workday.com/rest/error-messages)
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
GET /jobs/{ID}/workspace
/jobs/{ID}/workspace/{subresourceID}
Retrieves a single workspace for the specified job ID.
Secured by: Worker Data: Public Worker Reports
Scope: Staffing
| 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. |
An error occurred.
Successful response. A successful response can return no matched data.
Invalid request. (https://community.workday.com/rest/error-messages)
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
GET /jobs/{ID}/workspace/{subresourceID}
/organizationAssignmentChanges
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
application/json
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 |
An error occurred.
Resource created.
Invalid request. (https://community.workday.com/rest/error-messages)
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
POST /organizationAssignmentChanges
/organizationAssignmentChanges/{ID}
Retrieves information about an organization assignment change event with the specified ID.
Secured by: Change Organization Assignment (REST), Staffing Organizations: Business Unit, Staffing Organizations: Company, Staffing Organizations: Cost Center, Staffing Organizations: Custom Organization, Staffing Organizations: Grant, Fund, Program, Gift, Staffing Organizations: Header, Staffing Organizations: Region
Scope: Organizations and Roles, Staffing
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| ID | path | required | string | The Workday ID of the resource. |
An error occurred.
Successful response. A successful response can return no matched data.
Invalid request. (https://community.workday.com/rest/error-messages)
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
GET /organizationAssignmentChanges/{ID}
/organizationAssignmentChanges/{ID}/businessUnit
Retrieves a business unit for the specified organization assignment change ID.
The {subResourceID} path parameter must be the same as the {ID} value.
Secured by: Staffing Organizations: Business Unit
Scope: Staffing
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| ID | path | required | string | The Workday ID of the resource. |
| limit | query | optional | integer | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
| offset | query | optional | integer | The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object. |
An error occurred.
Successful response. A successful response can return no matched data.
Invalid request. (https://community.workday.com/rest/error-messages)
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
GET /organizationAssignmentChanges/{ID}/businessUnit
/organizationAssignmentChanges/{ID}/businessUnit/{subresourceID}
Retrieves a business unit for the specified organization assignment change ID.
The {subResourceID} path parameter must be the same as the {ID} value.
Secured by: Staffing Organizations: Business Unit
Scope: Staffing
| 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. |
An error occurred.
Successful response. A successful response can return no matched data.
Invalid request. (https://community.workday.com/rest/error-messages)
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
GET /organizationAssignmentChanges/{ID}/businessUnit/{subresourceID}
/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
| 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. |
application/json
organizationAssignmentChangesBusinessUnitData_5aabf8e28cb310002520b2a2b31d0365
| Property | Type | Required |
|---|---|---|
| businessUnit | object | optional |
| └ id | string | required |
| └ href | string | optional |
| └ descriptor | string | optional |
An error occurred.
Successful response. A successful response can return no matched data. Updating resource.
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]
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
PATCH /organizationAssignmentChanges/{ID}/businessUnit/{subresourceID}
/organizationAssignmentChanges/{ID}/comment
Retrieves the comment information for the specified organization assignment change ID.
The {subResourceID} path parameter must be the same as the {ID} value.
Secured by: Change Organization Assignment (REST), Change Organization Assignments for ~Worker~ (Mass Action)
Scope: Organizations and Roles
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| ID | path | required | string | The Workday ID of the resource. |
| limit | query | optional | integer | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
| offset | query | optional | integer | The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object. |
An error occurred.
Successful response. A successful response can return no matched data.
Invalid request. (https://community.workday.com/rest/error-messages)
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
GET /organizationAssignmentChanges/{ID}/comment
/organizationAssignmentChanges/{ID}/comment/{subresourceID}
Retrieves the comment information for the specified organization assignment change ID.
The {subResourceID} path parameter must be the same as the {ID} value.
Secured by: Change Organization Assignment (REST), Change Organization Assignments for ~Worker~ (Mass Action)
Scope: Organizations and Roles
| 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. |
An error occurred.
Successful response. A successful response can return no matched data.
Invalid request. (https://community.workday.com/rest/error-messages)
Invalid resource or operation. (https://community.workday.com/rest/error-messages)
User has insufficient permissions. (https://community.workday.com/rest/error-messages)
Resource not found. (https://community.workday.com/rest/error-messages)
GET /organizationAssignmentChanges/{ID}/comment/{subresourceID}
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"
}
}
}
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"
}
}
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"
}
}
}
JobChangesGetAdministrativeOptionsResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/changeJobAdministrativeDetailsData_f8f20079bc5a1000089ccb7f6a8800ea"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
}
JobChangesGetBusinessTitleResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/changeJobBusinessTitle_3db8095ffa18100013a5f96969ca0102"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
}
JobChangesGetCommentByIdResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/comments_7d98fd55aeee100022968e52a1b31c60"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
}
JobChangesGetContractOptionsResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/changeJobContractDetailsData_27ec818d10d010000386ce823ac20107"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
}
JobChangesGetJobClassificationResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/changeJobJobClassificationData_354103f196361000084489bcb281017f"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
}
JobChangesGetJobProfileResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/changeJobJobProfileData_3db8095ffa18100013f019a27a1f0115"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
}
JobChangesGetLocationInfoResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/changeJobLocation_90151d6c4ff110001b4a46091678025c"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
}
JobChangesGetMoveTeamOptionResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/changeJobMoveTeamData_544fdf5c01da1000238ad82d26d90146"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
}
JobChangesGetOpeningOptionsResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/changeJobOpeningData_97af9049a5fd10001c4888d654170000"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
}
JobChangesGetPositionByIdResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/changeJobPositionData_dfc4e58f7308100018bd1c459f435221"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
}
JobChangesGetStartDetailsResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jobChangesStartDetailsData_ce861a6a360d10002d40f176b7180020"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
}
JobFamiliesListResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jobFamilyView_51ed1475e9e6100005d10fcedc5a000a"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
}
JobProfilesListCollectionResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jobProfileSummaryView_7deab99f645f10000b5152ce2d700034"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
}
JobsGetCollectionResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jobData_1bfa8925c50510000ae4479925510026"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
}
JobsGetWorkspacesResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jobWorkspaceData_1005157e3d631000144205466a6c13d3"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
}
MULTIPLE_INSTANCE_MODEL_REFERENCE
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
}
},
"total": {
"type": "integer"
}
}
}
OrganizationAssignmentChangesGetBusinessUnitResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/organizationAssignmentChangesBusinessUnitData_5aabf8e28cb310002520b2a2b31d0365"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
}
OrganizationAssignmentChangesGetCommentResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/comments_7d98fd55aeee100022968e52a1b31c60"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
}
OrganizationAssignmentChangesGetCompanyResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/organizationAssignmentChangesCompanyData_652d516fdff41000086e0b9c96950354"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
}
OrganizationAssignmentChangesGetCostCenterResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/organizationAssignmentChangesCostCenterData_5aabf8e28cb3100010a999db2700024e"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
}
OrganizationAssignmentChangesGetCostingOrganizationsResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/organizationAssignmentChangesCostingData_a18edb56aca0100014a4a09dc57e045a"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
}
OrganizationAssignmentChangesGetCustomOrganizationsResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/organizationAssignmentChangesCustomOrganizationDetailsData_53cd2b632146100011e9bf4e7041551f"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
}
OrganizationAssignmentChangesGetRegionResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/organizationAssignmentChangesRegionData_a18edb56aca0100006997e68e5780373"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
}
OrganizationAssignmentChangesGetStartDetailsResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/organizationAssignmentChangesStartDetailsData_90009f2bfc49100017b10cd07d19063b"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
}
SupervisoryOrganizationsGetByIdResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/supervisoryOrganizationView_a02c2e1916fa100009e137235f1f0018"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
}
SupervisoryOrganizationsGetMembersResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jobData_1bfa8925c50510000ae4479925510026"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
}
SupervisoryOrganizationsGetOrgChartResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/orgChartView_643e3a12629710000554e0338e670044"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
}
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"
}
}
}
]
}
WorkersGetCheckInTopicsResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/checkInTopicsSummary_d81c816de26f10000ef2c5cb2fdd0015"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
}
WorkersGetCheckInsResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/checkInsSummary_b3a69f47a499100010ce6be72bfe001d"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
}
WorkersGetCollectionStaffingResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/workerData_c2466b0778c610000d1936006720000e"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
}
WorkersGetExplicitSkillsResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/displayExplicitSkillRepresentation_d6ca778018011000182fa5be1ae901a8"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
}
WorkersGetExternalSkillLevelResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/externalSkillLevelDetail_1c67ac98c0f310002706be33dcdb0000"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
}
WorkersGetServiceDatesResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/serviceDatesData_6b1db753fd82100027b0c8519c860018"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
}
WorkersGetSkillItemsResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/skillItemDisplayDefinition_4b4b7d34b4a21000301eaf52086700d8"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
}
action_38ff08ab6736100010816009079d0126
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "a set containing no instances"
}
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
}
associatedCheckInDetail_3267c0ba92a0100016ed105476ad03c4
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id of the instance"
}
}
}
]
}
associatedCheckInTopicDetail_316b5a26cc3c100010a01184c23902ea
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id of the instance"
}
}
}
]
}
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"
}
}
}
]
}
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"
}
}
}
]
}
businessProcessParameters_23782ad3f54110002073aab65def00fb
{
"allOf": [
{
"$ref": "#/components/schemas/businessProcessParameters_2dcd9a4882b210000f7b2e0a85982265"
},
{}
],
"description": "The Action Event instance to be used with businessProcessLinkable linked service representations."
}
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"
}
}
}
]
}
businessProcessParameters_5afc0b4b5a4610002aaebb8180cd2261
{
"allOf": [
{
"$ref": "#/components/schemas/businessProcessParameters_2dcd9a4882b210000f7b2e0a85982265"
},
{}
],
"description": "The Action Event instance to be used with businessProcessLinkable linked service representations."
}
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
}
category_43b30ba735b8100011ee4781a9d50146
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "Returns the category of a Business Process Attachment."
}
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"
}
}
}
]
}
| Version | Endpoints | Schemas | Ingested | Status |
|---|---|---|---|---|
| v6 | 144 | 214 | 2026-05-18 | current |
| v6 | 144 | 214 | 2026-04-16 |