The maximum number of objects in a single response. The default is 20. The maximum is 100.
offset
integer
No
—
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.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100." }, "offset": { "type": "integer", "description": "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." } }, "required": [ "PCID" ]}
Retrieves a collection of activities for a specific customer.Parameters:
Parameter
Type
Required
Default
Description
ID
string
Yes
—
The Workday ID of the resource.
fromDate
string
No
—
Start date for filtering (inclusive)
limit
integer
No
—
The maximum number of objects in a single response. The default is 20. The maximum is 100.
offset
integer
No
—
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.
toDate
string
No
—
End date for filtering (inclusive)
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ID": { "type": "string", "description": "The Workday ID of the resource." }, "fromDate": { "type": "string", "description": "Start date for filtering (inclusive)" }, "limit": { "type": "integer", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100." }, "offset": { "type": "integer", "description": "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." }, "toDate": { "type": "string", "description": "End date for filtering (inclusive)" } }, "required": [ "PCID", "ID" ]}
Retrieves an activity instance for a specific customer.Parameters:
Parameter
Type
Required
Default
Description
ID
string
Yes
—
The Workday ID of the resource.
subresourceID
string
Yes
—
The Workday ID of the subresource.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ID": { "type": "string", "description": "The Workday ID of the resource." }, "subresourceID": { "type": "string", "description": "The Workday ID of the subresource." } }, "required": [ "PCID", "ID", "subresourceID" ]}
Retrieves a collection of job change reasons.Parameters:
Parameter
Type
Required
Default
Description
limit
integer
No
—
The maximum number of objects in a single response. The default is 20. The maximum is 100.
offset
integer
No
—
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.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100." }, "offset": { "type": "integer", "description": "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." } }, "required": [ "PCID" ]}
Retrieves a collection of organizations.Parameters:
Parameter
Type
Required
Default
Description
limit
integer
No
—
The maximum number of objects in a single response. The default is 20. The maximum is 100.
offset
integer
No
—
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
string
No
—
Reference to an Organization Type. Example: Organization Type WID. Requests must provide an Organization Type.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100." }, "offset": { "type": "integer", "description": "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": { "type": "string", "description": "Reference to an Organization Type. Example: Organization Type WID. Requests must provide an Organization Type." } }, "required": [ "PCID" ]}
Retrieves a collection of organization types.Parameters:
Parameter
Type
Required
Default
Description
limit
integer
No
—
The maximum number of objects in a single response. The default is 20. The maximum is 100.
offset
integer
No
—
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.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100." }, "offset": { "type": "integer", "description": "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." } }, "required": [ "PCID" ]}
Retrieves a collection of supervisory organizations.Parameters:
Parameter
Type
Required
Default
Description
limit
integer
No
—
The maximum number of objects in a single response. The default is 20. The maximum is 100.
offset
integer
No
—
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.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100." }, "offset": { "type": "integer", "description": "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." } }, "required": [ "PCID" ]}
Retrieves a collection of workers for a specific supervisory organization.Parameters:
Parameter
Type
Required
Default
Description
ID
string
Yes
—
The Workday ID of the resource.
limit
integer
No
—
The maximum number of objects in a single response. The default is 20. The maximum is 100.
offset
integer
No
—
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.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ID": { "type": "string", "description": "The Workday ID of the resource." }, "limit": { "type": "integer", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100." }, "offset": { "type": "integer", "description": "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." } }, "required": [ "PCID", "ID" ]}
Retrieves a worker instance for a specific supervisory organization.Parameters:
Parameter
Type
Required
Default
Description
ID
string
Yes
—
The Workday ID of the resource.
subresourceID
string
Yes
—
The Workday ID of the subresource.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ID": { "type": "string", "description": "The Workday ID of the resource." }, "subresourceID": { "type": "string", "description": "The Workday ID of the subresource." } }, "required": [ "PCID", "ID", "subresourceID" ]}
The maximum number of objects in a single response. The default is 20. The maximum is 100.
offset
integer
No
—
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
string
No
—
The search value
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "includeTerminatedWorkers": { "type": "boolean", "description": "Include terminated workers in the output" }, "limit": { "type": "integer", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100." }, "offset": { "type": "integer", "description": "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": { "type": "string", "description": "The search value" } }, "required": [ "PCID" ]}
Retrieves a collection of business title changes for a specific worker.Parameters:
Parameter
Type
Required
Default
Description
ID
string
Yes
—
The Workday ID of the resource.
limit
integer
No
—
The maximum number of objects in a single response. The default is 20. The maximum is 100.
offset
integer
No
—
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.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ID": { "type": "string", "description": "The Workday ID of the resource." }, "limit": { "type": "integer", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100." }, "offset": { "type": "integer", "description": "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." } }, "required": [ "PCID", "ID" ]}
Retrieves a business title change instance for a specific worker.Parameters:
Parameter
Type
Required
Default
Description
ID
string
Yes
—
The Workday ID of the resource.
subresourceID
string
Yes
—
The Workday ID of the subresource.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ID": { "type": "string", "description": "The Workday ID of the resource." }, "subresourceID": { "type": "string", "description": "The Workday ID of the subresource." } }, "required": [ "PCID", "ID", "subresourceID" ]}
Retrieves a collection of direct reports for a specific worker.Parameters:
Parameter
Type
Required
Default
Description
ID
string
Yes
—
The Workday ID of the resource.
limit
integer
No
—
The maximum number of objects in a single response. The default is 20. The maximum is 100.
offset
integer
No
—
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.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ID": { "type": "string", "description": "The Workday ID of the resource." }, "limit": { "type": "integer", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100." }, "offset": { "type": "integer", "description": "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." } }, "required": [ "PCID", "ID" ]}
Retrieves a direct report instance for a specific worker.Parameters:
Parameter
Type
Required
Default
Description
ID
string
Yes
—
The Workday ID of the resource.
subresourceID
string
Yes
—
The Workday ID of the subresource.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ID": { "type": "string", "description": "The Workday ID of the resource." }, "subresourceID": { "type": "string", "description": "The Workday ID of the subresource." } }, "required": [ "PCID", "ID", "subresourceID" ]}
Retrieves a collection of history items for a specific worker.Parameters:
Parameter
Type
Required
Default
Description
ID
string
Yes
—
The Workday ID of the resource.
limit
integer
No
—
The maximum number of objects in a single response. The default is 20. The maximum is 100.
offset
integer
No
—
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.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ID": { "type": "string", "description": "The Workday ID of the resource." }, "limit": { "type": "integer", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100." }, "offset": { "type": "integer", "description": "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." } }, "required": [ "PCID", "ID" ]}
Retrieves a history instance for a specific worker.Parameters:
Parameter
Type
Required
Default
Description
ID
string
Yes
—
The Workday ID of the resource.
subresourceID
string
Yes
—
The Workday ID of the subresource.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ID": { "type": "string", "description": "The Workday ID of the resource." }, "subresourceID": { "type": "string", "description": "The Workday ID of the subresource." } }, "required": [ "PCID", "ID", "subresourceID" ]}
Retrieves a collection of inbox tasks for a specific worker.Parameters:
Parameter
Type
Required
Default
Description
ID
string
Yes
—
The Workday ID of the resource.
limit
integer
No
—
The maximum number of objects in a single response. The default is 20. The maximum is 100.
offset
integer
No
—
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.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ID": { "type": "string", "description": "The Workday ID of the resource." }, "limit": { "type": "integer", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100." }, "offset": { "type": "integer", "description": "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." } }, "required": [ "PCID", "ID" ]}
Retrieves an inbox task instance for a specific worker.Parameters:
Parameter
Type
Required
Default
Description
ID
string
Yes
—
The Workday ID of the resource.
subresourceID
string
Yes
—
The Workday ID of the subresource.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ID": { "type": "string", "description": "The Workday ID of the resource." }, "subresourceID": { "type": "string", "description": "The Workday ID of the subresource." } }, "required": [ "PCID", "ID", "subresourceID" ]}
Retrieves a collection of organizations for a specific worker.Parameters:
Parameter
Type
Required
Default
Description
ID
string
Yes
—
The Workday ID of the resource.
limit
integer
No
—
The maximum number of objects in a single response. The default is 20. The maximum is 100.
offset
integer
No
—
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.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ID": { "type": "string", "description": "The Workday ID of the resource." }, "limit": { "type": "integer", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100." }, "offset": { "type": "integer", "description": "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." } }, "required": [ "PCID", "ID" ]}
Retrieves an organization instance for a specific worker.Parameters:
Parameter
Type
Required
Default
Description
ID
string
Yes
—
The Workday ID of the resource.
subresourceID
string
Yes
—
The Workday ID of the subresource.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ID": { "type": "string", "description": "The Workday ID of the resource." }, "subresourceID": { "type": "string", "description": "The Workday ID of the subresource." } }, "required": [ "PCID", "ID", "subresourceID" ]}
Retrieves a collection of pay slips for a specific worker.Parameters:
Parameter
Type
Required
Default
Description
ID
string
Yes
—
The Workday ID of the resource.
limit
integer
No
—
The maximum number of objects in a single response. The default is 20. The maximum is 100.
offset
integer
No
—
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.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ID": { "type": "string", "description": "The Workday ID of the resource." }, "limit": { "type": "integer", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100." }, "offset": { "type": "integer", "description": "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." } }, "required": [ "PCID", "ID" ]}
Retrieves a pay slip instance for a specific worker.Parameters:
Parameter
Type
Required
Default
Description
ID
string
Yes
—
The Workday ID of the resource.
subresourceID
string
Yes
—
The Workday ID of the subresource.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ID": { "type": "string", "description": "The Workday ID of the resource." }, "subresourceID": { "type": "string", "description": "The Workday ID of the subresource." } }, "required": [ "PCID", "ID", "subresourceID" ]}
Retrieves a collection of supervisory organizations managed by a specific worker.Parameters:
Parameter
Type
Required
Default
Description
ID
string
Yes
—
The Workday ID of the resource.
limit
integer
No
—
The maximum number of objects in a single response. The default is 20. The maximum is 100.
offset
integer
No
—
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.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ID": { "type": "string", "description": "The Workday ID of the resource." }, "limit": { "type": "integer", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100." }, "offset": { "type": "integer", "description": "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." } }, "required": [ "PCID", "ID" ]}
Retrieves a supervisory organization managed by a specific worker.Parameters:
Parameter
Type
Required
Default
Description
ID
string
Yes
—
The Workday ID of the resource.
subresourceID
string
Yes
—
The Workday ID of the subresource.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ID": { "type": "string", "description": "The Workday ID of the resource." }, "subresourceID": { "type": "string", "description": "The Workday ID of the subresource." } }, "required": [ "PCID", "ID", "subresourceID" ]}
Retrieves a collection of time off entries for a specific worker.Parameters:
Parameter
Type
Required
Default
Description
ID
string
Yes
—
The Workday ID of the resource.
limit
integer
No
—
The maximum number of objects in a single response. The default is 20. The maximum is 100.
offset
integer
No
—
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.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ID": { "type": "string", "description": "The Workday ID of the resource." }, "limit": { "type": "integer", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100." }, "offset": { "type": "integer", "description": "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." } }, "required": [ "PCID", "ID" ]}
Retrieves a time off entry for a specific worker.Parameters:
Parameter
Type
Required
Default
Description
ID
string
Yes
—
The Workday ID of the resource.
subresourceID
string
Yes
—
The Workday ID of the subresource.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ID": { "type": "string", "description": "The Workday ID of the resource." }, "subresourceID": { "type": "string", "description": "The Workday ID of the subresource." } }, "required": [ "PCID", "ID", "subresourceID" ]}
Retrieves a collection of time off plans for a specific worker.Parameters:
Parameter
Type
Required
Default
Description
ID
string
Yes
—
The Workday ID of the resource.
limit
integer
No
—
The maximum number of objects in a single response. The default is 20. The maximum is 100.
offset
integer
No
—
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.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ID": { "type": "string", "description": "The Workday ID of the resource." }, "limit": { "type": "integer", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100." }, "offset": { "type": "integer", "description": "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." } }, "required": [ "PCID", "ID" ]}
Retrieves a particular time off plan for a specific worker.Parameters:
Parameter
Type
Required
Default
Description
ID
string
Yes
—
The Workday ID of the resource.
subresourceID
string
Yes
—
The Workday ID of the subresource.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ID": { "type": "string", "description": "The Workday ID of the resource." }, "subresourceID": { "type": "string", "description": "The Workday ID of the subresource." } }, "required": [ "PCID", "ID", "subresourceID" ]}
Creates a business title change instance with the specified data.Parameters:
Parameter
Type
Required
Default
Description
ID
string
Yes
—
The Workday ID of the resource.
descriptor
string
No
—
The display name of the instance
href
string
No
—
A link to the instance
id
string
No
—
Workday Id or Reference Id of the instance.
proposedBusinessTitle
string
No
—
The new business title for the ~worker~ as of the effective date. If there is no business title override, this field defaults to the job title or job profile name.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ID": { "type": "string", "description": "The Workday ID of the resource." }, "descriptor": { "type": "string", "description": "The display name of the instance" }, "href": { "type": "string", "description": "A link to the instance" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." }, "proposedBusinessTitle": { "type": "string", "description": "The new business title for the \\~worker\\~ as of the effective date. If there is no business title override, this field defaults to the job title or job profile name." } }, "required": [ "PCID", "ID" ]}
<b>Secured by:</b> Change My Business Title <b>Scope:</b> StaffingParameters:
Parameter
Type
Required
Default
Description
ID
string
Yes
—
The Workday ID of the resource.
descriptor
string
No
—
The display name of the instance
href
string
No
—
A link to the instance
id
string
No
—
Workday Id or Reference Id of the instance.
proposedBusinessTitle
string
No
—
The new business title for the ~worker~ as of the effective date. If there is no business title override, this field defaults to the job title or job profile name.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ID": { "type": "string", "description": "The Workday ID of the resource." }, "descriptor": { "type": "string", "description": "The display name of the instance" }, "href": { "type": "string", "description": "A link to the instance" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." }, "proposedBusinessTitle": { "type": "string", "description": "The new business title for the \\~worker\\~ as of the effective date. If there is no business title override, this field defaults to the job title or job profile name." } }, "required": [ "PCID", "ID" ]}
Creates a job change instance with the specified data.Parameters:
Parameter
Type
Required
Default
Description
ID
string
Yes
—
The Workday ID of the resource.
descriptor
string
No
—
The display name of the instance
effective
string
No
—
The date this business process takes effect.
href
string
No
—
A link to the instance
id
string
No
—
Workday Id or Reference Id of the instance.
jobChangeReason
object
No
—
Returns the reason used in a Change Job business process.
moveManagersTeam
boolean
No
—
Returns a boolean that indicates whether teams reporting to the ~Manager~ moved with them during the Change Job Event.
proposedOrganizations
any[]
No
—
Contains the organizations with staffing behavior that are assigned to the position as a result of this event. All staffing behavior organization types are included (company, cost center, region, custom organizations, fund, grant, program, gift, business unit).
supervisoryOrganization
object
No
—
The ~supervisory organization~ for the ~worker~ as of the effective date.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ID": { "type": "string", "description": "The Workday ID of the resource." }, "descriptor": { "type": "string", "description": "The display name of the instance" }, "effective": { "type": "string", "description": "The date this business process takes effect." }, "href": { "type": "string", "description": "A link to the instance" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." }, "jobChangeReason": { "description": "Returns the reason used in a Change Job business process." }, "moveManagersTeam": { "type": "boolean", "description": "Returns a boolean that indicates whether teams reporting to the \\~Manager\\~ moved with them during the Change Job Event." }, "proposedOrganizations": { "type": "array", "description": "Contains the organizations with staffing behavior that are assigned to the position as a result of this event. All staffing behavior organization types are included (company, cost center, region, custom organizations, fund, grant, program, gift, business unit)." }, "supervisoryOrganization": { "description": "The \\~supervisory organization\\~ for the \\~worker\\~ as of the effective date." } }, "required": [ "PCID", "ID" ]}