Query structured spec data via REST or MCP. Get exactly what your agent needs.
https://<tenantHostname>/staffing/v6
/values/jobChangesGroup/assignmentTypes
Retrieves instances that can be used as values for other endpoint parameters in this service.
GET /values/jobChangesGroup/assignmentTypes
/values/jobChangesGroup/companyInsiderTypes
Retrieves instances that can be used as values for other endpoint parameters in this service.
GET /values/jobChangesGroup/companyInsiderTypes
/values/jobChangesGroup/contingentWorkerTypes
Retrieves instances that can be used as values for other endpoint parameters in this service.
GET /values/jobChangesGroup/contingentWorkerTypes
/values/jobChangesGroup/currencies
Retrieves instances that can be used as values for other endpoint parameters in this service.
GET /values/jobChangesGroup/currencies
/values/jobChangesGroup/employeeTypes
Retrieves instances that can be used as values for other endpoint parameters in this service.
GET /values/jobChangesGroup/employeeTypes
/values/jobChangesGroup/frequencies
Retrieves instances that can be used as values for other endpoint parameters in this service.
GET /values/jobChangesGroup/frequencies
/values/jobChangesGroup/headcountOptions
Retrieves instances that can be used as values for other endpoint parameters in this service.
GET /values/jobChangesGroup/headcountOptions
/values/jobChangesGroup/jobClassifications
Retrieves instances that can be used as values for other endpoint parameters in this service.
GET /values/jobChangesGroup/jobClassifications
/values/jobChangesGroup/jobProfiles
Retrieves instances that can be used as values for other endpoint parameters in this service.
GET /values/jobChangesGroup/jobProfiles
/values/jobChangesGroup/jobRequisitions
Retrieves instances that can be used as values for other endpoint parameters in this service.
GET /values/jobChangesGroup/jobRequisitions
/values/jobChangesGroup/jobs
Retrieves instances that can be used as values for other endpoint parameters in this service.
GET /values/jobChangesGroup/jobs
/values/jobChangesGroup/locations
Retrieves instances that can be used as values for other endpoint parameters in this service.
GET /values/jobChangesGroup/locations
/values/jobChangesGroup/payRateTypes
Retrieves instances that can be used as values for other endpoint parameters in this service.
GET /values/jobChangesGroup/payRateTypes
/values/jobChangesGroup/proposedPosition
Retrieves instances that can be used as values for other endpoint parameters in this service.
GET /values/jobChangesGroup/proposedPosition
/values/jobChangesGroup/reason
Retrieves instances that can be used as values for other endpoint parameters in this service.
GET /values/jobChangesGroup/reason
/values/jobChangesGroup/supervisoryOrganization
Retrieves instances that can be used as values for other endpoint parameters in this service.
GET /values/jobChangesGroup/supervisoryOrganization
/values/jobChangesGroup/templates
Retrieves instances that can be used as values for other endpoint parameters in this service.
GET /values/jobChangesGroup/templates
/values/jobChangesGroup/timeTypes
Retrieves instances that can be used as values for other endpoint parameters in this service.
GET /values/jobChangesGroup/timeTypes
/values/jobChangesGroup/workShifts
Retrieves instances that can be used as values for other endpoint parameters in this service.
GET /values/jobChangesGroup/workShifts
/values/jobChangesGroup/workSpaces
Retrieves instances that can be used as values for other endpoint parameters in this service.
GET /values/jobChangesGroup/workSpaces
/values/jobChangesGroup/workStudyAwards
Retrieves instances that can be used as values for other endpoint parameters in this service.
GET /values/jobChangesGroup/workStudyAwards
/values/jobChangesGroup/workerTypes
Retrieves instances that can be used as values for other endpoint parameters in this service.
GET /values/jobChangesGroup/workerTypes
/values/jobChangesGroup/workers
Retrieves instances that can be used as values for other endpoint parameters in this service.
GET /values/jobChangesGroup/workers
/values/jobChangesGroup/workersCompensationCodeOverrides
Retrieves instances that can be used as values for other endpoint parameters in this service.
GET /values/jobChangesGroup/workersCompensationCodeOverrides
/values/organizationAssignmentChangesGroup/businessUnits
Retrieves instances that can be used as values for other endpoint parameters in this service.
GET /values/organizationAssignmentChangesGroup/businessUnits
/values/organizationAssignmentChangesGroup/companies
Retrieves instances that can be used as values for other endpoint parameters in this service.
GET /values/organizationAssignmentChangesGroup/companies
/values/organizationAssignmentChangesGroup/costCenters
Retrieves instances that can be used as values for other endpoint parameters in this service.
GET /values/organizationAssignmentChangesGroup/costCenters
/values/organizationAssignmentChangesGroup/customs
Retrieves instances that can be used as values for other endpoint parameters in this service.
GET /values/organizationAssignmentChangesGroup/customs
/values/organizationAssignmentChangesGroup/funds
Retrieves instances that can be used as values for other endpoint parameters in this service.
GET /values/organizationAssignmentChangesGroup/funds
/values/organizationAssignmentChangesGroup/gifts
Retrieves instances that can be used as values for other endpoint parameters in this service.
GET /values/organizationAssignmentChangesGroup/gifts
/values/organizationAssignmentChangesGroup/grants
Retrieves instances that can be used as values for other endpoint parameters in this service.
GET /values/organizationAssignmentChangesGroup/grants
/values/organizationAssignmentChangesGroup/jobs
Retrieves instances that can be used as values for other endpoint parameters in this service.
GET /values/organizationAssignmentChangesGroup/jobs
/values/organizationAssignmentChangesGroup/positions
Retrieves instances that can be used as values for other endpoint parameters in this service.
GET /values/organizationAssignmentChangesGroup/positions
/values/organizationAssignmentChangesGroup/programs
Retrieves instances that can be used as values for other endpoint parameters in this service.
GET /values/organizationAssignmentChangesGroup/programs
/values/organizationAssignmentChangesGroup/regions
Retrieves instances that can be used as values for other endpoint parameters in this service.
GET /values/organizationAssignmentChangesGroup/regions
/values/organizationAssignmentChangesGroup/workers
Retrieves instances that can be used as values for other endpoint parameters in this service.
GET /values/organizationAssignmentChangesGroup/workers
/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. |
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. |
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. |
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. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/changeJobAdministrativeDetailsData_f8f20079bc5a1000089ccb7f6a8800ea"
}
}
},
"required": true
}
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. |
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. |
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. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/changeJobBusinessTitle_3db8095ffa18100013a5f96969ca0102"
}
}
},
"required": true
}
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. |
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. |
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. |
{
"$ref": "#/components/requestBodies/comments_7d98fd55aeee100022968e52a1b31c60"
}
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. |
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. |
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. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/changeJobContractDetailsData_27ec818d10d010000386ce823ac20107"
}
}
},
"required": true
}
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. |
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. |
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. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/changeJobJobClassificationData_354103f196361000084489bcb281017f"
}
}
},
"required": true
}
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. |
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. |
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. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/changeJobJobProfileData_3db8095ffa18100013f019a27a1f0115"
}
}
},
"required": true
}
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. |
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. |
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. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/changeJobLocation_90151d6c4ff110001b4a46091678025c"
}
}
},
"required": true
}
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. |
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. |
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. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/changeJobMoveTeamData_544fdf5c01da1000238ad82d26d90146"
}
}
},
"required": true
}
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. |
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. |
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. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/changeJobOpeningData_97af9049a5fd10001c4888d654170000"
}
}
},
"required": true
}
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. |
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. |
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. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/changeJobPositionData_dfc4e58f7308100018bd1c459f435221"
}
}
},
"required": true
}
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. |
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. |
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. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/jobChangesStartDetailsData_ce861a6a360d10002d40f176b7180020"
}
}
},
"required": true
}
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. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/eventState_54e611eca2c910000fbc4579181c0111"
}
}
},
"required": true
}
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/organizationAssignmentChangesPostPosition_cf97466f96d9100029bffcf91c120000"
}
}
},
"required": true
}
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. |
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. |
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. |
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. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/organizationAssignmentChangesBusinessUnitData_5aabf8e28cb310002520b2a2b31d0365"
}
}
},
"required": true
}
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. |
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. |
GET /organizationAssignmentChanges/{ID}/comment/{subresourceID}
/organizationAssignmentChanges/{ID}/comment/{subresourceID}
Partially updates the comment for the organization assignment change ID. The {subResourceID} path parameter must be the same as the {ID} value. The data updates in this PATCH method don't persist until you call POST/organizationAssignmentChanges/{ID}/submit. To get the exising data to update, call GET/organizationAssignmentChanges/{ID}/comment/{subResourceID}. Secured by: Change Organization Assignment (REST), Change Organization Assignments for \~Worker\~ (Mass Action) Scope: Organizations and Roles
| 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. |
{
"$ref": "#/components/requestBodies/comments_7d98fd55aeee100022968e52a1b31c60"
}
PATCH /organizationAssignmentChanges/{ID}/comment/{subresourceID}
/organizationAssignmentChanges/{ID}/company
Retrieves a company for the specified organization assignment change ID. The {subResourceID} path parameter must be the same as the {ID} value. Secured by: Staffing Organizations: Company 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. |
GET /organizationAssignmentChanges/{ID}/company
/organizationAssignmentChanges/{ID}/company/{subresourceID}
Retrieves a company for the specified organization assignment change ID. The {subResourceID} path parameter must be the same as the {ID} value. Secured by: Staffing Organizations: Company 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. |
GET /organizationAssignmentChanges/{ID}/company/{subresourceID}
/organizationAssignmentChanges/{ID}/company/{subresourceID}
Partially updates the company for the specified organization assignment change ID. The {subResourceID} path parameter must be the same as the {ID} value. You can call GET /organizationAssignmentChanges/{ID}/company/{subResourceID} to get the existing data to update. The same Workday UI validations apply with this PATCH method. The data updates in this PATCH method do not persist until you call POST /organizationAssignmentChanges/{ID}/submit. In the request body, specify the Workday ID of the company. To retrieve a companies ID, call the GET /values/organizationAssignmentChangesGroup/companies prompt endpoint, which takes the change organization assignment ID as the event query parameter. If you specify the event parameter, it returns HREF links to the companies by organization, as of the event's effective date. If you don't specify the event parameter, it returns HREF links to the companies by active organization based on the current date. Secured by: Staffing Organizations: Company Scope: Staffing
| 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. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/organizationAssignmentChangesCompanyData_652d516fdff41000086e0b9c96950354"
}
}
},
"required": true
}
PATCH /organizationAssignmentChanges/{ID}/company/{subresourceID}
/organizationAssignmentChanges/{ID}/costCenter
Retrieves a cost center for the specified organization assignment change ID. The {subResourceID} path parameter must be the same as the {ID} value. Secured by: Staffing Organizations: Cost Center 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. |
GET /organizationAssignmentChanges/{ID}/costCenter
/organizationAssignmentChanges/{ID}/costCenter/{subresourceID}
Retrieves a cost center for the specified organization assignment change ID. The {subResourceID} path parameter must be the same as the {ID} value. Secured by: Staffing Organizations: Cost Center 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. |
GET /organizationAssignmentChanges/{ID}/costCenter/{subresourceID}
/organizationAssignmentChanges/{ID}/costCenter/{subresourceID}
Partially updates the cost center for the specified organization assignment change ID. The {subResourceID} path parameter must be the same as the {ID} value. You can call GET /organizationAssignmentChanges/{ID}/costCenter/{subResourceID} to get the existing data to update. The same Workday UI validations apply with this PATCH method. The data updates in this PATCH method do not persist until you call POST /organizationAssignmentChanges/{ID}/submit. In the request body, specify the Workday ID of the cost center. To retrieve a costCenter ID, call the GET /values/organizationAssignmentChangesGroup/costCenters prompt endpoint, which takes the change organization assignment ID as the event query parameter. If you specify the event parameter, it returns HREF links to the cost centers by organization, as of the event's effective date. If you don't specify the event parameter, it returns HREF links to the cost centers by active organization based on the current date. Secured by: Staffing Organizations: Cost Center Scope: Staffing
| 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. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/organizationAssignmentChangesCostCenterData_5aabf8e28cb3100010a999db2700024e"
}
}
},
"required": true
}
PATCH /organizationAssignmentChanges/{ID}/costCenter/{subresourceID}
/organizationAssignmentChanges/{ID}/costing
Retrieves the costing organizations for the specified organization assignment change ID. Costing organizations include: Grants, Funds, Programs, and Gifts. The {subResourceID} path parameter must be the same as the {ID} value. Secured by: Staffing Organizations: Grant, Fund, Program, Gift 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. |
GET /organizationAssignmentChanges/{ID}/costing
/organizationAssignmentChanges/{ID}/costing/{subresourceID}
Retrieves the costing organizations for the specified organization assignment change ID. Costing organizations include: Grants, Funds, Programs, and Gifts. The {subResourceID} path parameter must be the same as the {ID} value. Secured by: Staffing Organizations: Grant, Fund, Program, Gift 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. |
GET /organizationAssignmentChanges/{ID}/costing/{subresourceID}
/organizationAssignmentChanges/{ID}/costing/{subresourceID}
Partially updates the costing organizations for the specified organization assignment change ID. Costing organizations include: Grants, Funds, Programs, and Gifts. The {subResourceID} path parameter must be the same as the {ID} value. You can call GET /organizationAssignmentChanges/{ID}/costing/{subResourceID} to get the existing data to update. The same Workday UI validations apply with this PATCH method. The data updates in this PATCH method do not persist until you call POST /organizationAssignmentChanges/{ID}/submit. In the request body, specify the Workday ID of the grant, program, gift, or fund you want to update. To retrieve a grants ID, call the GET /values/organizationAssignmentChangesGroup/grants prompt endpoint, which takes the change organization assignment ID as the event query parameter. If you specify the event parameter, it returns HREF links to the grants by organization, as of the event's effective date. If you don't specify the event parameter, it returns HREF links to the grants by active organization based on the current date. To retrieve a funds ID, call the GET /values/organizationAssignmentChangesGroup/funds prompt endpoint, which takes the change organization assignment ID as the event query parameter. If you specify the event parameter, it returns HREF links to the funds by organization, as of the event's effective date. If you don't specify the event parameter, it returns HREF links to the funds by active organization based on the current date. To retrieve a programs ID, call the GET /values/organizationAssignmentChangesGroup/programs prompt endpoint, which takes the change organization assignment ID as the event query parameter. If you specify the event parameter, it returns HREF links to the programs by organization, as of the event's effective date. If you don't specify the event parameter, it returns HREF links to the programs by active organization based on the current date. To retrieve a gifts ID, call the GET /values/organizationAssignmentChangesGroup/gifts prompt endpoint, which takes the change organization assignment ID as the event query parameter. If you specify the event parameter, it returns HREF links to the gifts by organization, as of the event's effective date. If you don't specify the event parameter, it returns HREF links to the gifts by active organization based on the current date. Secured by: Staffing Organizations: Grant, Fund, Program, Gift Scope: Staffing
| 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. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/organizationAssignmentChangesCostingData_a18edb56aca0100014a4a09dc57e045a"
}
}
},
"required": true
}
PATCH /organizationAssignmentChanges/{ID}/costing/{subresourceID}
/organizationAssignmentChanges/{ID}/customOrganizations
Retrieves the custom organizations for the specified organization assignment change ID. The {subResourceID} path parameter must be the same as the {ID} value. Secured by: Staffing Organizations: Custom Organization 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. |
GET /organizationAssignmentChanges/{ID}/customOrganizations
/organizationAssignmentChanges/{ID}/customOrganizations/{subresourceID}
Retrieves the custom organizations for the specified organization assignment change ID. The {subResourceID} path parameter must be the same as the {ID} value. Secured by: Staffing Organizations: Custom Organization 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. |
GET /organizationAssignmentChanges/{ID}/customOrganizations/{subresourceID}
/organizationAssignmentChanges/{ID}/customOrganizations/{subresourceID}
Partially updates the custom organizations for the specified organization assignment change ID. The {subResourceID} path parameter must be the same as the {ID} value. You can call GET /organizationAssignmentChanges/{ID}/customorganization/{subResourceID} to get the existing data to update. The same Workday UI validations apply with this PATCH method. The data updates in this PATCH method do not persist until you call POST /organizationAssignmentChanges/{ID}/submit. In the request body, specify the Workday ID of the custom organization {id} To retrieve a custom organization ID, call the GET /values/organizationAssignmentChangesGroup/customs prompt endpoint, which takes the change organization assignment ID as the event query parameter. If you specify the event parameter, it returns HREF links to the custom organizations, as of the event's effective date. If you don't specify the event parameter, it returns HREF links to the active custom organizations based on the current date. Secured by: Staffing Organizations: Custom Organization Scope: Staffing
| 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. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/organizationAssignmentChangesCustomOrganizationDetailsData_53cd2b632146100011e9bf4e7041551f"
}
}
},
"required": true
}
PATCH /organizationAssignmentChanges/{ID}/customOrganizations/{subresourceID}
/organizationAssignmentChanges/{ID}/region
Retrieves a region for the specified organization assignment change ID. The {subResourceID} path parameter must be the same as the {ID} value. Secured by: Staffing Organizations: Region 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. |
GET /organizationAssignmentChanges/{ID}/region
/organizationAssignmentChanges/{ID}/region/{subresourceID}
Retrieves a region for the specified organization assignment change ID. The {subResourceID} path parameter must be the same as the {ID} value. Secured by: Staffing Organizations: Region 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. |
GET /organizationAssignmentChanges/{ID}/region/{subresourceID}
/organizationAssignmentChanges/{ID}/region/{subresourceID}
Partially updates the region for the specified organization assignment change ID. The {subResourceID} path parameter must be the same as the {ID} value. In the request body, specify the Workday ID of the region. To retrieve a regions ID, call the GET /values/organizationAssignmentChangesGroup/regions prompt endpoint, which takes the change organization assignment ID as the event query parameter. If you specify the event parameter, it returns HREF links to the regions by organization, as of the event's effective date. If you don't specify the event parameter, it returns HREF links to the regions by active organization based on the current date. Secured by: Staffing Organizations: Region Scope: Staffing
| 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. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/organizationAssignmentChangesRegionData_a18edb56aca0100006997e68e5780373"
}
}
},
"required": true
}
PATCH /organizationAssignmentChanges/{ID}/region/{subresourceID}
/organizationAssignmentChanges/{ID}/startDetails
Retrieves the start details for the specified organization assignment change ID. The {subResourceID} path parameter must be the same as the {ID} value. Secured by: Staffing Organizations: Header 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. |
GET /organizationAssignmentChanges/{ID}/startDetails
/organizationAssignmentChanges/{ID}/startDetails/{subresourceID}
Retrieves the start details for the specified organization assignment change ID. The {subResourceID} path parameter must be the same as the {ID} value. Secured by: Staffing Organizations: Header 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. |
GET /organizationAssignmentChanges/{ID}/startDetails/{subresourceID}
/organizationAssignmentChanges/{ID}/startDetails/{subresourceID}
Partially updates the start details for the specified organization assignment change ID. The {subResourceID} path parameter must be the same as the {ID} value. In the request body, specify the effective date for the event. You can call GET /organizationAssignmentChanges/{ID}/startDetails/{subResourceID} to get the existing data to update. You can only update the date field once the event is initiated. These fields are read-only: worker, supervisoryOrganization, and position. The same Workday UI validations apply with this PATCH method. The updates in this PATCH method do not persist until you call POST /organizationAssignmentChanges/{ID}/submit. Secured by: Staffing Organizations: Header Scope: Staffing
| 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. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/organizationAssignmentChangesStartDetailsData_90009f2bfc49100017b10cd07d19063b"
}
}
},
"required": true
}
PATCH /organizationAssignmentChanges/{ID}/startDetails/{subresourceID}
/organizationAssignmentChanges/{ID}/submit
Submits the organization assignment change event for the specified ID, and initiates the Change Organization Assignment business process. Submitting this request with an empty request body { } is equivalent to clicking the Submit button on the Change Organization Assgingment task in Workday. For the equivalent of clicking the Save For Later button, specify the Save for Later Workday ID, ""d9e41a8c446c11de98360015c5e6daf6"", in the status{id} request field. Example: { ""status"": { ""id"": ""d9e41a8c446c11de98360015c5e6daf6"" } } Secured by: Change Organization Assignment (REST) Scope: Organizations and Roles
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| ID | path | required | string | The Workday ID of the resource. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/eventStateOrganizationAssignment_f3e1ff305e2d100003327f7b7fa103f1"
}
}
},
"required": true
}
POST /organizationAssignmentChanges/{ID}/submit
/supervisoryOrganizations
Retrieves a supervisory organization for the specified ID. Secured by: BDA OAuth 2.0 Connector, Manage: Supervisory Organization, View: Supervisory Organization Scope: Organizations and Roles
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| includeInactive | query | optional | boolean | If true, this method returns the inactive organizations. 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. |
GET /supervisoryOrganizations
/supervisoryOrganizations/{ID}
Retrieves a supervisory organization for the specified ID. Secured by: BDA OAuth 2.0 Connector, Manage: Supervisory Organization, View: Supervisory Organization Scope: Organizations and Roles
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| ID | path | required | string | The Workday ID of the resource. |
GET /supervisoryOrganizations/{ID}
/supervisoryOrganizations/{ID}/members
Retrieves a collection of members for the specified supervisory organization ID. Secured by: Reports: Organization 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. |
GET /supervisoryOrganizations/{ID}/members
/supervisoryOrganizations/{ID}/members/{subresourceID}
Retrieves a member for the specified supervisory organization ID. Secured by: Reports: Organization 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. |
GET /supervisoryOrganizations/{ID}/members/{subresourceID}
/supervisoryOrganizations/{ID}/orgChart
Retrieves information about an organization chart of the specified supervisory organization id. Secured by: Reports: Organization 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. |
GET /supervisoryOrganizations/{ID}/orgChart
/supervisoryOrganizations/{ID}/orgChart/{subresourceID}
Retrieves information about an organization chart of the specified supervisory organization id. Secured by: Reports: Organization 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. |
GET /supervisoryOrganizations/{ID}/orgChart/{subresourceID}
/workers
Retrieves a collection of workers and current staffing information. Secured by: Self-Service: Current Staffing Information, Worker Data: Public Worker Reports Scope: Staffing
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| includeTerminatedWorkers | query | optional | boolean | Include terminated workers in the output |
| 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. |
| search | query | optional | string | Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search. |
GET /workers
/workers/{ID}
Retrieves a collection of workers and current staffing information. Secured by: Self-Service: Current Staffing Information, Worker Data: Public Worker Reports Scope: Staffing
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| ID | path | required | string | The Workday ID of the resource. |
GET /workers/{ID}
/workers/{ID}/checkInTopics
Retrieves all Check-In topics for the specified worker. The worker is specified by the Workday ID of the worker. You can use a returned id from GET /workers in the Staffing service /staffing. Secured by: Self-Service: Check-Ins, Worker Data: Check-Ins Scope: Performance Enablement Contains attachment(s)
| 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. |
GET /workers/{ID}/checkInTopics
/workers/{ID}/checkInTopics
Creates a single Check-In topic instance with the specified data with the specified worker. The worker is specified by the Workday ID of the worker. You can use a returned id from GET /workers in the Staffing service /staffing. In the request body, specify at least these required fields: name. This endpoint is equivalent to the Create Check-In Topic task in Workday. Secured by: Worker Data: Check-Ins REST API Scope: Performance Enablement Contains attachment(s)
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| ID | path | required | string | The Workday ID of the resource. |
{
"$ref": "#/components/requestBodies/checkInTopicDetail_3267c0ba92a010001688d79b032b03b8"
}
POST /workers/{ID}/checkInTopics
/workers/{ID}/checkInTopics/{subresourceID}
Deletes an existing Check-In topic instance with the specified ID. This can only be done by the creater of the Check-In topic. This endpoint is equivalent to the Delete Check-In Topic task in Workday. Secured by: Self-Service: Check-Ins Scope: Performance Enablement
| 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. |
DELETE /workers/{ID}/checkInTopics/{subresourceID}
/workers/{ID}/checkInTopics/{subresourceID}
Retrieves a Check-In topic with the specified ID for the specified worker. The worker is specified by the Workday ID of the worker. You can use a returned id from GET /workers in the Staffing service /staffing. Secured by: Self-Service: Check-Ins, Worker Data: Check-Ins Scope: Performance Enablement Contains attachment(s)
| 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. |
GET /workers/{ID}/checkInTopics/{subresourceID}
/workers/{ID}/checkInTopics/{subresourceID}
Partially updates an existing Check-In topic instance with the specified ID and the specified data in the request body (name, privateNotes, sharedNotes, checkInTopicAttachments, or associatedCheckIns). This can only be done by the creator or participant of the Check-In. This endpoint is equivalent to the Edit Check-In Topic task in Workday. Secured by: Self-Service: Check-Ins Scope: Performance Enablement Contains attachment(s)
| 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. |
{
"$ref": "#/components/requestBodies/checkInTopicDetail_3267c0ba92a010001688d79b032b03b8"
}
PATCH /workers/{ID}/checkInTopics/{subresourceID}
/workers/{ID}/checkInTopics/{subresourceID}?type=archive
Partially updates an existing Check-In topic instance with the specified ID and the specified data in the request body (archive). This can only be done by the creator or participant of the Check-In. This endpoint is equivalent to the Archive Check-In Topic task in Workday. Secured by: Self-Service: Check-Ins, Worker Data: Check-Ins Scope: Performance Enablement
| 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. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/checkInTopicArchiveDetail_1163fe23102e10001f72d77b213401a2"
}
}
},
"required": true
}
PATCH /workers/{ID}/checkInTopics/{subresourceID}?type=archive
/workers/{ID}/checkIns
Retrieves all Check-Ins for the specified worker. The worker is specified by the Workday ID of the worker. You can use a returned id from GET /workers in the Staffing service /staffing. This endpoint is equivalent to the View Check-Ins task in Workday. Secured by: Self-Service: Check-Ins, Worker Data: Check-Ins Scope: Performance Enablement Contains attachment(s)
| 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. |
GET /workers/{ID}/checkIns
/workers/{ID}/checkIns
Creates a single Check-In instance with the specified data with the specified worker. The worker is specified by the Workday ID of the worker. You can use a returned id from GET /workers in the Staffing service /staffing. In the request body, specify at least the required field: date. This endpoint is equivalent to the Create Check-In task in Workday. Secured by: Worker Data: Check-Ins REST API Scope: Performance Enablement Contains attachment(s)
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| ID | path | required | string | The Workday ID of the resource. |
{
"$ref": "#/components/requestBodies/checkInDetail_316b5a26cc3c10000ebdb0cb484602e1"
}
POST /workers/{ID}/checkIns
/workers/{ID}/checkIns/{subresourceID}
Deletes an existing Check-In instance with the specified ID. This can only be done by the creater of the Check-In. This endpoint is equivalent to the Delete Check-In task in Workday. Secured by: Self-Service: Check-Ins Scope: Performance Enablement
| 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. |
DELETE /workers/{ID}/checkIns/{subresourceID}
/workers/{ID}/checkIns/{subresourceID}
Retrieves a Check-In with the specified ID for the specified worker. The worker is specified by the Workday ID of the worker. You can use a returned id from GET /workers in the Staffing service /staffing. Secured by: Self-Service: Check-Ins, Worker Data: Check-Ins Scope: Performance Enablement Contains attachment(s)
| 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. |
GET /workers/{ID}/checkIns/{subresourceID}
/workers/{ID}/checkIns/{subresourceID}
Partially updates an existing Check-In instance with the specified ID and the specified data in the request body (date, description, or associated topics). This can only be done by the creator or participant of the Check-In. This endpoint is equivalent to the Edit Check-In task in Workday. Secured by: Self-Service: Check-Ins Scope: Performance Enablement Contains attachment(s)
| 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. |
{
"$ref": "#/components/requestBodies/checkInDetail_316b5a26cc3c10000ebdb0cb484602e1"
}
PATCH /workers/{ID}/checkIns/{subresourceID}
/workers/{ID}/checkIns/{subresourceID}?type=archive
Partially updates an existing Check-In instance with the specified ID and the specified data in the request body (archive). This can only be done by the creator or participant of the Check-In. This endpoint is equivalent to the Archive Check-Ins task in Workday. Secured by: Self-Service: Check-Ins, Worker Data: Check-Ins Scope: Performance Enablement
| 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. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/checkInArchiveDetail_1163fe23102e10001df342088f8a018e"
}
}
},
"required": true
}
PATCH /workers/{ID}/checkIns/{subresourceID}?type=archive
/workers/{ID}/explicitSkills
Get Explicit Skills for Skill Enabled Secured by: Person Data: Skills, Self-Service: Skills Scope: Worker Profile and Skills
| 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. |
| skill | query | optional | string | Retrieves the skills for the specified skill name. |
| skillSource | query | optional | string | The Workday ID of the skill source. Returns skills associated with the skill source. |
GET /workers/{ID}/explicitSkills
/workers/{ID}/explicitSkills
Save skills a user has Secured by: Self-Service: Skills Scope: Worker Profile and Skills
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| ID | path | required | string | The Workday ID of the resource. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/createSkillUsageRepresentation_98f198f5056b1000196313ffe9a0225e"
}
}
},
"required": true
}
POST /workers/{ID}/explicitSkills
/workers/{ID}/explicitSkills/{subresourceID}
Get Explicit Skills for Skill Enabled Secured by: Person Data: Skills, Self-Service: Skills Scope: Worker Profile and Skills
| 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. |
GET /workers/{ID}/explicitSkills/{subresourceID}
/workers/{ID}/externalSkillLevel
Retrieves all external skill level information for a worker. You can filter the external skill levels by externalSkillId. Secured by: Self-Service: External Skill Source, Worker Data: External Skill Source Scope: Worker Profile and Skills
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| ID | path | required | string | The Workday ID of the resource. |
| externalSkillId | query | optional | string | All External Skills. If passed, the External Skill Level associated with the External Skill ID. |
| 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. |
GET /workers/{ID}/externalSkillLevel
/workers/{ID}/externalSkillLevel
Creates external skill levels. Secured by: Self-Service: External Skill Source, Worker Data: External Skill Source Scope: Worker Profile and Skills
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| ID | path | required | string | The Workday ID of the resource. |
{
"$ref": "#/components/requestBodies/externalSkillLevel_a39462f09c44100005d46fd77ef00000"
}
POST /workers/{ID}/externalSkillLevel
/workers/{ID}/externalSkillLevel/{subresourceID}
Retrieves all external skill level information for a worker. You can filter the external skill levels by externalSkillId. Secured by: Self-Service: External Skill Source, Worker Data: External Skill Source Scope: Worker Profile and Skills
| 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. |
GET /workers/{ID}/externalSkillLevel/{subresourceID}
/workers/{ID}/externalSkillLevel/{subresourceID}
Updates external skill levels. Secured by: Self-Service: External Skill Source, Worker Data: External Skill Source Scope: Worker Profile and Skills
| 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. |
{
"$ref": "#/components/requestBodies/externalSkillLevel_a39462f09c44100005d46fd77ef00000"
}
PUT /workers/{ID}/externalSkillLevel/{subresourceID}
/workers/{ID}/homeContactInformationChanges
Creates a new Home Contact Change business process event for the parent Person. Secured by: Change Home Contact Information (REST Service) Scope: Contact Information
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| ID | path | required | string | The Workday ID of the resource. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/homeContactChangeEvent_f42ba27d87ed10001aa58a5d231b1621"
}
}
},
"required": true
}
POST /workers/{ID}/homeContactInformationChanges
/workers/{ID}/homeContactInformationChanges/{subresourceID}
Retrieves an existing Home Contact Change event for the Person. Secured by: Change Home Contact Information (REST Service) Scope: Contact Information
| 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. |
GET /workers/{ID}/homeContactInformationChanges/{subresourceID}
/workers/{ID}/jobChanges
Initiates a job change request for a specific worker Call this method to start a new job change event, which returns a new job change ID. Use the new ID to reference the job change event in subsequent methods that update or get information about the same event. The same Workday UI validations apply with this POST method. The updates in this POST method do not persist until you call POST /jobChanges/{ID}/submit. In the request body, specify at least this required field: date, worker {id}, job {id}, reason {id} To retrieve a worker ID, call the GET /values/jobChangesGroup/workers prompt endpoint with the effectiveDate query parameter. It returns HREF links to workers by category. You can filter the results by effectiveDate. By default, it returns workers on the current date. Only workers without blocking events or available for change job for the current user are returned. To retrieve a job ID, call the GET /values/jobChangesGroup/jobs prompt endpoint with the worker query parameter. It returns all positions for the worker with current user access to do a job change. You can filter the results by effectiveDate. By default, it returns positions on the current date. To retrieve a reason ID, call the GET /values/jobChangesGroup/reason prompt endpoint, which takes the job change ID as the staffingEvent query parameter. If you specify the staffingEvent parameter, it returns change job reasons for the staffingEvent, by the change job category. By default, it returns all change job categories and reasons. To retrieve a supervisoryOrganization ID, call the GET /values/jobChangesGroup/supervisoryOrganization prompt endpoint, with proposedManager and effectiveDate query parameters. If you specify the proposedManager parameter, it returns HREF links to all supervisory organizations for that manager. If you specify effectiveDate, it filters the results by effective date. The default is the current date. To retrieve a location ID, call the GET /values/jobChangesGroup/locations prompt endpoint, which takes the staffingEvent query parameter. It returns HREF links to locations by location categories for the specified location. You can filter the results by effectiveDate. By default, it returns locations on the current date. Secured by: Change Job (REST Service) Scope: Staffing
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| ID | path | required | string | The Workday ID of the resource. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/jobChangesStartDetailsPOSTData_75e528a78e9a10000ab750ea156f0111"
}
}
},
"required": true
}
POST /workers/{ID}/jobChanges
/workers/{ID}/organizationAssignmentChanges
Initiates an organization assignment change for a specific worker. Call this method to start a new change organization assignment event, which returns a new change organization assignment ID. Use the new ID to reference the change organization assignment event in subsequent methods that update or get information about the same event. The same Workday UI validations apply with this POST method. The updates in this POST method do not persist until you call POST /organizationAssignmentChanges/{ID}/submit. In the request body, specify at least this required field: date, worker {id}, job {id} To retrieve a worker ID, call the GET /values/organizationAssignmentChangesGroup/workers prompt endpoint with the effectiveDate query parameter. It returns HREF links to workers by category. You can filter the results by effectiveDate. By default, it returns workers on the current date. Only workers without blocking events or available for organization assignment change for the current user are returned. To retrieve a job ID, call the /values/organizationAssignmentChangesGroup/jobs prompt endpoint with the worker query parameter. It returns all positions for the worker with current user access to do an organization assignment change . You can filter the results by effectiveDate. By default, it returns positions on the current date. Secured by: Change Organization Assignment (REST) Scope: Organizations and Roles
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| ID | path | required | string | The Workday ID of the resource. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/organizationAssignmentChangesPost_cc45d62b623c1000132ac812c30a052e"
}
}
},
"required": true
}
POST /workers/{ID}/organizationAssignmentChanges
/workers/{ID}/serviceDates
Retrieves all service dates for the specified worker id. Secured by: Self-Service: Service Dates, Worker Data: Service Dates 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. |
GET /workers/{ID}/serviceDates
/workers/{ID}/serviceDates/{subresourceID}
Retrieves information about a service date for the specified worker id. Secured by: Self-Service: Service Dates, Worker Data: Service Dates 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. |
GET /workers/{ID}/serviceDates/{subresourceID}
/workers/{ID}/skillItems
Secured by: Person Data: Skills, Self-Service: Skills Scope: Worker Profile and Skills
| 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. |
GET /workers/{ID}/skillItems
/workers/{ID}/skillItems
Secured by: Person Data: Skills, Self-Service: Skills Scope: Worker Profile and Skills
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| ID | path | required | string | The Workday ID of the resource. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/skillItemsBulkDefinition_9d815bbfd67010000d6ed56204ab12de"
}
}
},
"required": true
}
POST /workers/{ID}/skillItems
/workers/{ID}/skillItems/{subresourceID}
Secured by: Person Data: Skills, Self-Service: Skills Scope: Worker Profile and Skills
| 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. |
GET /workers/{ID}/skillItems/{subresourceID}
/workers/{ID}/workContactInformationChanges
Creates a new Home Contact Change business process event for the parent Person. Secured by: Change Work Contact Information (REST Service) Scope: Contact Information
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| ID | path | required | string | The Workday ID of the resource. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/workContactChangeEvent_5fca6c96c1c81000142fd03784140113"
}
}
},
"required": true
}
POST /workers/{ID}/workContactInformationChanges
/workers/{ID}/workContactInformationChanges/{subresourceID}
Retrieves an existing Work Contact Change event for the Person. Secured by: Change Work Contact Information (REST Service) Scope: Contact Information
| 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. |
GET /workers/{ID}/workContactInformationChanges/{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"
}
}
}
]
}
changeJobAdministrativeDetailsData_f8f20079bc5a1000089ccb7f6a8800ea
{
"allOf": [
{
"type": "object",
"properties": {
"fte": {
"type": "integer",
"example": 40,
"description": "Full Time Equivalent for a worker calculated by scheduled weekly hours divided by default weekly hours either current or proposed.",
"x-workday-type": "Numeric",
"x-conditionally-hidden": true,
"x-conditionally-readOnly": true
},
"paidFte": {
"type": "integer",
"example": 40,
"description": "The paid full time equivalent for the worker as of the effective date.",
"x-workday-type": "Numeric",
"x-conditionally-hidden": true
},
"notifyBy": {
"type": "string",
"format": "date",
"example": "2020-01-17T17:00:00.000Z",
"description": "Returns the date that the employee should be notified for a termination.",
"x-workday-type": "Date",
"x-conditionally-hidden": true,
"x-conditionally-required": true
},
"timeType": {
"$ref": "#/components/schemas/timeType_05d4c45042b610000bb540b7458e0108"
},
"workStudy": {
"$ref": "#/components/schemas/workStudy_05d4c45042b610000ba2f83c70f30101"
},
"workingFte": {
"type": "integer",
"example": 40,
"description": "The working full time equivalent for the worker as of the effective date.",
"x-workday-type": "Numeric",
"x-conditionally-hidden": true
},
"payRateType": {
"$ref": "#/components/schemas/payRateType_d25283821c01100016756a14eb650000"
},
"assignmentType": {
"$ref": "#/components/schemas/assignmentType_23929e1f68ca10000d6940d6bde56963"
},
"firstDayOfWork": {
"type": "string",
"format": "date",
"example": "2020-01-20T16:00:00.000Z",
"description": "The first day of work for the worker, as specified on the Hire, Add International Assignment, or Add Job transaction. This field will not return a value for any other transaction.",
"x-workday-type": "Date",
"x-conditionally-hidden": true,
"x-conditionally-required": true
},
"specifyPaidFte": {
"type": "boolean",
"example": true,
"description": "True if paid full time equivalent is specified on a worker as of the effective date.",
"x-workday-type": "Boolean",
"x-conditionally-hidden": true
},
"endEmploymentDate": {
"type": "string",
"format": "date",
"example": "2024-03-23T07:00:00.000Z",
"description": "The new End Employment Date for the worker. If the worker has an Employee Contract sub event, this field will return that end date instead.",
"x-workday-type": "Date",
"x-conditionally-hidden": true,
"x-conditionally-required": true
},
"specifyWorkingFte": {
"type": "boolean",
"example": true,
"description": "True if working full time equivalent is specified on a worker as of the effective date.",
"x-workday-type": "Boolean",
"x-conditionally-hidden": true
},
"defaultWeeklyHours": {
"type": "integer",
"example": 40,
"description": "The new default weekly hours for the worker as of the effective date.",
"x-workday-type": "Numeric",
"x-conditionally-hidden": true,
"x-conditionally-readOnly": true,
"x-conditionally-required": true
},
"positionWorkerType": {
"$ref": "#/components/schemas/positionWorkerType_05d4c45042b610001030ee47f2c90118"
},
"companyInsiderTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/changeJobCompanyInsiderTypesData_05d4c45042b61000131e4b2132f30137"
},
"description": "The new company insider types for the worker as of the effective date.",
"x-workday-type": "Multi-instance",
"x-conditionally-hidden": true,
"x-conditionally-required": true
},
"expectedAssignmentEndDate": {
"type": "string",
"format": "date",
"example": "2024-03-23T07:00:00.000Z",
"description": "For a past or current business process, the value of the Expected Assignment End Date field that is being (or was) proposed in the process.",
"x-workday-type": "Date",
"x-conditionally-hidden": true,
"x-conditionally-required": true
},
"workersCompensationCodeOverride": {
"$ref": "#/components/schemas/workersCompensationCodeOverride_05d4c45042b61000138500e185e0013f"
}
}
}
]
}
changeJobBusinessTitle_3db8095ffa18100013a5f96969ca0102
{
"allOf": [
{
"type": "object",
"properties": {
"businessTitle": {
"type": "string",
"example": "Sample Business Title",
"description": "The new business title for the worker as of the effective date. If there is no business title override, this field defaults to the job title or job profile name.",
"x-workday-type": "Text",
"x-conditionally-hidden": true,
"x-conditionally-required": true
}
}
}
]
}
changeJobCompanyInsiderTypesData_05d4c45042b61000131e4b2132f30137
{
"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"
}
}
}
]
}
changeJobContractDetailsData_27ec818d10d010000386ce823ac20107
{
"allOf": [
{
"type": "object",
"properties": {
"currency": {
"$ref": "#/components/schemas/currency_2d0ca2cb2448100009c54386a8570e07"
},
"frequency": {
"$ref": "#/components/schemas/frequency_2d0ca2cb2448100009c5436d5d670e06"
},
"purchaseOrder": {
"$ref": "#/components/schemas/purchaseOrder_2d0ca2cb2448100009c5433bcff60e05"
},
"contractEndDate": {
"type": "string",
"format": "date",
"example": "2021-01-01T01:00:00.000Z",
"description": "The contract end date for the position as of this business process.",
"x-workday-type": "Date",
"x-conditionally-hidden": true,
"x-conditionally-required": true
},
"contractPayRate": {
"type": "object",
"example": "50.25",
"description": "The new contract pay rate for the contingent worker as of the effective date.",
"x-workday-type": "Currency",
"x-conditionally-hidden": true,
"x-conditionally-required": true
},
"assignmentDetails": {
"type": "string",
"example": "Sample Contract Assignment Details",
"description": "The new contract assignment details for the contingent worker as of the effective date.",
"x-workday-type": "Text",
"x-conditionally-hidden": true,
"x-conditionally-required": true
}
}
}
]
}
changeJobDefaultRepresentation_6cc31ee444d010000bb4153a954300e7
{
"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"
}
}
}
]
}
changeJobJobClassificationData_354103f196361000084489bcb281017f
{
"allOf": [
{
"type": "object",
"properties": {
"additionalJobClassifications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/changeJobAdditionalJobClassificationData_27ec818d10d0100003600115b5200102"
},
"description": "Additional Job Classifications Proposed By Staffing Event",
"x-workday-type": "Multi-instance",
"x-conditionally-hidden": true,
"x-conditionally-required": true
}
}
}
]
}
changeJobJobProfileData_3db8095ffa18100013f019a27a1f0115
{
"allOf": [
{
"type": "object",
"properties": {
"jobTitle": {
"type": "string",
"example": "Sample Job Title",
"description": "The new job title for the worker as of the effective date.",
"x-workday-type": "Text",
"x-conditionally-hidden": true
},
"jobProfile": {
"$ref": "#/components/schemas/jobProfile_3db8095ffa18100013f019afc6d30116"
}
}
}
]
}
changeJobLocation_90151d6c4ff110001b4a46091678025c
{
"allOf": [
{
"type": "object",
"properties": {
"location": {
"$ref": "#/components/schemas/location_90151d6c4ff110001bfa027116820278"
},
"workShift": {
"$ref": "#/components/schemas/workShift_0ee7bb8b41db1000143d4e4822174f2e"
},
"workSpace": {
"$ref": "#/components/schemas/workSpace_0ee7bb8b41db10001e7db6a6c3e55663"
},
"scheduledHours": {
"type": "integer",
"example": 40,
"description": "The new scheduled hours for the worker as of the effective date.",
"x-workday-type": "Numeric",
"x-conditionally-hidden": true,
"x-conditionally-required": true
}
}
}
]
}
changeJobMoveTeamData_544fdf5c01da1000238ad82d26d90146
{
"allOf": [
{
"type": "object",
"properties": {
"moveTeam": {
"type": "boolean",
"example": true,
"description": "Returns a boolean that indicates whether teams reporting to the Manager moved with them during the Change Job Event.",
"x-workday-type": "Boolean",
"x-conditionally-hidden": true
}
}
}
]
}
changeJobOpeningData_97af9049a5fd10001c4888d654170000
{
"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"
},
"headcountOption": {
"$ref": "#/components/schemas/headcountOption_97af9049a5fd10001c48896fbde30000"
},
"openingAvailableForOverlap": {
"type": "boolean",
"example": true,
"description": "Returns true if the value for 'Available for job overlap' box is checked",
"x-workday-type": "Boolean",
"x-conditionally-hidden": true
}
}
}
]
}
changeJobPositionData_dfc4e58f7308100018bd1c459f435221
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id of the instance"
},
"position": {
"$ref": "#/components/schemas/position_dfc4e58f730810001ad60369c23452d1"
},
"descriptor": {
"type": "string",
"example": "Lorem ipsum dolor sit ame",
"description": "A preview of the instance"
},
"closePosition": {
"type": "boolean",
"example": true,
"description": "Returns true if the position is being closed.",
"x-workday-type": "Boolean",
"x-conditionally-hidden": true,
"x-conditionally-readOnly": true
},
"createPosition": {
"type": "boolean",
"example": true,
"description": "Returns true if the position is being created.",
"x-workday-type": "Boolean",
"x-conditionally-hidden": true
},
"jobRequisition": {
"$ref": "#/components/schemas/jobRequisition_dfc4e58f730810001ad60325d9bc52cf"
},
"availableForOverlap": {
"type": "boolean",
"example": true,
"description": "Returns true if the value for 'Available for job overlap' box is checked",
"x-workday-type": "Boolean",
"x-conditionally-hidden": true,
"x-conditionally-readOnly": true
}
}
}
]
}
changeOrganizationAssignmentDefaultRepresentation_db2f38bfb555100012de1eb17c2f00ff
{
"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"
}
}
}
]
}
checkInArchiveDetail_1163fe23102e10001df342088f8a018e
{
"allOf": [
{
"type": "object",
"required": [
"archive"
],
"properties": {
"id": {
"type": "string",
"description": "Id of the instance"
},
"archive": {
"type": "boolean",
"example": true,
"description": "Indicates that the check-in is archived.",
"x-workday-type": "Boolean"
},
"descriptor": {
"type": "string",
"example": "Lorem ipsum dolor sit ame",
"description": "A preview of the instance"
}
}
}
]
}
checkInAttachmentDetail_ef244acfe6cf10002ebe92d43a7701d7
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id of the instance"
},
"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 comment for the Attachment",
"x-workday-type": "Text"
},
"fileName": {
"type": "string",
"example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"maxLength": 255,
"description": "File name of the attachment",
"x-workday-type": "Text"
},
"descriptor": {
"type": "string",
"example": "Lorem ipsum dolor sit ame",
"description": "A preview of the instance"
},
"fileLength": {
"type": "integer",
"example": 1171233711,
"description": "File length of the attachment",
"x-workday-type": "Numeric"
},
"contentType": {
"$ref": "#/components/schemas/contentType_ef244acfe6cf10002ebe92e7001601d8"
}
}
}
]
}
checkInDetail_316b5a26cc3c10000ebdb0cb484602e1
{
"allOf": [
{
"type": "object",
"required": [
"date"
],
"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"
},
"description": {
"type": "string",
"example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"description": "Description of check-in.",
"x-workday-type": "Rich Text"
},
"associatedTopics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/associatedCheckInTopicDetail_316b5a26cc3c100010a01184c23902ea"
},
"description": "Topics included in a check-in.",
"x-workday-type": "Multi-instance"
},
"checkInAttachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/checkInAttachmentDetail_ef244acfe6cf10002ebe92d43a7701d7"
},
"description": "Returns all attachments for the Check-In.",
"x-workday-type": "Multi-instance"
}
}
}
]
}
checkInTopicArchiveDetail_1163fe23102e10001f72d77b213401a2
{
"allOf": [
{
"type": "object",
"required": [
"archive"
],
"properties": {
"id": {
"type": "string",
"description": "Id of the instance"
},
"archive": {
"type": "boolean",
"example": true,
"description": "Indicates that the topic is archived.",
"x-workday-type": "Boolean"
},
"descriptor": {
"type": "string",
"example": "Lorem ipsum dolor sit ame",
"description": "A preview of the instance"
}
}
}
]
}
checkInTopicAttachmentDetail_600ecde4c8421000278d06bfacea01c1
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id of the instance"
},
"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 comment for the Attachment",
"x-workday-type": "Text"
},
"fileName": {
"type": "string",
"example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"maxLength": 255,
"description": "File name of the attachment",
"x-workday-type": "Text"
},
"descriptor": {
"type": "string",
"example": "Lorem ipsum dolor sit ame",
"description": "A preview of the instance"
},
"fileLength": {
"type": "integer",
"example": 541229484,
"description": "File length of the attachment",
"x-workday-type": "Numeric"
},
"contentType": {
"$ref": "#/components/schemas/contentType_600ecde4c842100027eaa21d044e01cf"
}
}
}
]
}
checkInTopicDetail_3267c0ba92a010001688d79b032b03b8
{
"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",
"x-conditionally-required": true
},
"sharedNotes": {
"type": "string",
"example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"description": "Shared notes of the topic.",
"x-workday-type": "Rich Text"
},
"privateNotes": {
"type": "string",
"example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"description": "Personal notes of the topic.",
"x-workday-type": "Rich Text"
},
"associatedCheckIns": {
"type": "array",
"items": {
"$ref": "#/components/schemas/associatedCheckInDetail_3267c0ba92a0100016ed105476ad03c4"
},
"description": "Check-ins associated to topic.",
"x-workday-type": "Multi-instance"
},
"checkInTopicAttachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/checkInTopicAttachmentDetail_600ecde4c8421000278d06bfacea01c1"
},
"description": "Returns all attachments for the Check-In Topic.",
"x-workday-type": "Multi-instance"
}
}
}
]
}
checkInTopicsSummary_d81c816de26f10000ef2c5cb2fdd0015
{
"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"
},
"creator": {
"$ref": "#/components/schemas/creator_d81c816de26f10000f521459ac80001d"
},
"archived": {
"type": "boolean",
"example": true,
"description": "Indicates that the topic is archived.",
"x-workday-type": "Boolean"
},
"participant": {
"$ref": "#/components/schemas/participant_d81c816de26f10000f52144d053f001b"
},
"sharedNotes": {
"type": "string",
"example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"description": "Shared notes of the topic.",
"x-workday-type": "Rich Text"
},
"privateNotes": {
"type": "string",
"example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"description": "Personal notes of the topic.",
"x-workday-type": "Rich Text"
},
"associatedCheckIns": {
"type": "array",
"items": {
"$ref": "#/components/schemas/associatedCheckInsSummary_d81c816de26f10000f7a29ea89140020"
},
"description": "Check-ins associated to topic.",
"x-workday-type": "Multi-instance"
},
"checkInTopicAttachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/checkInTopicAttachmentDetail_600ecde4c8421000278d06bfacea01c1"
},
"description": "Returns all attachments for the Check-In Topic.",
"x-workday-type": "Multi-instance"
}
}
}
]
}
checkInsSummary_b3a69f47a499100010ce6be72bfe001d
{
"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"
},
"creator": {
"$ref": "#/components/schemas/creator_b3a69f47a49910001687de28dd71003d"
},
"archived": {
"type": "boolean",
"example": true,
"description": "Indicates that the check-in is archived.",
"x-workday-type": "Boolean"
},
"description": {
"type": "string",
"example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"description": "Description of check-in.",
"x-workday-type": "Rich Text"
},
"participant": {
"$ref": "#/components/schemas/participant_b3a69f47a49910001687de1d4c75003c"
},
"associatedTopics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/associatedTopicsSummary_b3a69f47a4991000171aae4c5a810040"
},
"description": "Topics included in a check-in.",
"x-workday-type": "Multi-instance"
},
"checkInAttachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/checkInAttachmentDetail_ef244acfe6cf10002ebe92d43a7701d7"
},
"description": "Returns all attachments for the Check-In.",
"x-workday-type": "Multi-instance"
}
}
}
]
}
comments_7d98fd55aeee100022968e52a1b31c60
{
"allOf": [
{
"type": "object",
"properties": {
"comment": {
"type": "string",
"example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"description": "The business process comment for a worker event before it's submitted.",
"x-workday-type": "Text"
}
}
}
]
}
comments_86093b8a932f10001499f356ff83012e
{
"allOf": [
{
"type": "object",
"properties": {
"person": {
"$ref": "#/components/schemas/person_86093b8a932f10001499f38c72410130"
},
"comment": {
"type": "string",
"example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"description": "Comment",
"x-workday-type": "Text"
},
"commentDate": {
"type": "string",
"format": "date",
"example": "2024-03-23T07:00:00.000Z",
"description": "Gives the moment at which the instance was originally created.",
"x-workday-type": "Date"
}
}
}
]
}
companyInsiderTypeRelatedView_7deab99f645f10001000f8a388740081
{
"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"
}
}
}
]
}
company_56fe0dd0eca1100019cfe097d26a03f2
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "The new company for the \\~worker\\~ as of the effective date.",
"x-conditionally-hidden": true,
"x-conditionally-required": true
}
contentType_43b30ba735b8100011ee47993f11014a
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "Content type of the attachment"
}
contentType_600ecde4c842100027eaa21d044e01cf
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "Content type of the attachment"
}
contentType_ef244acfe6cf10002ebe92e7001601d8
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "Content type of the attachment"
}
costCenter_5aabf8e28cb3100010a999f40b07024f
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "The new cost center for the \\~worker\\~ as of the effective date.",
"x-conditionally-hidden": true,
"x-conditionally-required": true
}
countryDataForLocationData_af21e47ff7c01000092e0e4f9a22026e
{
"allOf": [
{
"type": "object",
"properties": {
"descriptor": {
"type": "string",
"example": "Lorem ipsum dolor sit ame",
"description": "A preview of the instance"
}
}
}
]
}
countryOrRegionRelatedView_3b00708994e4100007e9c8f14e3812ae
{
"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"
}
}
}
]
}
countryOrRegion_3b00708994e4100007848bc917a112a6
{
"allOf": [
{
"$ref": "#/components/schemas/countryOrRegionRelatedView_3b00708994e4100007e9c8f14e3812ae"
},
{}
],
"description": "Returns the \\~Country\\~ or Country Region for this Job Profile Exempt."
}
countryRelatedView_7deab99f645f10000cf305c30e260054
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id of the instance"
},
"alpha3Code": {
"type": "string",
"example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"maxLength": 3,
"description": "The ISO alpha-3 code for a country.",
"x-workday-type": "Text"
},
"descriptor": {
"type": "string",
"example": "Lorem ipsum dolor sit ame",
"description": "A preview of the instance"
}
}
}
]
}
country_3b00708994e4100004edeb4e0d37128c
{
"allOf": [
{
"$ref": "#/components/schemas/countryRelatedView_7deab99f645f10000cf305c30e260054"
},
{}
],
"description": "The \\~country\\~ for the worker compensation code."
}
country_3b00708994e41000095e4647007012bc
{
"allOf": [
{
"$ref": "#/components/schemas/countryRelatedView_7deab99f645f10000cf305c30e260054"
},
{}
],
"description": "The \\~country\\~ associated with the job profile pay rate"
}
country_af21e47ff7c01000092ecf4d7ad30270
{
"allOf": [
{
"$ref": "#/components/schemas/countryDataForLocationData_af21e47ff7c01000092e0e4f9a22026e"
},
{}
],
"description": "Returns the \\~country\\~ from the primary address for the location."
}
createSkillUsageRepresentation_98f198f5056b1000196313ffe9a0225e
{
"allOf": [
{
"type": "object",
"properties": {
"skills": {
"type": "array",
"items": {
"$ref": "#/components/schemas/displayExplicitSkillRepresentation_d6ca778018011000182fa5be1ae901a8"
},
"description": "Explicit Skill Usages",
"x-workday-type": "Multi-instance"
},
"skillItem": {
"$ref": "#/components/schemas/skillItem_98f198f5056b100019631445471d225f"
},
"skillSources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/skillItemSourceAddRepresentation_c5fabc4ca81610000d5d15309ac90122"
},
"description": "Skill Sources",
"x-workday-type": "Multi-instance"
}
}
}
]
}
creator_b3a69f47a49910001687de28dd71003d
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "Creator of \\~check-in\\~."
}
creator_d81c816de26f10000f521459ac80001d
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "Creator of \\~topic\\~."
}
currency_2d0ca2cb2448100009c54386a8570e07
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "The currency that is applied to the \\~contingent worker's\\~ contract pay rate as of the event effective date.",
"x-conditionally-hidden": true
}
customOrganizationDetails_3950e273020a100017857926d35d369c
{
"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"
},
"organizationType": {
"$ref": "#/components/schemas/organizationType_3950e273020a100017857958e234369d"
}
}
}
]
}
difficultyToFillRelatedView_3b00708994e41000032f4de84695004c
{
"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"
}
}
}
]
}
difficultyToFill_89a0b59e7cce1000074acb57c0c50162
{
"allOf": [
{
"$ref": "#/components/schemas/difficultyToFillRelatedView_3b00708994e41000032f4de84695004c"
},
{}
],
"description": "Indicates how difficult it is to fill this job profile."
}
displayExplicitSkillRepresentation_d6ca778018011000182fa5be1ae901a8
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id of the instance"
},
"remoteID": {
"type": "string",
"example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"description": "Remote Skill ID for associated Remote Skill Item",
"x-workday-type": "Text"
},
"skillItem": {
"$ref": "#/components/schemas/skillItem_d6ca778018011000182fa5f3b32001aa"
},
"descriptor": {
"type": "string",
"example": "Lorem ipsum dolor sit ame",
"description": "A preview of the instance"
},
"skillSources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/skillSourceRepresentation_998d2cc58f2f10000db59b08da0306a8"
},
"description": "The sources that serve as evidence for the skill usage.",
"x-workday-type": "Multi-instance"
}
}
}
]
}
eventAttachmentsForToolbar_43b30ba735b8100011ee4767246d0143
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id of the instance"
},
"category": {
"$ref": "#/components/schemas/category_43b30ba735b8100011ee4781a9d50146"
},
"fileName": {
"type": "string",
"example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"maxLength": 255,
"description": "File name of the attachment",
"x-workday-type": "Text"
},
"fileLength": {
"type": "integer",
"example": 53461586,
"description": "File length of the attachment",
"x-workday-type": "Numeric"
},
"uploadDate": {
"type": "string",
"format": "date",
"example": "2024-03-23T07:00:00.000Z",
"readOnly": true,
"description": "Returns Date the Business Process Attachment was updated.",
"x-workday-type": "Date"
},
"uploadedBy": {
"$ref": "#/components/schemas/uploadedBy_b32ff437243510000e22e06470370160"
},
"contentType": {
"$ref": "#/components/schemas/contentType_43b30ba735b8100011ee47993f11014a"
},
"description": {
"type": "string",
"example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"description": "Event attachment description",
"x-workday-type": "Text"
}
}
}
]
}
eventStateOrganizationAssignment_f3e1ff305e2d100003327f7b7fa103f1
{
"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"
},
"businessProcessParameters": {
"$ref": "#/components/schemas/businessProcessParameters_23782ad3f54110002073aab65def00fb"
}
}
}
]
}
eventState_54e611eca2c910000fbc4579181c0111
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id of the instance"
},
"status": {
"$ref": "#/components/schemas/status_54e611eca2c910000fbc4599be0b0112"
},
"descriptor": {
"type": "string",
"example": "Lorem ipsum dolor sit ame",
"description": "A preview of the instance"
},
"validation": {
"type": "string",
"example": "Sample Validation",
"description": "Validation message for an action event triggered by a condition.",
"x-workday-type": "Text"
},
"businessProcessParameters": {
"$ref": "#/components/schemas/businessProcessParameters_5afc0b4b5a4610002aaebb8180cd2261"
}
}
}
]
}
externalSkillLevelDetail_1c67ac98c0f310002706be33dcdb0000
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id of the instance"
},
"context": {
"type": "string",
"example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"description": "The text you enter to provide context for this external skill load. Not visible to end users.",
"x-workday-type": "Text"
},
"skillVendorId": {
"type": "string",
"example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"description": "The vendor associated to the External Skill.",
"x-workday-type": "Text"
},
"effectiveMoment": {
"type": "string",
"format": "date",
"example": "2024-03-23T07:00:00.000Z",
"description": "The date that the external Skill Level was last updated.",
"x-workday-type": "Date"
},
"externalSkillId": {
"type": "string",
"example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"description": "The skill from the external system.",
"x-workday-type": "Text"
},
"skillVendorName": {
"type": "string",
"example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"description": "The name of the vendor associated with the External Skill.",
"x-workday-type": "Text"
},
"externalSkillName": {
"type": "string",
"example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"description": "The name of the skill from the external system",
"x-workday-type": "Text"
},
"externalSkillLevel": {
"type": "integer",
"example": 5,
"description": "The skill level normalized to a scale from 1-5 and to 1 decimal place.",
"x-workday-type": "Numeric"
}
}
}
]
}
externalSkillLevel_a39462f09c44100005d46fd77ef00000
{
"allOf": [
{
"type": "object",
"required": [
"externalSkillId",
"externalSkillLevel"
],
"properties": {
"id": {
"type": "string",
"description": "Id of the instance"
},
"context": {
"type": "string",
"example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"description": "The text you enter to provide context for this external skill load. Not visible to end users.",
"x-workday-type": "Text"
},
"effectiveMoment": {
"type": "string",
"format": "date",
"example": "2024-03-23T07:00:00.000Z",
"description": "The date that the external Skill Level was last updated.",
"x-workday-type": "Date"
},
"externalSkillId": {
"type": "string",
"example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"description": "The skill from the external system.",
"x-workday-type": "Text"
},
"externalSkillLevel": {
"type": "integer",
"example": 8,
"description": "The skill level normalized to a scale from 1-5 and to 1 decimal place.",
"x-workday-type": "Numeric"
}
}
}
]
}
for_5d688bd57bb910001815ab3dd10024a9
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"x-readOnly": true,
"description": "The thing which this business process is about. It could be another business process if this is a sub-process"
}
frequency_2d0ca2cb2448100009c5436d5d670e06
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "The new frequency that is applied to the \\~contingent worker's\\~ contract pay rate.",
"x-conditionally-hidden": true,
"x-conditionally-required": true
}
fund_a18edb56aca0100014a4a0b27352045c
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "The new fund for the \\~worker\\~ after the business process.",
"x-conditionally-hidden": true,
"x-conditionally-required": true
}
gift_a18edb56aca0100014a4a0a9f876045b
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "The new gift for the \\~worker\\~ after the business process.",
"x-conditionally-hidden": true,
"x-conditionally-required": true
}
grant_a18edb56aca0100014a4a0bcf25c045e
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "The new grant for the \\~worker\\~ after the business process.",
"x-conditionally-hidden": true,
"x-conditionally-required": true
}
headcountOption_97af9049a5fd10001c48896fbde30000
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "Headcount option for the event",
"x-conditionally-hidden": true,
"x-conditionally-required": true
}
homeContactChangeEvent_f42ba27d87ed10001aa58a5d231b1621
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id of the instance"
},
"href": {
"type": "string",
"example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"description": "The URL to the related change home contact information resource where this event can be interacted with via REST",
"x-workday-type": "Text"
},
"descriptor": {
"type": "string",
"example": "Lorem ipsum dolor sit ame",
"description": "A preview of the instance"
},
"effective_date": {
"type": "string",
"format": "date",
"example": "2024-03-23T07:00:00.000Z",
"description": "The date this business process takes effect.",
"x-workday-type": "Date"
}
}
}
]
}
jobCategoryRelatedView_7deab99f645f10000f8582dc572d0075
{
"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"
}
}
}
]
}
jobCategory_89a0b59e7cce1000074acb471919015f
{
"allOf": [
{
"$ref": "#/components/schemas/jobCategoryRelatedView_7deab99f645f10000f8582dc572d0075"
},
{}
],
"description": "The Job Category for the Job Profile."
}
jobChangesStartDetailsData_ce861a6a360d10002d40f176b7180020
{
"allOf": [
{
"type": "object",
"required": [
"date"
],
"properties": {
"id": {
"type": "string",
"description": "Id of the instance"
},
"job": {
"$ref": "#/components/schemas/job_35b8f199c29410002508ffd7ad6101f3"
},
"date": {
"type": "string",
"format": "date",
"example": "2020-01-18T01:00:00.000Z",
"description": "The date this business process takes effect.",
"x-workday-type": "Date"
},
"reason": {
"$ref": "#/components/schemas/reason_6da81665c26510001f34d0a154765e9b"
},
"worker": {
"$ref": "#/components/schemas/worker_271bbd673582100010110b9f9a6d99e1"
},
"location": {
"$ref": "#/components/schemas/location_6da81665c26510001fc6b1d42fae5f7b"
},
"template": {
"$ref": "#/components/schemas/template_2b1b95dfe4af100009f30dc769a31686"
},
"descriptor": {
"type": "string",
"example": "Lorem ipsum dolor sit ame",
"description": "A preview of the instance"
},
"useNextPayPeriod": {
"type": "boolean",
"example": true,
"description": "Next Pay Period?",
"x-workday-type": "Boolean",
"x-conditionally-hidden": true,
"x-conditionally-readOnly": true
},
"supervisoryOrganization": {
"$ref": "#/components/schemas/supervisoryOrganization_e3267ea37e6f100032c00c34a99e74d8"
}
}
}
]
}
jobChangesStartDetailsPOSTData_75e528a78e9a10000ab750ea156f0111
{
"allOf": [
{
"type": "object",
"required": [
"date"
],
"properties": {
"id": {
"type": "string",
"description": "Id of the instance"
},
"job": {
"$ref": "#/components/schemas/job_75e528a78e9a10000ab7512c5c550115"
},
"date": {
"type": "string",
"format": "date",
"example": "2020-01-18T01:00:00.000Z",
"description": "The date this business process takes effect.",
"x-workday-type": "Date"
},
"reason": {
"$ref": "#/components/schemas/reason_85deac43cd1a10000b96c80c118f171e"
},
"location": {
"$ref": "#/components/schemas/location_75e528a78e9a10000ab75125ebe50114"
},
"template": {
"$ref": "#/components/schemas/template_2b1b95dfe4af100007f63081aec5158e"
},
"descriptor": {
"type": "string",
"example": "Lorem ipsum dolor sit ame",
"description": "A preview of the instance"
},
"supervisoryOrganization": {
"$ref": "#/components/schemas/supervisoryOrganization_75e528a78e9a10000ab75132a9df0116"
}
}
}
]
}
jobDataForWorker_b8ac205877fd10000ea91719a02a00a2
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id of the instance"
},
"jobType": {
"$ref": "#/components/schemas/jobType_b8ac205877fd10000ea91752f39c00ab"
},
"location": {
"$ref": "#/components/schemas/location_b8ac205877fd10000ea91737c7da00a5"
},
"workSpace": {
"$ref": "#/components/schemas/workSpace_426ac445037110001b3eb91ddf6f0100"
},
"descriptor": {
"type": "string",
"example": "Lorem ipsum dolor sit ame",
"description": "A preview of the instance"
},
"jobProfile": {
"$ref": "#/components/schemas/jobProfile_b8ac205877fd10000ea9174f73c500aa"
},
"businessTitle": {
"type": "string",
"example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"description": "The business title for the position.",
"x-workday-type": "Text"
},
"supervisoryOrganization": {
"$ref": "#/components/schemas/supervisoryOrganization_b8ac205877fd10000ea91743659800a7"
}
}
}
]
}
jobData_1bfa8925c50510000ae4479925510026
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id of the instance"
},
"worker": {
"$ref": "#/components/schemas/worker_fab4a151b24810000e66f769304c126b"
},
"jobType": {
"$ref": "#/components/schemas/jobType_b8ac205877fd100005c55b45c6400057"
},
"location": {
"$ref": "#/components/schemas/location_6d3eb084b4c410002b617efb943f0059"
},
"descriptor": {
"type": "string",
"example": "Lorem ipsum dolor sit ame",
"description": "A preview of the instance"
},
"jobProfile": {
"$ref": "#/components/schemas/jobProfile_6fb921f8a11d10001d5268980bbb0097"
},
"businessTitle": {
"type": "string",
"example": "Sample Business Title",
"description": "The business title for the position.",
"x-workday-type": "Text"
},
"nextPayPeriodStartDate": {
"type": "string",
"format": "date",
"example": "2020-01-27T16:00:00.000Z",
"description": "The next pay period start date for the job.",
"x-workday-type": "Date"
},
"supervisoryOrganization": {
"$ref": "#/components/schemas/supervisoryOrganization_fab4a151b24810000d13073c5d341257"
}
}
}
]
}
jobFamilyGroupView_7164d34509ba10000b8610c566ea002d
{
"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"
}
}
}
]
}
jobFamilyGroup_51ed1475e9e6100006229cfe817b0014
{
"allOf": [
{
"$ref": "#/components/schemas/jobFamilyGroupView_7164d34509ba10000b8610c566ea002d"
},
{}
],
"description": "The job family group for the job family. You can specify more than 1 jobFamilyGroup query parameter."
}
jobFamilyRelatedView_3b00708994e410000e0e2540529b12d6
{
"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": "The job family name for the job family.",
"x-workday-type": "Text"
},
"descriptor": {
"type": "string",
"example": "Lorem ipsum dolor sit ame",
"description": "A preview of the instance"
}
}
}
]
}
jobFamilyView_51ed1475e9e6100005d10fcedc5a000a
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id of the instance"
},
"summary": {
"type": "string",
"example": "Sample Job Family Summary",
"description": "Returns the job family summary for the job family.",
"x-workday-type": "Text"
},
"inactive": {
"type": "boolean",
"example": true,
"description": "If true, the method returns inactive job families. Default is false.",
"x-workday-type": "Boolean"
},
"descriptor": {
"type": "string",
"example": "Lorem ipsum dolor sit ame",
"description": "A preview of the instance"
},
"jobProfiles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jobProfileView_51ed1475e9e6100006c698ef68480017"
},
"description": "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.",
"x-workday-type": "Multi-instance"
},
"jobFamilyGroup": {
"$ref": "#/components/schemas/jobFamilyGroup_51ed1475e9e6100006229cfe817b0014"
}
}
}
]
}
jobLevelRelatedView_7deab99f645f10000f06cbbf927a0069
{
"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"
}
}
}
]
}
jobLevel_89a0b59e7cce1000074acb3c1e8e015d
{
"allOf": [
{
"$ref": "#/components/schemas/jobLevelRelatedView_7deab99f645f10000f06cbbf927a0069"
},
{}
],
"description": "The job level for the job profile."
}
jobProfileDetailView_7deab99f645f10000bd5e61a1b780041
{
"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": "The name of the job profile.",
"x-workday-type": "Text"
},
"public": {
"type": "boolean",
"example": true,
"description": "Indicates if the job profile has been marked as being public.",
"x-workday-type": "Boolean"
},
"summary": {
"type": "string",
"example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"description": "The description of the responsibilities and/or qualifications for the job profile.",
"x-workday-type": "Text"
},
"inactive": {
"type": "boolean",
"example": true,
"description": "Returns true if the Job Profile is inactive.",
"x-workday-type": "Boolean"
},
"jobLevel": {
"$ref": "#/components/schemas/jobLevel_89a0b59e7cce1000074acb3c1e8e015d"
},
"jobExempts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jobProfileExemptRelatedView_3b00708994e41000076da515387812a2"
},
"description": "Returns the job exempt instances for the job profile.",
"x-workday-type": "Multi-instance"
},
"criticalJob": {
"type": "boolean",
"example": true,
"description": "Indicates if the job is considered critical.",
"x-workday-type": "Boolean"
},
"jobCategory": {
"$ref": "#/components/schemas/jobCategory_89a0b59e7cce1000074acb471919015f"
},
"jobFamilies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jobFamilyRelatedView_3b00708994e410000e0e2540529b12d6"
},
"description": "The job family for the job profile.",
"x-workday-type": "Multi-instance"
},
"payRateTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jobProfilePayRateTypeRelatedView_3b00708994e4100008d4b09e903f12b5"
},
"description": "The pay rate for the job profile",
"x-workday-type": "Multi-instance"
},
"jobDescription": {
"type": "string",
"example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"description": "The formatted job description value on the job profile.",
"x-workday-type": "Rich Text"
},
"defaultJobTitle": {
"type": "string",
"example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"description": "The Job Title Default for the job profile.",
"x-workday-type": "Text"
},
"managementLevel": {
"$ref": "#/components/schemas/managementLevel_89a0b59e7cce1000074acb1d768e0158"
},
"difficultyToFill": {
"$ref": "#/components/schemas/difficultyToFill_89a0b59e7cce1000074acb57c0c50162"
},
"workShiftRequired": {
"type": "boolean",
"example": true,
"description": "Indicates if the Job Profile requires a Work Shift to be specified on associated Positions.",
"x-workday-type": "Boolean"
},
"companyInsiderTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/companyInsiderTypeRelatedView_7deab99f645f10001000f8a388740081"
},
"description": "The Company Insider Type for the Job Profile.",
"x-workday-type": "Multi-instance"
},
"restrictedToCountries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/countryRelatedView_7deab99f645f10000cf305c30e260054"
},
"description": "Returns the valid countries for the job profile.",
"x-workday-type": "Multi-instance"
},
"additionalJobDescription": {
"type": "string",
"example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"description": "The formatted additional job description value on the job profile.",
"x-workday-type": "Rich Text"
},
"workersCompensationCodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/workersCompensationCodeRelatedView_3b00708994e4100004af13d958811287"
},
"description": "Returns the compensation codes for this job profile.",
"x-workday-type": "Multi-instance"
}
}
}
]
}
jobProfileExemptRelatedView_3b00708994e41000076da515387812a2
{
"allOf": [
{
"type": "object",
"properties": {
"exempt": {
"type": "boolean",
"example": true,
"description": "Returns the exempt value for this Job Profile Exempt.",
"x-workday-type": "Boolean"
},
"countryOrRegion": {
"$ref": "#/components/schemas/countryOrRegion_3b00708994e4100007848bc917a112a6"
}
}
}
]
}
jobProfileJobView_fab4a151b24810000d511d61ee641262
{
"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"
}
}
}
]
}
jobProfilePayRateTypeRelatedView_3b00708994e4100008d4b09e903f12b5
{
"allOf": [
{
"type": "object",
"properties": {
"country": {
"$ref": "#/components/schemas/country_3b00708994e41000095e4647007012bc"
},
"payRateType": {
"$ref": "#/components/schemas/payRateType_3b00708994e410000c3d01aea96012c1"
}
}
}
]
}
jobProfileSummaryView_7deab99f645f10000b5152ce2d700034
{
"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": "The name of the job profile.",
"x-workday-type": "Text"
},
"inactive": {
"type": "boolean",
"example": true,
"description": "Returns true if the Job Profile is inactive.",
"x-workday-type": "Boolean"
}
}
}
]
}
jobProfileView_51ed1475e9e6100006c698ef68480017
{
"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"
}
}
}
]
}
jobProfile_3db8095ffa18100013f019afc6d30116
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "The new job profile for the \\~worker\\~ as of the effective date."
}
jobProfile_6fb921f8a11d10001d5268980bbb0097
{
"allOf": [
{
"$ref": "#/components/schemas/jobProfileJobView_fab4a151b24810000d511d61ee641262"
},
{}
],
"description": "The job profile for the position."
}
jobProfile_b8ac205877fd10000ea9174f73c500aa
{
"allOf": [
{
"$ref": "#/components/schemas/jobProfileJobView_fab4a151b24810000d511d61ee641262"
},
{}
],
"description": "The job profile for the position."
}
jobRequisition_dfc4e58f730810001ad60325d9bc52cf
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "The job requisition which was used for this event",
"x-conditionally-hidden": true,
"x-conditionally-readOnly": true
}
jobTypeData_b8ac205877fd100005c3b50b74a30055
{
"allOf": [
{
"type": "object",
"properties": {
"descriptor": {
"type": "string",
"example": "Lorem ipsum dolor sit ame",
"description": "A preview of the instance"
}
}
}
]
}
jobType_b8ac205877fd100005c55b45c6400057
{
"allOf": [
{
"$ref": "#/components/schemas/jobTypeData_b8ac205877fd100005c3b50b74a30055"
},
{}
],
"description": "The position's job type which can be one of the following values: Primary, Additional Job, or International Assignment. If the position is not effective, no value will be returned. Primary and additional job are effective dated due to the Switch Primary Job business process. An international assignment cannot be switched to a be a primary job."
}
jobType_b8ac205877fd10000ea91752f39c00ab
{
"allOf": [
{
"$ref": "#/components/schemas/jobTypeData_b8ac205877fd100005c3b50b74a30055"
},
{}
],
"description": "The position's job type which can be one of the following values: Primary, Additional Job, or International Assignment. If the position is not effective, no value will be returned. Primary and additional job are effective dated due to the Switch Primary Job business process. An international assignment cannot be switched to a be a primary job."
}
jobWorkspaceData_1005157e3d631000144205466a6c13d3
{
"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"
},
"locationChain": {
"type": "string",
"example": "Sample Location Chain",
"description": "Location chain including bread crumbs for location.",
"x-workday-type": "Text"
}
}
}
]
}
job_35b8f199c29410002508ffd7ad6101f3
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"x-readOnly": true,
"description": "The position for the \\~worker\\~ prior to the effective date. This field will be blank for non-staffing transactions and for hire transactions."
}
job_75e528a78e9a10000ab7512c5c550115
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "The position for the \\~worker\\~ prior to the effective date. This field will be blank for non-staffing transactions and for hire transactions.",
"x-conditionally-required": true
}
locationDataJobView_6d3eb084b4c410002b5fa13f0c9d0056
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id of the instance"
},
"country": {
"$ref": "#/components/schemas/country_af21e47ff7c01000092ecf4d7ad30270"
},
"descriptor": {
"type": "string",
"example": "Lorem ipsum dolor sit ame",
"description": "A preview of the instance"
}
}
}
]
}
location_6d3eb084b4c410002b617efb943f0059
{
"allOf": [
{
"$ref": "#/components/schemas/locationDataJobView_6d3eb084b4c410002b5fa13f0c9d0056"
},
{}
],
"description": "The location associated with the filled position or position restrictions. When associated with position restrictions, the location returned is in this order: the location on the effective job requisition, hiring restrictions, or primary location of the \\~supervisory organization\\~."
}
location_6da81665c26510001fc6b1d42fae5f7b
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"x-readOnly": true,
"description": "The new location for the \\~worker\\~ as of the effective date."
}
location_75e528a78e9a10000ab75125ebe50114
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "The new location for the \\~worker\\~ as of the effective date."
}
location_90151d6c4ff110001bfa027116820278
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "The new location for the \\~worker\\~ as of the effective date.",
"x-conditionally-readOnly": true,
"x-conditionally-required": true
}
location_b8ac205877fd10000ea91737c7da00a5
{
"allOf": [
{
"$ref": "#/components/schemas/locationDataJobView_6d3eb084b4c410002b5fa13f0c9d0056"
},
{}
],
"description": "The location associated with the filled position or position restrictions. When associated with position restrictions, the location returned is in this order: the location on the effective job requisition, hiring restrictions, or primary location of the \\~supervisory organization\\~."
}
managementLevelRelatedView_7deab99f645f10000d69adf2c932005c
{
"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"
}
}
}
]
}
managementLevel_89a0b59e7cce1000074acb1d768e0158
{
"allOf": [
{
"$ref": "#/components/schemas/managementLevelRelatedView_7deab99f645f10000d69adf2c932005c"
},
{}
],
"description": "The management level for the job profile."
}
managerWorkerView_a02c2e1916fa10000cbb84be81ce0027
{
"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"
}
}
}
]
}
massActionHeader_cf97466f96d910002bd32afbf0000001
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "Returns the Mass Action Header instance."
}
massActionWorksheet_31485c9a93c0100007276cf4e5640000
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "Returns the Mass Action Worksheet instance."
}
orgChartView_643e3a12629710000554e0338e670044
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id of the instance"
},
"superior": {
"$ref": "#/components/schemas/superior_643e3a1262971000145238b2ccd10059"
},
"descriptor": {
"type": "string",
"example": "Lorem ipsum dolor sit ame",
"description": "A preview of the instance"
},
"subordinates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/supervisoryOrganizationView_a02c2e1916fa100009e137235f1f0018"
},
"description": "Contains the subordinate organizations that directly report to the organization.",
"x-workday-type": "Multi-instance"
}
}
}
]
}
organizationAssignmentChangesBusinessUnitData_5aabf8e28cb310002520b2a2b31d0365
{
"allOf": [
{
"type": "object",
"properties": {
"businessUnit": {
"$ref": "#/components/schemas/businessUnit_5aabf8e28cb310002520b2aabc470366"
}
}
}
]
}
organizationAssignmentChangesCompanyData_652d516fdff41000086e0b9c96950354
{
"allOf": [
{
"type": "object",
"properties": {
"company": {
"$ref": "#/components/schemas/company_56fe0dd0eca1100019cfe097d26a03f2"
}
}
}
]
}
organizationAssignmentChangesCostCenterData_5aabf8e28cb3100010a999db2700024e
{
"allOf": [
{
"type": "object",
"properties": {
"costCenter": {
"$ref": "#/components/schemas/costCenter_5aabf8e28cb3100010a999f40b07024f"
}
}
}
]
}
organizationAssignmentChangesCostingData_a18edb56aca0100014a4a09dc57e045a
{
"allOf": [
{
"type": "object",
"properties": {
"fund": {
"$ref": "#/components/schemas/fund_a18edb56aca0100014a4a0b27352045c"
},
"gift": {
"$ref": "#/components/schemas/gift_a18edb56aca0100014a4a0a9f876045b"
},
"grant": {
"$ref": "#/components/schemas/grant_a18edb56aca0100014a4a0bcf25c045e"
},
"program": {
"$ref": "#/components/schemas/program_a18edb56aca0100014a4a0b7ddf7045d"
}
}
}
]
}
organizationAssignmentChangesCustomOrganizationDetailsData_53cd2b632146100011e9bf4e7041551f
{
"allOf": [
{
"type": "object",
"properties": {
"customOrganizations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/customOrganizationDetails_3950e273020a100017857926d35d369c"
},
"description": "The new custom organizations for the worker as of the effective date.",
"x-workday-type": "Multi-instance"
}
}
}
]
}
organizationAssignmentChangesPostPosition_cf97466f96d9100029bffcf91c120000
{
"allOf": [
{
"type": "object",
"required": [
"date",
"position"
],
"properties": {
"id": {
"type": "string",
"description": "Id of the instance"
},
"date": {
"type": "string",
"format": "date",
"example": "2024-03-23T07:00:00.000Z",
"description": "The effective date of the business process event using the yyyy-mm-dd format.",
"x-workday-type": "Date"
},
"position": {
"$ref": "#/components/schemas/position_cf97466f96d9100029bffcf91c120001"
},
"descriptor": {
"type": "string",
"example": "Lorem ipsum dolor sit ame",
"description": "A preview of the instance"
},
"massActionHeader": {
"$ref": "#/components/schemas/massActionHeader_cf97466f96d910002bd32afbf0000001"
},
"massActionWorksheet": {
"$ref": "#/components/schemas/massActionWorksheet_31485c9a93c0100007276cf4e5640000"
}
}
}
]
}
organizationAssignmentChangesPost_cc45d62b623c1000132ac812c30a052e
{
"allOf": [
{
"type": "object",
"required": [
"date"
],
"properties": {
"id": {
"type": "string",
"description": "Id of the instance"
},
"date": {
"type": "string",
"format": "date",
"example": "2024-03-23T07:00:00.000Z",
"description": "The date this business process takes effect.",
"x-workday-type": "Date"
},
"position": {
"$ref": "#/components/schemas/position_99f6257185e61000043aadd66df203bb"
},
"descriptor": {
"type": "string",
"example": "Lorem ipsum dolor sit ame",
"description": "A preview of the instance"
}
}
}
]
}
organizationAssignmentChangesRegionData_a18edb56aca0100006997e68e5780373
{
"allOf": [
{
"type": "object",
"properties": {
"region": {
"$ref": "#/components/schemas/region_a18edb56aca0100006997ec7e07d0374"
}
}
}
]
}
organizationAssignmentChangesStartDetailsData_90009f2bfc49100017b10cd07d19063b
{
"allOf": [
{
"type": "object",
"required": [
"position"
],
"properties": {
"date": {
"type": "string",
"format": "date",
"example": "2024-03-23T07:00:00.000Z",
"description": "The date this business process takes effect.",
"x-workday-type": "Date",
"x-conditionally-readOnly": true,
"x-conditionally-required": true
},
"worker": {
"$ref": "#/components/schemas/worker_90009f2bfc4910001b166d44a72c0727"
},
"position": {
"$ref": "#/components/schemas/position_827372de4457100019c0e9c5977d0000"
},
"supervisoryOrganization": {
"$ref": "#/components/schemas/supervisoryOrganization_827372de445710001cfe36968a480000"
}
}
}
]
}
organizationType_3950e273020a100017857958e234369d
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "Includes these organization types: Company, Cost Center, Custom orgs, Location Hierarchy, Matrix, Pay Group, Region, Retiree, Supervisory."
}
overallBusinessProcess_5d688bd57bb910001815ab49927724aa
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"x-readOnly": true,
"description": "Returns the Top Level (overall) Business Process that this Event is part of or returns the same instance if this Event is not a sub-process."
}
participant_b3a69f47a49910001687de1d4c75003c
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "Participant of \\~check-in\\~."
}
participant_d81c816de26f10000f52144d053f001b
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "Participant of \\~topic\\~."
}
payRateTypeRelatedView_3b00708994e410000c52776049ba12c3
{
"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"
}
}
}
]
}
payRateType_3b00708994e410000c3d01aea96012c1
{
"allOf": [
{
"$ref": "#/components/schemas/payRateTypeRelatedView_3b00708994e410000c52776049ba12c3"
},
{}
],
"description": "The pay rate type for the job profile pay rate"
}
payRateType_d25283821c01100016756a14eb650000
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "The new pay rate type for the \\~worker\\~ as of the effective date.",
"x-conditionally-hidden": true,
"x-conditionally-required": true
}
personDataView_be343791f59d100028d6a277ca8a0017
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id of the instance"
},
"email": {
"type": "string",
"example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"description": "Returns the public primary work email address for the worker.",
"x-workday-type": "Text"
},
"phone": {
"type": "string",
"example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"description": "Returns the primary public work phone number for the worker.",
"x-workday-type": "Text"
}
}
}
]
}
person_0ad147648b0a1000237bd486634a001a
{
"allOf": [
{
"$ref": "#/components/schemas/personDataView_be343791f59d100028d6a277ca8a0017"
},
{}
],
"description": "Person for the \\~Worker\\~"
}
person_86093b8a932f10001499f38c72410130
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "Comment made by Person"
}
positionWorkerType_05d4c45042b610001030ee47f2c90118
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "The new position \\~worker\\~ type for the \\~worker\\~ as of the effective date.",
"x-conditionally-readOnly": true
}
position_827372de4457100019c0e9c5977d0000
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "The position element as the event target."
}
position_99f6257185e61000043aadd66df203bb
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "The new position for the \\~worker\\~ as of the effective date."
}
position_cf97466f96d9100029bffcf91c120001
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "The position element as the event target."
}
position_dfc4e58f730810001ad60369c23452d1
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "The new position or job for the \\~worker\\~ as of the effective date.",
"x-conditionally-hidden": true,
"x-conditionally-readOnly": true
}
primaryJob_352c3a97ecd51000353cba144c5b0042
{
"allOf": [
{
"$ref": "#/components/schemas/jobDataForWorker_b8ac205877fd10000ea91719a02a00a2"
},
{}
],
"description": "The \\~worker's\\~ primary job."
}
program_a18edb56aca0100014a4a0b7ddf7045d
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "The new program for the \\~worker\\~ after the business process.",
"x-conditionally-hidden": true,
"x-conditionally-required": true
}
purchaseOrder_2d0ca2cb2448100009c5433bcff60e05
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "Purchase Order for Staffing Event",
"x-conditionally-hidden": true
}
reason_6da81665c26510001f34d0a154765e9b
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "The business process type, reason category and reason associated with the business process (e.g. Hire \\~Employee\\~ > New Hire > New Position).",
"x-conditionally-readOnly": true
}
reason_85deac43cd1a10000b96c80c118f171e
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "The business process type, reason category and reason associated with the business process (e.g. Hire \\~Employee\\~ > New Hire > New Position)."
}
regionRelatedView_3b00708994e41000053151ffd9e31293
{
"allOf": [
{
"type": "object",
"properties": {
"descriptor": {
"type": "string",
"example": "Lorem ipsum dolor sit ame",
"description": "A preview of the instance"
}
}
}
]
}
region_a18edb56aca0100006997ec7e07d0374
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "The new region for the \\~worker\\~ as of the effective date.",
"x-conditionally-hidden": true,
"x-conditionally-required": true
}
serviceDatesData_6b1db753fd82100027b0c8519c860018
{
"allOf": [
{
"type": "object",
"properties": {
"hireDate": {
"type": "string",
"format": "date",
"example": "2020-01-20T16:00:00.000Z",
"description": "The worker's most recent hire date.",
"x-workday-type": "Date"
},
"continuousServiceDate": {
"type": "string",
"format": "date",
"example": "2020-01-20T16:00:00.000Z",
"description": "Worker service date taking into account breaks in service.",
"x-workday-type": "Date"
}
}
}
]
}
skillItemAddDefinition_faed9891d75a10001e9a289910540228
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id of the instance"
},
"remoteID": {
"type": "string",
"example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"description": "The remote skill ID of a skill.",
"x-workday-type": "Text"
},
"skillItem": {
"$ref": "#/components/schemas/skillItem_4b4b7d34b4a210001c7927f9e1330080"
},
"skillName": {
"type": "string",
"example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"description": "The skill name that Workday bases similar skill suggestions on.",
"x-workday-type": "Text"
}
}
}
]
}
skillItemAddRepresentation_c5fabc4ca81610000eaeb4ff2f000137
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id of the instance"
},
"remoteID": {
"type": "string",
"example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"description": "The remote skill ID of a skill.",
"x-workday-type": "Text"
},
"skillName": {
"type": "string",
"example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"description": "The skill name Workday returns.",
"x-workday-type": "Text"
}
}
}
]
}
skillItemDisplayDefinition_4b4b7d34b4a21000301eaf52086700d8
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id of the instance"
},
"remoteID": {
"type": "string",
"example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"description": "The remote skill ID of a skill.",
"x-workday-type": "Text"
},
"skillName": {
"type": "string",
"example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"description": "The skill name that Workday bases similar skill suggestions on.",
"x-workday-type": "Text"
},
"descriptor": {
"type": "string",
"example": "Lorem ipsum dolor sit ame",
"description": "A preview of the instance"
}
}
}
]
}
skillItemSourceAddRepresentation_c5fabc4ca81610000d5d15309ac90122
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id of the instance"
},
"skillSource": {
"$ref": "#/components/schemas/skillSource_c5fabc4ca81610000d5d154e6e3c0123"
}
}
}
]
}
skillItem_4b4b7d34b4a210001c7927f9e1330080
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
]
}
skillItem_98f198f5056b100019631445471d225f
{
"allOf": [
{
"$ref": "#/components/schemas/skillItemAddRepresentation_c5fabc4ca81610000eaeb4ff2f000137"
},
{}
],
"description": "a set containing no instances"
}
skillItem_d6ca778018011000182fa5f3b32001aa
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "Indicates the skill item name"
}
skillItemsBulkDefinition_9d815bbfd67010000d6ed56204ab12de
{
"allOf": [
{
"type": "object",
"properties": {
"skillItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/skillItemAddDefinition_faed9891d75a10001e9a289910540228"
},
"description": "Exposes Skill Items for a Skill Qualification Enabled.",
"x-workday-type": "Multi-instance"
}
}
}
]
}
skillSourceRepresentation_998d2cc58f2f10000db59b08da0306a8
{
"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"
},
"sourceType": {
"type": "string",
"example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"description": "The Source Type of this Skill Item Source",
"x-workday-type": "Text"
},
"dateCreated": {
"type": "string",
"format": "date",
"example": "2024-03-23T07:00:00.000Z",
"description": "The Creation Date of this Skill Item Source",
"x-workday-type": "Date"
},
"sourceTypeID": {
"type": "string",
"example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"maxLength": 36,
"description": "source type ID",
"x-workday-type": "Text"
}
}
}
]
}
skillSource_c5fabc4ca81610000d5d154e6e3c0123
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "a set containing no instances"
}
status_54e611eca2c910000fbc4599be0b0112
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "Transaction status or workflow state for an event. Example: Successfully Completed, Denied, Terminated"
}
superior_643e3a1262971000145238b2ccd10059
{
"allOf": [
{
"$ref": "#/components/schemas/supervisoryOrganizationView_a02c2e1916fa100009e137235f1f0018"
},
{}
],
"description": "The immediate superior organization for the organization."
}
supervisoryOrganizationJobView_fab4a151b24810000d29746fb7e21259
{
"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"
}
}
}
]
}
supervisoryOrganizationView_a02c2e1916fa100009e137235f1f0018
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id of the instance"
},
"code": {
"type": "string",
"example": "Sample-Code",
"description": "The organization id for the organization.",
"x-workday-type": "Text"
},
"name": {
"type": "string",
"example": "Sample Organization Name",
"description": "Returns the name of the organization as of the processing effective moment",
"x-workday-type": "Text"
},
"inactive": {
"type": "boolean",
"example": true,
"description": "Indicates whether the organization is inactive",
"x-workday-type": "Boolean"
},
"managers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/managerWorkerView_a02c2e1916fa10000cbb84be81ce0027"
},
"description": "The manager(s) for the supervisory organization.",
"x-workday-type": "Multi-instance"
},
"descriptor": {
"type": "string",
"example": "Lorem ipsum dolor sit ame",
"description": "A preview of the instance"
}
}
}
]
}
supervisoryOrganization_75e528a78e9a10000ab75132a9df0116
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "The \\~supervisory organization\\~ for the \\~worker\\~ as of the effective date."
}
supervisoryOrganization_827372de445710001cfe36968a480000
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"x-readOnly": true,
"description": "\\~Supervisory Organization\\~ for staffing interface affected, as of the event effective date."
}
supervisoryOrganization_b8ac205877fd10000ea91743659800a7
{
"allOf": [
{
"$ref": "#/components/schemas/supervisoryOrganizationJobView_fab4a151b24810000d29746fb7e21259"
},
{}
],
"description": "The \\~supervisory organization\\~ for the position."
}
supervisoryOrganization_e3267ea37e6f100032c00c34a99e74d8
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "The \\~supervisory organization\\~ for the \\~worker\\~ as of the effective date.",
"x-conditionally-readOnly": true,
"x-conditionally-required": true
}
supervisoryOrganization_fab4a151b24810000d13073c5d341257
{
"allOf": [
{
"$ref": "#/components/schemas/supervisoryOrganizationJobView_fab4a151b24810000d29746fb7e21259"
},
{}
],
"description": "The \\~supervisory organization\\~ for the position."
}
template_2b1b95dfe4af100007f63081aec5158e
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "The Change Job Template used to initiate the Change Job event."
}
template_2b1b95dfe4af100009f30dc769a31686
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"x-readOnly": true,
"description": "The Change Job Template used to initiate the Change Job event."
}
timeType_05d4c45042b610000bb540b7458e0108
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "The new time type for the \\~worker\\~ as of the effective date.",
"x-conditionally-readOnly": true
}
transactionStatus_7457adcbe0fa1000089b63ab3a510000
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "Transaction status or workflow state for an event. Example: Successfully Completed, Denied, Terminated"
}
uploadedBy_b32ff437243510000e22e06470370160
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"x-readOnly": true,
"description": "Returns the primary Role of the person who uploaded the Attachment."
}
workContactChangeEvent_5fca6c96c1c81000142fd03784140113
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id of the instance"
},
"href": {
"type": "string",
"example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"description": "The URL to the related change work contact information resource where this event can be interacted with via REST.",
"x-workday-type": "Text"
},
"descriptor": {
"type": "string",
"example": "Lorem ipsum dolor sit ame",
"description": "A preview of the instance"
},
"effective_date": {
"type": "string",
"format": "date",
"example": "2024-03-23T07:00:00.000Z",
"description": "The date this business process takes effect.",
"x-workday-type": "Date"
}
}
}
]
}
workShift_0ee7bb8b41db1000143d4e4822174f2e
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "The new work shift for the \\~worker\\~ as of the effective date.",
"x-conditionally-hidden": true,
"x-conditionally-required": true
}
workSpace_0ee7bb8b41db10001e7db6a6c3e55663
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "The new work space for the \\~worker\\~ as of the effective date.",
"x-conditionally-hidden": true,
"x-conditionally-required": true
}
workSpace_426ac445037110001b3eb91ddf6f0100
{
"allOf": [
{
"$ref": "#/components/schemas/jobWorkspaceData_1005157e3d631000144205466a6c13d3"
},
{}
],
"description": "The work space associated with the position."
}
workStudy_05d4c45042b610000ba2f83c70f30101
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "Work-Study award proposed for Staffing Event",
"x-conditionally-hidden": true,
"x-conditionally-required": true
}
workerData_c2466b0778c610000d1936006720000e
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id of the instance"
},
"person": {
"$ref": "#/components/schemas/person_0ad147648b0a1000237bd486634a001a"
},
"workerId": {
"type": "string",
"example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"description": "The Employee ID or Contingent Worker ID for the worker.",
"x-workday-type": "Text"
},
"descriptor": {
"type": "string",
"example": "Lorem ipsum dolor sit ame",
"description": "A preview of the instance"
},
"primaryJob": {
"$ref": "#/components/schemas/primaryJob_352c3a97ecd51000353cba144c5b0042"
},
"workerType": {
"$ref": "#/components/schemas/workerType_3f78eeedc01d1000138d97d80e5a0000"
},
"additionalJobs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jobDataForWorker_b8ac205877fd10000ea91719a02a00a2"
},
"description": "The employee’s additional jobs and international assignments.",
"x-workday-type": "Multi-instance"
}
}
}
]
}
workerJobView_fab4a151b24810000e7ff8d0c7f0126d
{
"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"
}
}
}
]
}
workerType_3f78eeedc01d1000138d97d80e5a0000
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "Return \\~Worker\\~ Types for \\~Worker\\~"
}
worker_271bbd673582100010110b9f9a6d99e1
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"x-readOnly": true,
"description": "The \\~worker\\~ associated with the business process."
}
worker_90009f2bfc4910001b166d44a72c0727
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"x-readOnly": true,
"description": "The \\~worker\\~ associated with the business process."
}
worker_fab4a151b24810000e66f769304c126b
{
"allOf": [
{
"$ref": "#/components/schemas/workerJobView_fab4a151b24810000e7ff8d0c7f0126d"
},
{}
],
"description": "The position management \\~worker\\~ filling the position. If the position is overlapped, return the \\~worker\\~ for the overlap position."
}
workersCompensationCodeOverride_05d4c45042b61000138500e185e0013f
{
"allOf": [
{
"$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
},
{}
],
"description": "\\~Worker's\\~ compensation code override for staffing event.",
"x-conditionally-hidden": true,
"x-conditionally-required": true
}
workersCompensationCodeRelatedView_3b00708994e4100004af13d958811287
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id of the instance"
},
"code": {
"type": "string",
"example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"description": "Returns the workers' compensation code.",
"x-workday-type": "Text"
},
"name": {
"type": "string",
"example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"description": "Returns the description of the worker's compensation code.",
"x-workday-type": "Text"
},
"country": {
"$ref": "#/components/schemas/country_3b00708994e4100004edeb4e0d37128c"
},
"regions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/regionRelatedView_3b00708994e41000053151ffd9e31293"
},
"description": "Returns the Country Regions that the worker's compensation code is used in.",
"x-workday-type": "Multi-instance"
},
"inactive": {
"type": "boolean",
"example": true,
"description": "Returns true if the worker's compensation code is inactive.",
"x-workday-type": "Boolean"
},
"locations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/locationDataJobView_6d3eb084b4c410002b5fa13f0c9d0056"
},
"description": "The location for the worker compensation code.",
"x-workday-type": "Multi-instance"
},
"descriptor": {
"type": "string",
"example": "Lorem ipsum dolor sit ame",
"description": "A preview of the instance"
}
}
}
]
}