Skip to main content
Server path: /workday-common | Type: Application | PCID required: Yes

Tools

ToolDescription
workday_common_get_businesstitlechanges_by_idRetrieves a business title change instance.
workday_common_get_currenciesRetrieves a collection of currencies.
workday_common_get_currencies_by_idRetrieves a currency instance.
workday_common_get_customers_by_idRetrieves a customer instance.
workday_common_get_customers_by_id_activitiesRetrieves a collection of activities for a specific customer.
workday_common_get_customers_by_id_activities_by_subresourceidRetrieves an activity instance for a specific customer.
workday_common_get_jobchangereasonsRetrieves a collection of job change reasons.
workday_common_get_jobchangereasons_by_idRetrieves a job change reason instance.
workday_common_get_organizationsRetrieves a collection of organizations.
workday_common_get_organizations_by_idRetrieves an organization instance.
workday_common_get_organizationtypesRetrieves a collection of organization types.
workday_common_get_organizationtypes_by_idRetrieves an organization type instance.
workday_common_get_supervisoryorganizationsRetrieves a collection of supervisory organizations.
workday_common_get_supervisoryorganizations_by_idRetrieves a supervisory organization instance.
workday_common_get_supervisoryorganizations_by_id_workersRetrieves a collection of workers for a specific supervisory organization.
workday_common_get_supervisoryorganizations_by_id_workers_by_subresourceidRetrieves a worker instance for a specific supervisory organization.
workday_common_get_workersRetrieves a collection of workers.
workday_common_get_workers_by_idRetrieves a worker instance.
workday_common_get_workers_by_id_businesstitlechangesRetrieves a collection of business title changes for a specific worker.
workday_common_get_workers_by_id_businesstitlechanges_by_subresourceidRetrieves a business title change instance for a specific worker.
workday_common_get_workers_by_id_directreportsRetrieves a collection of direct reports for a specific worker.
workday_common_get_workers_by_id_directreports_by_subresourceidRetrieves a direct report instance for a specific worker.
workday_common_get_workers_by_id_historyRetrieves a collection of history items for a specific worker.
workday_common_get_workers_by_id_history_by_subresourceidRetrieves a history instance for a specific worker.
workday_common_get_workers_by_id_inboxtasksRetrieves a collection of inbox tasks for a specific worker.
workday_common_get_workers_by_id_inboxtasks_by_subresourceidRetrieves an inbox task instance for a specific worker.
workday_common_get_workers_by_id_organizationsRetrieves a collection of organizations for a specific worker.
workday_common_get_workers_by_id_organizations_by_subresourceidRetrieves an organization instance for a specific worker.
workday_common_get_workers_by_id_payslipsRetrieves a collection of pay slips for a specific worker.
workday_common_get_workers_by_id_payslips_by_subresourceidRetrieves a pay slip instance for a specific worker.
workday_common_get_workers_by_id_supervisoryorganizationsmanagedRetrieves a collection of supervisory organizations managed by a specific worker.
workday_common_get_workers_by_id_supervisoryorganizationsmanaged_by_subresourceidRetrieves a supervisory organization managed by a specific worker.
workday_common_get_workers_by_id_timeoffentriesRetrieves a collection of time off entries for a specific worker.
workday_common_get_workers_by_id_timeoffentries_by_subresourceidRetrieves a time off entry for a specific worker.
workday_common_get_workers_by_id_timeoffplansRetrieves a collection of time off plans for a specific worker.
workday_common_get_workers_by_id_timeoffplans_by_subresourceidRetrieves a particular time off plan for a specific worker.
workday_common_post_workers_by_id_businesstitlechangesCreates a business title change instance with the specified data.
workday_common_post_workers_by_id_businesstitlechanges_me<b>Secured by:</b> Change My Business Title <b>Scope:</b> Staffing
workday_common_post_workers_by_id_jobchangesCreates a job change instance with the specified data.

workday_common_get_businesstitlechanges_by_id

Retrieves a business title change instance. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.

workday_common_get_currencies

Retrieves a collection of currencies. Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoThe maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNoThe 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.

workday_common_get_currencies_by_id

Retrieves a currency instance. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.

workday_common_get_customers_by_id

Retrieves a customer instance. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.

workday_common_get_customers_by_id_activities

Retrieves a collection of activities for a specific customer. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
fromDatestringNofromDate
limitintegerNoThe maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNoThe 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.
toDatestringNotoDate

workday_common_get_customers_by_id_activities_by_subresourceid

Retrieves an activity instance for a specific customer. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
subresourceIDstringYesThe Workday ID of the subresource.

workday_common_get_jobchangereasons

Retrieves a collection of job change reasons. Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoThe maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNoThe 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.

workday_common_get_jobchangereasons_by_id

Retrieves a job change reason instance. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.

workday_common_get_organizations

Retrieves a collection of organizations. Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoThe maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNoThe 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.
organizationTypestringNoReference to an Organization Type. Example: Organization Type WID. Requests must provide an Organization Type.

workday_common_get_organizations_by_id

Retrieves an organization instance. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.

workday_common_get_organizationtypes

Retrieves a collection of organization types. Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoThe maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNoThe 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.

workday_common_get_organizationtypes_by_id

Retrieves an organization type instance. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.

workday_common_get_supervisoryorganizations

Retrieves a collection of supervisory organizations. Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoThe maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNoThe 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.

workday_common_get_supervisoryorganizations_by_id

Retrieves a supervisory organization instance. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.

workday_common_get_supervisoryorganizations_by_id_workers

Retrieves a collection of workers for a specific supervisory organization. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
limitintegerNoThe maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNoThe 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.

workday_common_get_supervisoryorganizations_by_id_workers_by_subresourceid

Retrieves a worker instance for a specific supervisory organization. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
subresourceIDstringYesThe Workday ID of the subresource.

workday_common_get_workers

Retrieves a collection of workers. Parameters:
ParameterTypeRequiredDefaultDescription
includeTerminatedWorkersbooleanNoInclude terminated workers in the output
limitintegerNoThe maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNoThe 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.
searchstringNosearch

workday_common_get_workers_by_id

Retrieves a worker instance. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.

workday_common_get_workers_by_id_businesstitlechanges

Retrieves a collection of business title changes for a specific worker. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
limitintegerNoThe maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNoThe 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.

workday_common_get_workers_by_id_businesstitlechanges_by_subresourceid

Retrieves a business title change instance for a specific worker. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
subresourceIDstringYesThe Workday ID of the subresource.

workday_common_get_workers_by_id_directreports

Retrieves a collection of direct reports for a specific worker. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
limitintegerNoThe maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNoThe 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.

workday_common_get_workers_by_id_directreports_by_subresourceid

Retrieves a direct report instance for a specific worker. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
subresourceIDstringYesThe Workday ID of the subresource.

workday_common_get_workers_by_id_history

Retrieves a collection of history items for a specific worker. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
limitintegerNoThe maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNoThe 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.

workday_common_get_workers_by_id_history_by_subresourceid

Retrieves a history instance for a specific worker. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
subresourceIDstringYesThe Workday ID of the subresource.

workday_common_get_workers_by_id_inboxtasks

Retrieves a collection of inbox tasks for a specific worker. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
limitintegerNoThe maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNoThe 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.

workday_common_get_workers_by_id_inboxtasks_by_subresourceid

Retrieves an inbox task instance for a specific worker. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
subresourceIDstringYesThe Workday ID of the subresource.

workday_common_get_workers_by_id_organizations

Retrieves a collection of organizations for a specific worker. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
limitintegerNoThe maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNoThe 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.

workday_common_get_workers_by_id_organizations_by_subresourceid

Retrieves an organization instance for a specific worker. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
subresourceIDstringYesThe Workday ID of the subresource.

workday_common_get_workers_by_id_payslips

Retrieves a collection of pay slips for a specific worker. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
limitintegerNoThe maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNoThe 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.

workday_common_get_workers_by_id_payslips_by_subresourceid

Retrieves a pay slip instance for a specific worker. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
subresourceIDstringYesThe Workday ID of the subresource.

workday_common_get_workers_by_id_supervisoryorganizationsmanaged

Retrieves a collection of supervisory organizations managed by a specific worker. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
limitintegerNoThe maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNoThe 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.

workday_common_get_workers_by_id_supervisoryorganizationsmanaged_by_subresourceid

Retrieves a supervisory organization managed by a specific worker. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
subresourceIDstringYesThe Workday ID of the subresource.

workday_common_get_workers_by_id_timeoffentries

Retrieves a collection of time off entries for a specific worker. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
limitintegerNoThe maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNoThe 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.

workday_common_get_workers_by_id_timeoffentries_by_subresourceid

Retrieves a time off entry for a specific worker. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
subresourceIDstringYesThe Workday ID of the subresource.

workday_common_get_workers_by_id_timeoffplans

Retrieves a collection of time off plans for a specific worker. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
limitintegerNoThe maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNoThe 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.

workday_common_get_workers_by_id_timeoffplans_by_subresourceid

Retrieves a particular time off plan for a specific worker. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
subresourceIDstringYesThe Workday ID of the subresource.

workday_common_post_workers_by_id_businesstitlechanges

Creates a business title change instance with the specified data. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
descriptorstringNoThe display name of the instance
hrefstringNoA link to the instance
idstringNoWorkday Id or Reference Id of the instance.
proposedBusinessTitlestringNoThe 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.

workday_common_post_workers_by_id_businesstitlechanges_me

<b>Secured by:</b> Change My Business Title <b>Scope:</b> Staffing Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
descriptorstringNoThe display name of the instance
hrefstringNoA link to the instance
idstringNoWorkday Id or Reference Id of the instance.
proposedBusinessTitlestringNoThe 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.

workday_common_post_workers_by_id_jobchanges

Creates a job change instance with the specified data. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
descriptorstringNoThe display name of the instance
effectivestringNoThe date this business process takes effect.
hrefstringNoA link to the instance
idstringNoWorkday Id or Reference Id of the instance.
jobChangeReasonobjectNoReturns the reason used in a Change Job business process.
moveManagersTeambooleanNoReturns a boolean that indicates whether teams reporting to the ~Manager~ moved with them during the Change Job Event.
proposedOrganizationsany[]NoContains 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).
supervisoryOrganizationobjectNoThe ~supervisory organization~ for the ~worker~ as of the effective date.