staffing

Workday staffing and workforce management API

community.workday.com/api ↗

Version

OpenAPI

3.0.0

Endpoints

144

Schemas

214

93

Quality

Updated

3 days ago

Hr hr workforce enterprise

Use this API in your AI agent

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

Get API Key

Server URLs

https://<tenantHostname>/staffing/v6

Endpoints

Clear filters

GET POST PUT PATCH DELETE

Jobchanges 23 endpoints

GET /jobChanges/{ID} Retrieves a single change job event instance.

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

operationId: JobChanges_getById

Parameters

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

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /jobChanges/{ID}

GET /jobChanges/{ID}/administrative Retrieves the administrative options for the specified job change ID.

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

operationId: JobChanges_getAdministrativeOptions

Parameters

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.

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /jobChanges/{ID}/administrative

GET /jobChanges/{ID}/administrative/{subresourceID} Retrieves the administrative options for the specified job change ID.

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

operationId: JobChanges_getAdminOptions

Parameters

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

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /jobChanges/{ID}/administrative/{subresourceID}

GET /jobChanges/{ID}/businessTitle Retrieves a business title for the specified job change ID.

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

operationId: JobChanges_getBusinessTitle

Parameters

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.

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /jobChanges/{ID}/businessTitle

GET /jobChanges/{ID}/businessTitle/{subresourceID} Retrieves a business title for the specified job change ID.

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

operationId: JobChanges_getBusinessTitle

Parameters

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

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /jobChanges/{ID}/businessTitle/{subresourceID}

GET /jobChanges/{ID}/comment Returns the comment information for the specified job change ID.

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

operationId: JobChanges_getCommentById

Parameters

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.

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /jobChanges/{ID}/comment

GET /jobChanges/{ID}/comment/{subresourceID} Returns the comment information for the specified job change ID.

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

operationId: JobChanges_getCommentInfo

Parameters

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

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /jobChanges/{ID}/comment/{subresourceID}

GET /jobChanges/{ID}/contract Retrieves the contract options for the specified change job ID.

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

operationId: JobChanges_getContractOptions

Parameters

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.

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /jobChanges/{ID}/contract

GET /jobChanges/{ID}/contract/{subresourceID} Retrieves the contract options for the specified change job ID.

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

operationId: JobChanges_getContractOptions

Parameters

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

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /jobChanges/{ID}/contract/{subresourceID}

GET /jobChanges/{ID}/jobClassification Retrieves a job classification for the specified job change ID.

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

operationId: JobChanges_getJobClassification

Parameters

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.

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /jobChanges/{ID}/jobClassification

GET /jobChanges/{ID}/jobClassification/{subresourceID} Retrieves a job classification for the specified job change ID.

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

operationId: JobChanges_getJobClassification

Parameters

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

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /jobChanges/{ID}/jobClassification/{subresourceID}

GET /jobChanges/{ID}/jobProfile Retrieves a job profile for the specified job change ID.

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

operationId: JobChanges_getJobProfile

Parameters

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.

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /jobChanges/{ID}/jobProfile

GET /jobChanges/{ID}/jobProfile/{subresourceID} Retrieves a job profile for the specified job change ID.

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

operationId: JobChanges_getProfile

Parameters

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

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /jobChanges/{ID}/jobProfile/{subresourceID}

GET /jobChanges/{ID}/location Returns the location information for the specified job change ID.

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

operationId: JobChanges_getLocationInfo

Parameters

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.

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /jobChanges/{ID}/location

GET /jobChanges/{ID}/location/{subresourceID} Returns the location information for the specified job change ID.

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

operationId: JobChanges_getLocationInfo

Parameters

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

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /jobChanges/{ID}/location/{subresourceID}

GET /jobChanges/{ID}/moveTeam Retrieves a move team option from the specified job change ID.

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

operationId: JobChanges_getMoveTeamOption

Parameters

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.

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /jobChanges/{ID}/moveTeam

GET /jobChanges/{ID}/moveTeam/{subresourceID} Retrieves a move team option from the specified job change ID.

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

operationId: JobChanges_getMoveTeamOption

Parameters

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

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /jobChanges/{ID}/moveTeam/{subresourceID}

GET /jobChanges/{ID}/opening Retrieves the opening options for the specified job change ID.

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

operationId: JobChanges_getOpeningOptions

Parameters

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.

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /jobChanges/{ID}/opening

GET /jobChanges/{ID}/opening/{subresourceID} Retrieves the opening options for the specified job change ID.

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

operationId: JobChanges_getOpeningOptions

Parameters

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

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /jobChanges/{ID}/opening/{subresourceID}

GET /jobChanges/{ID}/position Retrieves a position for the specified job change ID.

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

operationId: JobChanges_getPositionById

Parameters

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.

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /jobChanges/{ID}/position

GET /jobChanges/{ID}/position/{subresourceID} Retrieves a position for the specified job change ID.

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

operationId: JobChanges_getPositionBySubresourceId

Parameters

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

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /jobChanges/{ID}/position/{subresourceID}

GET /jobChanges/{ID}/startDetails Retrieves the start details for the specified job change ID.

Retrieves the start details for the specified job change ID.

Secured by: Staffing Actions: Change Job Date and Reason

Scope: Staffing

operationId: JobChanges_getStartDetails

Parameters

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.

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /jobChanges/{ID}/startDetails

GET /jobChanges/{ID}/startDetails/{subresourceID} Retrieves the start details for the specified job change ID.

Retrieves the start details for the specified job change ID.

Secured by: Staffing Actions: Change Job Date and Reason

Scope: Staffing

operationId: JobChanges_getStartDetails

Parameters

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

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /jobChanges/{ID}/startDetails/{subresourceID}

Jobfamilies 2 endpoints

GET /jobFamilies Retrieves a collection of job families.

Retrieves a collection of job families.

Secured by: Job Information

Scope: Jobs & Positions

operationId: JobFamilies_list

Parameters

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.

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /jobFamilies

GET /jobFamilies/{ID} Retrieves a single job family instance.

Retrieves a job family with the specified ID.

Secured by: Job Information

Scope: Jobs & Positions

operationId: JobFamilies_getById

Parameters

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

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /jobFamilies/{ID}

Jobprofiles 2 endpoints

GET /jobProfiles Retrieves a collection of job profiles.

Retrieves a collection of job profiles.

Secured by: Job Profile: View, Public Job: View

Scope: Jobs & Positions

operationId: JobProfiles_listCollection

Parameters

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.

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /jobProfiles

GET /jobProfiles/{ID} Retrieves a single job profile instance.

Retrieves a job profile with the specified ID.

Secured by: Job Profile: View, Public Job: View

Scope: Jobs & Positions

operationId: JobProfiles_getById

Parameters

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

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /jobProfiles/{ID}

Jobs 4 endpoints

GET /jobs Retrieves a collection of jobs.

Retrieves a collection of jobs.

Secured by: Worker Position: View

Scope: Staffing

operationId: Jobs_getCollection

Parameters

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.

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /jobs

GET /jobs/{ID} Retrieves a single job instance.

Retrieves a job with the specified job ID.

Secured by: Worker Position: View

Scope: Staffing

operationId: Jobs_getJobById

Parameters

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

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /jobs/{ID}

GET /jobs/{ID}/workspace Retrieves a collection of workspaces for the specified job ID.

Retrieves a collection of workspaces for the specified job ID.

Secured by: Worker Data: Public Worker Reports

Scope: Staffing

operationId: Jobs_getWorkspaces

Parameters

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.

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /jobs/{ID}/workspace

GET /jobs/{ID}/workspace/{subresourceID} Retrieves a single workspace instance.

Retrieves a single workspace for the specified job ID.

Secured by: Worker Data: Public Worker Reports

Scope: Staffing

operationId: Jobs_getWorkspace

Parameters

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

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /jobs/{ID}/workspace/{subresourceID}

Organizationassignmentchanges 17 endpoints

GET /organizationAssignmentChanges/{ID} Retrieves a single organization assignment change event instance.

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

operationId: OrganizationAssignmentChanges_getInstance

Parameters

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

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /organizationAssignmentChanges/{ID}

GET /organizationAssignmentChanges/{ID}/businessUnit Retrieves a business unit for the specified organization assignment change ID.

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

operationId: OrganizationAssignmentChanges_getBusinessUnit

Parameters

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.

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /organizationAssignmentChanges/{ID}/businessUnit

GET /organizationAssignmentChanges/{ID}/businessUnit/{subresourceID} Retrieves a business unit for the specified organization assignment change ID.

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

operationId: OrganizationAssignmentChanges_getBusinessUnit

Parameters

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

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /organizationAssignmentChanges/{ID}/businessUnit/{subresourceID}

GET /organizationAssignmentChanges/{ID}/comment Retrieves the comment information for the specified organization assignment change ID.

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

operationId: OrganizationAssignmentChanges_getComment

Parameters

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.

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /organizationAssignmentChanges/{ID}/comment

GET /organizationAssignmentChanges/{ID}/comment/{subresourceID} Retrieves the comment information for the specified organization assignment change ID.

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

operationId: OrganizationAssignmentChanges_getCommentInfo

Parameters

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

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /organizationAssignmentChanges/{ID}/comment/{subresourceID}

GET /organizationAssignmentChanges/{ID}/company Retrieves a company for the specified organization assignment change ID.

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

operationId: OrganizationAssignmentChanges_getCompany

Parameters

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.

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /organizationAssignmentChanges/{ID}/company

GET /organizationAssignmentChanges/{ID}/company/{subresourceID} Retrieves a company for the specified organization assignment change ID.

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

operationId: OrganizationAssignmentChanges_getCompanyById

Parameters

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

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /organizationAssignmentChanges/{ID}/company/{subresourceID}

GET /organizationAssignmentChanges/{ID}/costCenter Retrieves a cost center for the specified organization assignment change ID.

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

operationId: OrganizationAssignmentChanges_getCostCenter

Parameters

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.

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /organizationAssignmentChanges/{ID}/costCenter

GET /organizationAssignmentChanges/{ID}/costCenter/{subresourceID} Retrieves a cost center for the specified organization assignment change ID.

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

operationId: OrganizationAssignmentChanges_getCostCenter

Parameters

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

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /organizationAssignmentChanges/{ID}/costCenter/{subresourceID}

GET /organizationAssignmentChanges/{ID}/costing Retrieves the costing organizations for the specified organization assignment change ID.

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

operationId: OrganizationAssignmentChanges_getCostingOrganizations

Parameters

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.

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /organizationAssignmentChanges/{ID}/costing

GET /organizationAssignmentChanges/{ID}/costing/{subresourceID} Retrieves the costing organizations for the specified organization assignment change ID.

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

Scope: Staffing

operationId: OrganizationAssignmentChanges_getCostingOrganizations

Parameters

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

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /organizationAssignmentChanges/{ID}/costing/{subresourceID}

GET /organizationAssignmentChanges/{ID}/customOrganizations Retrieves the custom organizations for the specified organization assignment change ID.

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

operationId: OrganizationAssignmentChanges_getCustomOrganizations

Parameters

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.

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /organizationAssignmentChanges/{ID}/customOrganizations

GET /organizationAssignmentChanges/{ID}/customOrganizations/{subresourceID} Retrieves the custom organizations for the specified organization assignment change ID.

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

operationId: OrganizationAssignmentChanges_getCustomOrganizations

Parameters

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

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /organizationAssignmentChanges/{ID}/customOrganizations/{subresourceID}

GET /organizationAssignmentChanges/{ID}/region Retrieves a region for the specified organization assignment change ID.

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

operationId: OrganizationAssignmentChanges_getRegion

Parameters

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.

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /organizationAssignmentChanges/{ID}/region

GET /organizationAssignmentChanges/{ID}/region/{subresourceID} Retrieves a region for the specified organization assignment change ID.

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

operationId: OrganizationAssignmentChanges_getRegionById

Parameters

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

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /organizationAssignmentChanges/{ID}/region/{subresourceID}

GET /organizationAssignmentChanges/{ID}/startDetails Retrieves the start details for the specified organization assignment change ID.

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

operationId: OrganizationAssignmentChanges_getStartDetails

Parameters

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.

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /organizationAssignmentChanges/{ID}/startDetails

GET /organizationAssignmentChanges/{ID}/startDetails/{subresourceID} Retrieves the start details for the specified organization assignment change ID.

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

operationId: OrganizationAssignmentChanges_getStartDetails

Parameters

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

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /organizationAssignmentChanges/{ID}/startDetails/{subresourceID}

Promptvalues 36 endpoints

GET /values/jobChangesGroup/assignmentTypes

Retrieves instances that can be used as values for other endpoint parameters in this service.

operationId: PromptValues_getAssignmentTypes

Parameters

Name	In	Required	Type	Description
effectiveDate	query	optional	string	—
job	query	optional	string	—
limit	query	optional	integer	The maximum number of objects in a single response. The default and maximum is 1000.
location	query	optional	string	—
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.
proposedManager	query	optional	array	—
staffingEvent	query	optional	string	—
worker	query	optional	string	—

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /values/jobChangesGroup/assignmentTypes

GET /values/jobChangesGroup/companyInsiderTypes

Retrieves instances that can be used as values for other endpoint parameters in this service.

operationId: PromptValues_getCompanyInsiderTypes

Parameters

Name	In	Required	Type	Description
effectiveDate	query	optional	string	—
job	query	optional	string	—
limit	query	optional	integer	The maximum number of objects in a single response. The default and maximum is 1000.
location	query	optional	string	—
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.
proposedManager	query	optional	array	—
staffingEvent	query	optional	string	—
worker	query	optional	string	—

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /values/jobChangesGroup/companyInsiderTypes

GET /values/jobChangesGroup/contingentWorkerTypes

Retrieves instances that can be used as values for other endpoint parameters in this service.

operationId: PromptValues_getContingentWorkerTypes

Parameters

Name	In	Required	Type	Description
effectiveDate	query	optional	string	—
job	query	optional	string	—
limit	query	optional	integer	The maximum number of objects in a single response. The default and maximum is 1000.
location	query	optional	string	—
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.
proposedManager	query	optional	array	—
staffingEvent	query	optional	string	—
worker	query	optional	string	—

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /values/jobChangesGroup/contingentWorkerTypes

GET /values/jobChangesGroup/currencies

Retrieves instances that can be used as values for other endpoint parameters in this service.

operationId: PromptValues_getCurrencyInstances

Parameters

Name	In	Required	Type	Description
effectiveDate	query	optional	string	—
job	query	optional	string	—
limit	query	optional	integer	The maximum number of objects in a single response. The default and maximum is 1000.
location	query	optional	string	—
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.
proposedManager	query	optional	array	—
staffingEvent	query	optional	string	—
worker	query	optional	string	—

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /values/jobChangesGroup/currencies

GET /values/jobChangesGroup/employeeTypes

Retrieves instances that can be used as values for other endpoint parameters in this service.

operationId: PromptValues_getEmployeeTypes

Parameters

Name	In	Required	Type	Description
effectiveDate	query	optional	string	—
job	query	optional	string	—
limit	query	optional	integer	The maximum number of objects in a single response. The default and maximum is 1000.
location	query	optional	string	—
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.
proposedManager	query	optional	array	—
staffingEvent	query	optional	string	—
worker	query	optional	string	—

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /values/jobChangesGroup/employeeTypes

GET /values/jobChangesGroup/frequencies

Retrieves instances that can be used as values for other endpoint parameters in this service.

operationId: PromptValues_getInstances

Parameters

Name	In	Required	Type	Description
effectiveDate	query	optional	string	—
job	query	optional	string	—
limit	query	optional	integer	The maximum number of objects in a single response. The default and maximum is 1000.
location	query	optional	string	—
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.
proposedManager	query	optional	array	—
staffingEvent	query	optional	string	—
worker	query	optional	string	—

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /values/jobChangesGroup/frequencies

GET /values/jobChangesGroup/headcountOptions

Retrieves instances that can be used as values for other endpoint parameters in this service.

operationId: PromptValues_getOptions

Parameters

Name	In	Required	Type	Description
effectiveDate	query	optional	string	—
job	query	optional	string	—
limit	query	optional	integer	The maximum number of objects in a single response. The default and maximum is 1000.
location	query	optional	string	—
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.
proposedManager	query	optional	array	—
staffingEvent	query	optional	string	—
worker	query	optional	string	—

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /values/jobChangesGroup/headcountOptions

GET /values/jobChangesGroup/jobClassifications

Retrieves instances that can be used as values for other endpoint parameters in this service.

operationId: PromptValues_getInstances

Parameters

Name	In	Required	Type	Description
effectiveDate	query	optional	string	—
job	query	optional	string	—
limit	query	optional	integer	The maximum number of objects in a single response. The default and maximum is 1000.
location	query	optional	string	—
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.
proposedManager	query	optional	array	—
staffingEvent	query	optional	string	—
worker	query	optional	string	—

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /values/jobChangesGroup/jobClassifications

GET /values/jobChangesGroup/jobProfiles

Retrieves instances that can be used as values for other endpoint parameters in this service.

operationId: PromptValues_getInstances

Parameters

Name	In	Required	Type	Description
effectiveDate	query	optional	string	—
job	query	optional	string	—
limit	query	optional	integer	The maximum number of objects in a single response. The default and maximum is 1000.
location	query	optional	string	—
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.
proposedManager	query	optional	array	—
staffingEvent	query	optional	string	—
worker	query	optional	string	—

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /values/jobChangesGroup/jobProfiles

GET /values/jobChangesGroup/jobRequisitions

Retrieves instances that can be used as values for other endpoint parameters in this service.

operationId: PromptValues_getInstances

Parameters

Name	In	Required	Type	Description
effectiveDate	query	optional	string	—
job	query	optional	string	—
limit	query	optional	integer	The maximum number of objects in a single response. The default and maximum is 1000.
location	query	optional	string	—
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.
proposedManager	query	optional	array	—
staffingEvent	query	optional	string	—
worker	query	optional	string	—

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /values/jobChangesGroup/jobRequisitions

GET /values/jobChangesGroup/jobs

Retrieves instances that can be used as values for other endpoint parameters in this service.

operationId: PromptValues_getInstances

Parameters

Name	In	Required	Type	Description
effectiveDate	query	optional	string	—
job	query	optional	string	—
limit	query	optional	integer	The maximum number of objects in a single response. The default and maximum is 1000.
location	query	optional	string	—
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.
proposedManager	query	optional	array	—
staffingEvent	query	optional	string	—
worker	query	optional	string	—

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /values/jobChangesGroup/jobs

GET /values/jobChangesGroup/locations

Retrieves instances that can be used as values for other endpoint parameters in this service.

operationId: PromptValues_availableLocations

Parameters

Name	In	Required	Type	Description
effectiveDate	query	optional	string	—
job	query	optional	string	—
limit	query	optional	integer	The maximum number of objects in a single response. The default and maximum is 1000.
location	query	optional	string	—
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.
proposedManager	query	optional	array	—
staffingEvent	query	optional	string	—
worker	query	optional	string	—

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /values/jobChangesGroup/locations

GET /values/jobChangesGroup/payRateTypes

Retrieves instances that can be used as values for other endpoint parameters in this service.

operationId: PromptValues_getInstances

Parameters

Name	In	Required	Type	Description
effectiveDate	query	optional	string	—
job	query	optional	string	—
limit	query	optional	integer	The maximum number of objects in a single response. The default and maximum is 1000.
location	query	optional	string	—
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.
proposedManager	query	optional	array	—
staffingEvent	query	optional	string	—
worker	query	optional	string	—

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /values/jobChangesGroup/payRateTypes

GET /values/jobChangesGroup/proposedPosition

Retrieves instances that can be used as values for other endpoint parameters in this service.

operationId: PromptValues_getProposedPositions

Parameters

Name	In	Required	Type	Description
effectiveDate	query	optional	string	—
job	query	optional	string	—
limit	query	optional	integer	The maximum number of objects in a single response. The default and maximum is 1000.
location	query	optional	string	—
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.
proposedManager	query	optional	array	—
staffingEvent	query	optional	string	—
worker	query	optional	string	—

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /values/jobChangesGroup/proposedPosition

GET /values/jobChangesGroup/reason

Retrieves instances that can be used as values for other endpoint parameters in this service.

operationId: PromptValues_getInstances

Parameters

Name	In	Required	Type	Description
effectiveDate	query	optional	string	—
job	query	optional	string	—
limit	query	optional	integer	The maximum number of objects in a single response. The default and maximum is 1000.
location	query	optional	string	—
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.
proposedManager	query	optional	array	—
staffingEvent	query	optional	string	—
worker	query	optional	string	—

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /values/jobChangesGroup/reason

GET /values/jobChangesGroup/supervisoryOrganization

Retrieves instances that can be used as values for other endpoint parameters in this service.

operationId: PromptValues_getSupervisoryOrgValues

Parameters

Name	In	Required	Type	Description
effectiveDate	query	optional	string	—
job	query	optional	string	—
limit	query	optional	integer	The maximum number of objects in a single response. The default and maximum is 1000.
location	query	optional	string	—
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.
proposedManager	query	optional	array	—
staffingEvent	query	optional	string	—
worker	query	optional	string	—

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /values/jobChangesGroup/supervisoryOrganization

GET /values/jobChangesGroup/templates

Retrieves instances that can be used as values for other endpoint parameters in this service.

operationId: PromptValues_getInstances

Parameters

Name	In	Required	Type	Description
effectiveDate	query	optional	string	—
job	query	optional	string	—
limit	query	optional	integer	The maximum number of objects in a single response. The default and maximum is 1000.
location	query	optional	string	—
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.
proposedManager	query	optional	array	—
staffingEvent	query	optional	string	—
worker	query	optional	string	—

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /values/jobChangesGroup/templates

GET /values/jobChangesGroup/timeTypes

Retrieves instances that can be used as values for other endpoint parameters in this service.

operationId: PromptValues_getTimeTypes

Parameters

Name	In	Required	Type	Description
effectiveDate	query	optional	string	—
job	query	optional	string	—
limit	query	optional	integer	The maximum number of objects in a single response. The default and maximum is 1000.
location	query	optional	string	—
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.
proposedManager	query	optional	array	—
staffingEvent	query	optional	string	—
worker	query	optional	string	—

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /values/jobChangesGroup/timeTypes

GET /values/jobChangesGroup/workShifts

Retrieves instances that can be used as values for other endpoint parameters in this service.

operationId: PromptValues_getInstances

Parameters

Name	In	Required	Type	Description
effectiveDate	query	optional	string	—
job	query	optional	string	—
limit	query	optional	integer	The maximum number of objects in a single response. The default and maximum is 1000.
location	query	optional	string	—
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.
proposedManager	query	optional	array	—
staffingEvent	query	optional	string	—
worker	query	optional	string	—

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /values/jobChangesGroup/workShifts

GET /values/jobChangesGroup/workSpaces

Retrieves instances that can be used as values for other endpoint parameters in this service.

operationId: PromptValues_getWorkspaceInstances

Parameters

Name	In	Required	Type	Description
effectiveDate	query	optional	string	—
job	query	optional	string	—
limit	query	optional	integer	The maximum number of objects in a single response. The default and maximum is 1000.
location	query	optional	string	—
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.
proposedManager	query	optional	array	—
staffingEvent	query	optional	string	—
worker	query	optional	string	—

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /values/jobChangesGroup/workSpaces

GET /values/jobChangesGroup/workStudyAwards

Retrieves instances that can be used as values for other endpoint parameters in this service.

operationId: PromptValues_getInstances

Parameters

Name	In	Required	Type	Description
effectiveDate	query	optional	string	—
job	query	optional	string	—
limit	query	optional	integer	The maximum number of objects in a single response. The default and maximum is 1000.
location	query	optional	string	—
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.
proposedManager	query	optional	array	—
staffingEvent	query	optional	string	—
worker	query	optional	string	—

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /values/jobChangesGroup/workStudyAwards

GET /values/jobChangesGroup/workerTypes

Retrieves instances that can be used as values for other endpoint parameters in this service.

operationId: PromptValues_getWorkerTypes

Parameters

Name	In	Required	Type	Description
effectiveDate	query	optional	string	—
job	query	optional	string	—
limit	query	optional	integer	The maximum number of objects in a single response. The default and maximum is 1000.
location	query	optional	string	—
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.
proposedManager	query	optional	array	—
staffingEvent	query	optional	string	—
worker	query	optional	string	—

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /values/jobChangesGroup/workerTypes

GET /values/jobChangesGroup/workers

Retrieves instances that can be used as values for other endpoint parameters in this service.

operationId: PromptValues_getInstances

Parameters

Name	In	Required	Type	Description
effectiveDate	query	optional	string	—
job	query	optional	string	—
limit	query	optional	integer	The maximum number of objects in a single response. The default and maximum is 1000.
location	query	optional	string	—
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.
proposedManager	query	optional	array	—
staffingEvent	query	optional	string	—
worker	query	optional	string	—

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /values/jobChangesGroup/workers

GET /values/jobChangesGroup/workersCompensationCodeOverrides

Retrieves instances that can be used as values for other endpoint parameters in this service.

operationId: PromptValues_getInstances

Parameters

Name	In	Required	Type	Description
effectiveDate	query	optional	string	—
job	query	optional	string	—
limit	query	optional	integer	The maximum number of objects in a single response. The default and maximum is 1000.
location	query	optional	string	—
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.
proposedManager	query	optional	array	—
staffingEvent	query	optional	string	—
worker	query	optional	string	—

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /values/jobChangesGroup/workersCompensationCodeOverrides

GET /values/organizationAssignmentChangesGroup/businessUnits

Retrieves instances that can be used as values for other endpoint parameters in this service.

operationId: PromptValues_getInstances

Parameters

Name	In	Required	Type	Description
effectiveDate	query	optional	string	—
event	query	optional	string	—
limit	query	optional	integer	The maximum number of objects in a single response. The default and maximum is 1000.
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.
organizationType	query	optional	string	—
worker	query	optional	string	—

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /values/organizationAssignmentChangesGroup/businessUnits

GET /values/organizationAssignmentChangesGroup/companies

Retrieves instances that can be used as values for other endpoint parameters in this service.

operationId: PromptValues_getInstances

Parameters

Name	In	Required	Type	Description
effectiveDate	query	optional	string	—
event	query	optional	string	—
limit	query	optional	integer	The maximum number of objects in a single response. The default and maximum is 1000.
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.
organizationType	query	optional	string	—
worker	query	optional	string	—

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /values/organizationAssignmentChangesGroup/companies

GET /values/organizationAssignmentChangesGroup/costCenters

Retrieves instances that can be used as values for other endpoint parameters in this service.

operationId: PromptValues_getAssignmentChangeGroupCostCenters

Parameters

Name	In	Required	Type	Description
effectiveDate	query	optional	string	—
event	query	optional	string	—
limit	query	optional	integer	The maximum number of objects in a single response. The default and maximum is 1000.
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.
organizationType	query	optional	string	—
worker	query	optional	string	—

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /values/organizationAssignmentChangesGroup/costCenters

GET /values/organizationAssignmentChangesGroup/customs

Retrieves instances that can be used as values for other endpoint parameters in this service.

operationId: PromptValues_getInstances

Parameters

Name	In	Required	Type	Description
effectiveDate	query	optional	string	—
event	query	optional	string	—
limit	query	optional	integer	The maximum number of objects in a single response. The default and maximum is 1000.
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.
organizationType	query	optional	string	—
worker	query	optional	string	—

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /values/organizationAssignmentChangesGroup/customs

GET /values/organizationAssignmentChangesGroup/funds

Retrieves instances that can be used as values for other endpoint parameters in this service.

operationId: PromptValues_getInstances

Parameters

Name	In	Required	Type	Description
effectiveDate	query	optional	string	—
event	query	optional	string	—
limit	query	optional	integer	The maximum number of objects in a single response. The default and maximum is 1000.
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.
organizationType	query	optional	string	—
worker	query	optional	string	—

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /values/organizationAssignmentChangesGroup/funds

GET /values/organizationAssignmentChangesGroup/gifts

Retrieves instances that can be used as values for other endpoint parameters in this service.

operationId: PromptValues_getGiftInstances

Parameters

Name	In	Required	Type	Description
effectiveDate	query	optional	string	—
event	query	optional	string	—
limit	query	optional	integer	The maximum number of objects in a single response. The default and maximum is 1000.
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.
organizationType	query	optional	string	—
worker	query	optional	string	—

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /values/organizationAssignmentChangesGroup/gifts

GET /values/organizationAssignmentChangesGroup/grants

Retrieves instances that can be used as values for other endpoint parameters in this service.

operationId: PromptValues_getGrants

Parameters

Name	In	Required	Type	Description
effectiveDate	query	optional	string	—
event	query	optional	string	—
limit	query	optional	integer	The maximum number of objects in a single response. The default and maximum is 1000.
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.
organizationType	query	optional	string	—
worker	query	optional	string	—

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /values/organizationAssignmentChangesGroup/grants

GET /values/organizationAssignmentChangesGroup/jobs

Retrieves instances that can be used as values for other endpoint parameters in this service.

operationId: PromptValues_getInstances

Parameters

Name	In	Required	Type	Description
effectiveDate	query	optional	string	—
event	query	optional	string	—
limit	query	optional	integer	The maximum number of objects in a single response. The default and maximum is 1000.
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.
organizationType	query	optional	string	—
worker	query	optional	string	—

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /values/organizationAssignmentChangesGroup/jobs

GET /values/organizationAssignmentChangesGroup/positions

Retrieves instances that can be used as values for other endpoint parameters in this service.

operationId: PromptValues_getInstances

Parameters

Name	In	Required	Type	Description
effectiveDate	query	optional	string	—
event	query	optional	string	—
limit	query	optional	integer	The maximum number of objects in a single response. The default and maximum is 1000.
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.
organizationType	query	optional	string	—
worker	query	optional	string	—

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /values/organizationAssignmentChangesGroup/positions

GET /values/organizationAssignmentChangesGroup/programs

Retrieves instances that can be used as values for other endpoint parameters in this service.

operationId: PromptValues_getInstances

Parameters

Name	In	Required	Type	Description
effectiveDate	query	optional	string	—
event	query	optional	string	—
limit	query	optional	integer	The maximum number of objects in a single response. The default and maximum is 1000.
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.
organizationType	query	optional	string	—
worker	query	optional	string	—

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /values/organizationAssignmentChangesGroup/programs

GET /values/organizationAssignmentChangesGroup/regions

Retrieves instances that can be used as values for other endpoint parameters in this service.

operationId: PromptValues_getInstances

Parameters

Name	In	Required	Type	Description
effectiveDate	query	optional	string	—
event	query	optional	string	—
limit	query	optional	integer	The maximum number of objects in a single response. The default and maximum is 1000.
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.
organizationType	query	optional	string	—
worker	query	optional	string	—

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /values/organizationAssignmentChangesGroup/regions

GET /values/organizationAssignmentChangesGroup/workers

Retrieves instances that can be used as values for other endpoint parameters in this service.

operationId: PromptValues_getInstances

Parameters

Name	In	Required	Type	Description
effectiveDate	query	optional	string	—
event	query	optional	string	—
limit	query	optional	integer	The maximum number of objects in a single response. The default and maximum is 1000.
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.
organizationType	query	optional	string	—
worker	query	optional	string	—

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /values/organizationAssignmentChangesGroup/workers

Supervisoryorganizations 6 endpoints

GET /supervisoryOrganizations Retrieves a supervisory organization for the specified 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

operationId: SupervisoryOrganizations_getById

Parameters

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.

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /supervisoryOrganizations

GET /supervisoryOrganizations/{ID} Retrieves a single supervisory organization instance.

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

operationId: SupervisoryOrganizations_getInstance

Parameters

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

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /supervisoryOrganizations/{ID}

GET /supervisoryOrganizations/{ID}/members Retrieves a collection of members for the specified supervisory organization ID.

Retrieves a collection of members for the specified supervisory organization ID.

Secured by: Reports: Organization

Scope: Organizations and Roles

operationId: SupervisoryOrganizations_getMembers

Parameters

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.

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /supervisoryOrganizations/{ID}/members

GET /supervisoryOrganizations/{ID}/members/{subresourceID} Retrieves a single member instance.

Retrieves a member for the specified supervisory organization ID.

Secured by: Reports: Organization

Scope: Organizations and Roles

operationId: SupervisoryOrganizations_getMember

Parameters

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

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /supervisoryOrganizations/{ID}/members/{subresourceID}

GET /supervisoryOrganizations/{ID}/orgChart Retrieves information about an organization chart of the specified supervisory organization id.

Retrieves information about an organization chart of the specified supervisory organization id.

Secured by: Reports: Organization

Scope: Organizations and Roles

operationId: SupervisoryOrganizations_getOrgChart

Parameters

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.

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /supervisoryOrganizations/{ID}/orgChart

GET /supervisoryOrganizations/{ID}/orgChart/{subresourceID} Retrieves a single organization chart instance.

Retrieves information about an organization chart of the specified supervisory organization id.

Secured by: Reports: Organization

Scope: Organizations and Roles

operationId: SupervisoryOrganizations_getOrgChart

Parameters

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

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /supervisoryOrganizations/{ID}/orgChart/{subresourceID}

Workers 16 endpoints

GET /workers Retrieves a collection of workers and current staffing information.

Retrieves a collection of workers and current staffing information.

Secured by: Self-Service: Current Staffing Information, Worker Data: Public Worker Reports

Scope: Staffing

operationId: Workers_getCollectionStaffing

Parameters

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.

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /workers

GET /workers/{ID} Retrieves a collection of workers and current staffing information.

Retrieves a collection of workers and current staffing information.

Secured by: Self-Service: Current Staffing Information, Worker Data: Public Worker Reports

Scope: Staffing

operationId: Workers_getStaffingInformation

Parameters

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

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /workers/{ID}

GET /workers/{ID}/checkInTopics Retrieves a collection of Check-Ins topics.

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)

operationId: Workers_getCheckInTopics

Parameters

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.

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /workers/{ID}/checkInTopics

GET /workers/{ID}/checkInTopics/{subresourceID} Retrieves a single Check-In topic instance.

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)

operationId: Workers_getCheckInTopic

Parameters

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

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /workers/{ID}/checkInTopics/{subresourceID}

GET /workers/{ID}/checkIns Retrieves a collection of Check-Ins.

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)

operationId: Workers_getCheckIns

Parameters

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.

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /workers/{ID}/checkIns

GET /workers/{ID}/checkIns/{subresourceID} Retrieves a single Check-In instance.

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)

operationId: Workers_getCheckIn

Parameters

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

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /workers/{ID}/checkIns/{subresourceID}

GET /workers/{ID}/explicitSkills Get Explicit Skills for Skill Enabled

Get Explicit Skills for Skill Enabled

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

Scope: Worker Profile and Skills

operationId: Workers_getExplicitSkills

Parameters

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.

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /workers/{ID}/explicitSkills

GET /workers/{ID}/explicitSkills/{subresourceID} Get Explicit Skills for Skill Enabled

Get Explicit Skills for Skill Enabled

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

Scope: Worker Profile and Skills

operationId: Workers_getExplicitSkillsForSkillEnabled

Parameters

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

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /workers/{ID}/explicitSkills/{subresourceID}

GET /workers/{ID}/externalSkillLevel Retrieves all external skill level information for a worker. You can filter the external skill levels by externalSkillId.

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

operationId: Workers_getExternalSkillLevel

Parameters

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.

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /workers/{ID}/externalSkillLevel

GET /workers/{ID}/externalSkillLevel/{subresourceID} Retrieves all external skill level information for a worker. You can filter the external skill levels by externalSkillId.

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

operationId: Workers_getExternalSkillLevels

Parameters

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

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

401

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

403

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

404

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

GET /workers/{ID}/externalSkillLevel/{subresourceID}

GET /workers/{ID}/homeContactInformationChanges/{subresourceID} Retrieves an existing Home Contact Change event for the Person.

Retrieves an existing Home Contact Change event for the Person.

Secured by: Change Home Contact Information (REST Service)

Scope: Contact Information

operationId: Workers_getHomeContactChange

Parameters

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

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /workers/{ID}/homeContactInformationChanges/{subresourceID}

GET /workers/{ID}/serviceDates Retrieves a collection of service dates for the specified worker id.

Retrieves all service dates for the specified worker id.

Secured by: Self-Service: Service Dates, Worker Data: Service Dates

Scope: Staffing

operationId: Workers_getServiceDates

Parameters

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.

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /workers/{ID}/serviceDates

GET /workers/{ID}/serviceDates/{subresourceID} Retrieves a single service date information instance.

Retrieves information about a service date for the specified worker id.

Secured by: Self-Service: Service Dates, Worker Data: Service Dates

Scope: Staffing

operationId: Workers_getServiceDate

Parameters

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

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /workers/{ID}/serviceDates/{subresourceID}

GET /workers/{ID}/skillItems

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

Scope: Worker Profile and Skills

operationId: Workers_getSkillItems

Parameters

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.

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /workers/{ID}/skillItems

GET /workers/{ID}/skillItems/{subresourceID}

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

Scope: Worker Profile and Skills

operationId: Workers_getSkillItemsById

Parameters

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

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /workers/{ID}/skillItems/{subresourceID}

GET /workers/{ID}/workContactInformationChanges/{subresourceID} Retrieves an existing Work Contact Change event for the Person.

Retrieves an existing Work Contact Change event for the Person.

Secured by: Change Work Contact Information (REST Service)

Scope: Contact Information

operationId: Workers_getWorkContactChange

Parameters

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

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data.

400

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

401

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

403

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

404

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

GET /workers/{ID}/workContactInformationChanges/{subresourceID}

Load more endpoints

Schemas

object ERROR_MODEL_REFERENCE

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

array FACETS_MODEL_REFERENCE

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

object INSTANCE_MODEL_REFERENCE

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

object JobChangesGetAdministrativeOptionsResponse

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

object JobChangesGetBusinessTitleResponse

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

object JobChangesGetCommentByIdResponse

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

object JobChangesGetContractOptionsResponse

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

object JobChangesGetJobClassificationResponse

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

object JobChangesGetJobProfileResponse

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

object JobChangesGetLocationInfoResponse

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

object JobChangesGetMoveTeamOptionResponse

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

object JobChangesGetOpeningOptionsResponse

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

object JobChangesGetPositionByIdResponse

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

object JobChangesGetStartDetailsResponse

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

object JobFamiliesListResponse

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

object JobProfilesListCollectionResponse

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

object JobsGetCollectionResponse

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

object JobsGetWorkspacesResponse

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

object MULTIPLE_INSTANCE_MODEL_REFERENCE

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

object OrganizationAssignmentChangesGetBusinessUnitResponse

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

object OrganizationAssignmentChangesGetCommentResponse

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

object OrganizationAssignmentChangesGetCompanyResponse

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

object OrganizationAssignmentChangesGetCostCenterResponse

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

object OrganizationAssignmentChangesGetCostingOrganizationsResponse

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

object OrganizationAssignmentChangesGetCustomOrganizationsResponse

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

object OrganizationAssignmentChangesGetRegionResponse

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

object OrganizationAssignmentChangesGetStartDetailsResponse

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

object SupervisoryOrganizationsGetByIdResponse

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

object SupervisoryOrganizationsGetMembersResponse

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

object SupervisoryOrganizationsGetOrgChartResponse

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

object VALIDATION_ERROR_MODEL_REFERENCE

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

object WorkersGetCheckInTopicsResponse

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

object WorkersGetCheckInsResponse

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

object WorkersGetCollectionStaffingResponse

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

object WorkersGetExplicitSkillsResponse

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

object WorkersGetExternalSkillLevelResponse

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

object WorkersGetServiceDatesResponse

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

object WorkersGetSkillItemsResponse

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

object action_38ff08ab6736100010816009079d0126

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

object assignmentType_23929e1f68ca10000d6940d6bde56963

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

object associatedCheckInDetail_3267c0ba92a0100016ed105476ad03c4

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

object associatedCheckInTopicDetail_316b5a26cc3c100010a01184c23902ea

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

object associatedCheckInsSummary_d81c816de26f10000f7a29ea89140020

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

object associatedTopicsSummary_b3a69f47a4991000171aae4c5a810040

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

object businessProcessParameters_23782ad3f54110002073aab65def00fb

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

object businessProcessParameters_2dcd9a4882b210000f7b2e0a85982265

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

object businessProcessParameters_5afc0b4b5a4610002aaebb8180cd2261

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

object businessUnit_5aabf8e28cb310002520b2aabc470366

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

object category_43b30ba735b8100011ee4781a9d50146

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

object changeJobAdditionalJobClassificationData_27ec818d10d0100003600115b5200102

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

Load more schemas

Versions

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