Promptvalues 6 endpoints

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.

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

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

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 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 32 endpoints

GET /workers

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.

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 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
POST /workers/{ID}/checkInTopics

Creates a single Check-In topic instance with the specified data with the specified worker. The worker is specified by the Workday ID of the worker. You can use a returned id from GET /workers in the Staffing service /staffing.

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

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

Secured by: Worker Data: Check-Ins REST API

Scope: Performance Enablement

Contains attachment(s)

operationId: Workers_createCheckInTopic

Parameters

Name In Required Type Description
ID path required string

The Workday ID of the resource.

Request Body

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

Responses

default

An error occurred.
201

Resource created.
400

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

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

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

Resource not found. (https://community.workday.com/rest/error-messages)
POST /workers/{ID}/checkInTopics
DELETE /workers/{ID}/checkInTopics/{subresourceID}

Deletes an existing Check-In topic instance with the specified ID. This can only be done by the creater of the Check-In topic.

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

Secured by: Self-Service: Check-Ins

Scope: Performance Enablement

operationId: Workers_deleteCheckInTopic

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. Deleting resource.
400

Invalid request. (https://community.workday.com/rest/error-messages)
Error Code | Validation Message
— | —
A160 | You can only delete Check-In topics that you have created.
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)
DELETE /workers/{ID}/checkInTopics/{subresourceID}
GET /workers/{ID}/checkInTopics/{subresourceID}

Retrieves a Check-In topic with the specified ID for the specified worker. The worker is specified by the Workday ID of the worker. You can use a returned id from GET /workers in the Staffing service /staffing.

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

Scope: Performance Enablement

Contains attachment(s)

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}
PATCH /workers/{ID}/checkInTopics/{subresourceID}

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

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

Secured by: Self-Service: Check-Ins

Scope: Performance Enablement

Contains attachment(s)

operationId: Workers_partiallyUpdateCheckInTopic

Parameters

Name In Required Type Description
ID path required string

The Workday ID of the resource.
subresourceID path required string

The Workday ID of the subresource.

Request Body

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

Responses

default

An error occurred.
200

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

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

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

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

Resource not found. (https://community.workday.com/rest/error-messages)
PATCH /workers/{ID}/checkInTopics/{subresourceID}
PATCH /workers/{ID}/checkInTopics/{subresourceID}?type=archive

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

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

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

Scope: Performance Enablement

operationId: Workers_updateCheckInTopicState

Parameters

Name In Required Type Description
ID path required string

The Workday ID of the resource.
subresourceID path required string

The Workday ID of the subresource.

Request Body

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

Responses

default

An error occurred.
200

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

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

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

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

Resource not found. (https://community.workday.com/rest/error-messages)
PATCH /workers/{ID}/checkInTopics/{subresourceID}?type=archive
GET /workers/{ID}/checkIns

Retrieves all Check-Ins for the specified worker. The worker is specified by the Workday ID of the worker. You can use a returned id from GET /workers in the Staffing service /staffing.

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

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

Scope: Performance Enablement

Contains attachment(s)

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
POST /workers/{ID}/checkIns

Creates a single Check-In instance with the specified data with the specified worker. The worker is specified by the Workday ID of the worker. You can use a returned id from GET /workers in the Staffing service /staffing.

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

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

Secured by: Worker Data: Check-Ins REST API

Scope: Performance Enablement

Contains attachment(s)

operationId: Workers_createCheckIn

Parameters

Name In Required Type Description
ID path required string

The Workday ID of the resource.

Request Body

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

Responses

default

An error occurred.
201

Resource created.
400

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

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

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

Resource not found. (https://community.workday.com/rest/error-messages)
POST /workers/{ID}/checkIns
DELETE /workers/{ID}/checkIns/{subresourceID}

Deletes an existing Check-In instance with the specified ID. This can only be done by the creater of the Check-In.

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

Secured by: Self-Service: Check-Ins

Scope: Performance Enablement

operationId: Workers_deleteCheckIn

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. Deleting resource.
400

Invalid request. (https://community.workday.com/rest/error-messages)
Error Code | Validation Message
— | —
A160 | You can only delete Check-Ins that you have created.
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)
DELETE /workers/{ID}/checkIns/{subresourceID}
GET /workers/{ID}/checkIns/{subresourceID}

Retrieves a Check-In with the specified ID for the specified worker. The worker is specified by the Workday ID of the worker. You can use a returned id from GET /workers in the Staffing service /staffing.

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

Scope: Performance Enablement

Contains attachment(s)

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}
PATCH /workers/{ID}/checkIns/{subresourceID}

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

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

Secured by: Self-Service: Check-Ins

Scope: Performance Enablement

Contains attachment(s)

operationId: Workers_updateCheckIn

Parameters

Name In Required Type Description
ID path required string

The Workday ID of the resource.
subresourceID path required string

The Workday ID of the subresource.

Request Body

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

Responses

default

An error occurred.
200

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

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

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

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

Resource not found. (https://community.workday.com/rest/error-messages)
PATCH /workers/{ID}/checkIns/{subresourceID}
PATCH /workers/{ID}/checkIns/{subresourceID}?type=archive

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

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

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

Scope: Performance Enablement

operationId: Workers_partiallyUpdateCheckIn

Parameters

Name In Required Type Description
ID path required string

The Workday ID of the resource.
subresourceID path required string

The Workday ID of the subresource.

Request Body

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

Responses

default

An error occurred.
200

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

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

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

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

Resource not found. (https://community.workday.com/rest/error-messages)
PATCH /workers/{ID}/checkIns/{subresourceID}?type=archive
GET /workers/{ID}/explicitSkills

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
POST /workers/{ID}/explicitSkills

Save skills a user has

Secured by: Self-Service: Skills

Scope: Worker Profile and Skills

operationId: Workers_saveUserSkills

Parameters

Name In Required Type Description
ID path required string

The Workday ID of the resource.

Request Body

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

Responses

default

An error occurred.
201

Resource created.
400

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

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

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

Resource not found. (https://community.workday.com/rest/error-messages)
POST /workers/{ID}/explicitSkills
GET /workers/{ID}/explicitSkills/{subresourceID}

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.

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
POST /workers/{ID}/externalSkillLevel

Creates external skill levels.

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

Scope: Worker Profile and Skills

operationId: Workers_createExternalSkillLevels

Parameters

Name In Required Type Description
ID path required string

The Workday ID of the resource.

Request Body

application/json
schema externalSkillLevel_a39462f09c44100005d46fd77ef00000
Property Type Required
id string optional
context string optional
effectiveMoment string optional
externalSkillId string required
externalSkillLevel integer required

Responses

default

An error occurred.
201

Resource created.
400

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

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

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

Resource not found. (https://community.workday.com/rest/error-messages)
POST /workers/{ID}/externalSkillLevel
GET /workers/{ID}/externalSkillLevel/{subresourceID}

Retrieves all external skill level information for a worker. You can filter the external skill levels by externalSkillId.

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

Scope: Worker Profile and Skills

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

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/{subresourceID}
PUT /workers/{ID}/externalSkillLevel/{subresourceID}

Updates external skill levels.

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

Scope: Worker Profile and Skills

operationId: Workers_updateExternalSkillLevel

Parameters

Name In Required Type Description
ID path required string

The Workday ID of the resource.
subresourceID path required string

The Workday ID of the subresource.

Request Body

application/json
schema externalSkillLevel_a39462f09c44100005d46fd77ef00000
Property Type Required
id string optional
context string optional
effectiveMoment string optional
externalSkillId string required
externalSkillLevel integer required

Responses

default

An error occurred.
200

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

Invalid request. (https://community.workday.com/rest/error-messages)
Error Code | Validation Message
— | —
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.
A2006 | You can’t update an External Skill ID for an existing External Skill Level.
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)
PUT /workers/{ID}/externalSkillLevel/{subresourceID}
POST /workers/{ID}/homeContactInformationChanges

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

Secured by: Change Home Contact Information (REST Service)

Scope: Contact Information

operationId: Workers_createHomeContactChangeProcess

Parameters

Name In Required Type Description
ID path required string

The Workday ID of the resource.

Request Body

required
application/json
schema homeContactChangeEvent_f42ba27d87ed10001aa58a5d231b1621
Property Type Required
id string optional
href string optional
descriptor string optional
effective_date string optional

Responses

default

An error occurred.
201

Resource created.
400

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

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

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

Resource not found. (https://community.workday.com/rest/error-messages)
POST /workers/{ID}/homeContactInformationChanges
GET /workers/{ID}/homeContactInformationChanges/{subresourceID}

Retrieves an existing Home Contact Change event for the Person.

Secured by: Change Home Contact Information (REST Service)

Scope: Contact Information

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}
POST /workers/{ID}/jobChanges

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

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

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

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

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

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

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

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

Secured by: Change Job (REST Service)

Scope: Staffing

operationId: Workers_initiateJobChange

Parameters

Name In Required Type Description
ID path required string

The Workday ID of the resource.

Request Body

required
application/json
schema jobChangesStartDetailsPOSTData_75e528a78e9a10000ab750ea156f0111
Property Type Required
id string optional
job object optional
└ id string required
└ href string optional
└ descriptor string optional
date string required
reason object optional
└ id string required
└ href string optional
└ descriptor string optional
location object optional
└ id string required
└ href string optional
└ descriptor string optional
template object optional
└ id string required
└ href string optional
└ descriptor string optional
descriptor string optional
supervisoryOrganization object optional
└ id string required
└ href string optional
└ descriptor string optional

Responses

default

An error occurred.
201

Resource created.
400

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

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

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

Resource not found. (https://community.workday.com/rest/error-messages)
POST /workers/{ID}/jobChanges
POST /workers/{ID}/organizationAssignmentChanges

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

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

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

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

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

Secured by: Change Organization Assignment (REST)

Scope: Organizations and Roles

operationId: Workers_initiateOrganizationAssignmentChange

Parameters

Name In Required Type Description
ID path required string

The Workday ID of the resource.

Request Body

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

Responses

default

An error occurred.
201

Resource created.
400

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

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

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

Resource not found. (https://community.workday.com/rest/error-messages)
POST /workers/{ID}/organizationAssignmentChanges
GET /workers/{ID}/serviceDates

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 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
POST /workers/{ID}/skillItems

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

Scope: Worker Profile and Skills

operationId: Workers_createSkillItem

Parameters

Name In Required Type Description
ID path required string

The Workday ID of the resource.

Request Body

required
application/json
schema skillItemsBulkDefinition_9d815bbfd67010000d6ed56204ab12de
Property Type Required
skillItems array optional
└ id string optional
└ remoteID string optional
└ skillItem object optional
└ id string required
└ href string optional
└ descriptor string optional
└ skillName string optional

Responses

default

An error occurred.
201

Resource created.
400

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

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

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

Resource not found. (https://community.workday.com/rest/error-messages)
POST /workers/{ID}/skillItems
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}
POST /workers/{ID}/workContactInformationChanges

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

Secured by: Change Work Contact Information (REST Service)

Scope: Contact Information

operationId: Workers_createWorkContactInformationChanges

Parameters

Name In Required Type Description
ID path required string

The Workday ID of the resource.

Request Body

required
application/json
schema workContactChangeEvent_5fca6c96c1c81000142fd03784140113
Property Type Required
id string optional
href string optional
descriptor string optional
effective_date string optional

Responses

default

An error occurred.
201

Resource created.
400

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

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

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

Resource not found. (https://community.workday.com/rest/error-messages)
POST /workers/{ID}/workContactInformationChanges
GET /workers/{ID}/workContactInformationChanges/{subresourceID}

Retrieves an existing Work Contact Change event for the Person.

Secured by: Change Work Contact Information (REST Service)

Scope: Contact Information

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}