org.mule.modules

mule-module-workday

config

Namespace	http://www.mulesoft.org/schema/mule/wd-hr
Schema Location	http://www.mulesoft.org/schema/mule/wd-hr/current/mule-wd-hr.xsd (View Schema)
Schema Version	2.0
Minimum Mule Version	3.4

Module Overview

The Human Resources Web Service contains operations that expose Workday Human Capital Management Business Services data, including Employee, Contingent Worker and Organization information. This Web Service can be used for integration with enterprise systems including corporate directories, data analysis tools, email or other provisioning sub-systems, or any other systems needing Worker and/or Organization data.

Summary

Configuration
<wd-hr:config> Configure an instance of this module

Message Processors
<wd-hr:add-academic-appointment> This operation will invoke the Business Process to add an Academic Appointment.
<wd-hr:add-update-organization> Adds a new Organization (or updates an existing Organization) with the supplied information
<wd-hr:add-workday-account> Adds a new Workday Account (e.g.
<wd-hr:change-additional-names> Sets a worker's additional names.
<wd-hr:change-background-check-status> Updates the employee's background check status by adding a new instance of Background Check Descriptor, which stores Status Date, Status, and Comment.
<wd-hr:change-government-ids> This web service allows the updating of Government IDs for a worker.
<wd-hr:change-legal-name> Sets a worker's legal name.
<wd-hr:change-licenses> This web service allows the updating of Licenses for a worker.
<wd-hr:change-other-ids> This web service allows the updating of Other IDs for a worker.
<wd-hr:change-passports-and-visas> This web service allows the updating of Passports and Visas for a worker.
<wd-hr:change-personal-information> Sets a worker's personal information.
<wd-hr:change-preferred-name> Sets a worker's preferred name.
<wd-hr:dissolve-organization-structure> This operation will dissolve an Organization structure (e.g.
<wd-hr:end-academic-appointment> This operation will invoke the Business Process to end an Academic Appointment.
<wd-hr:find-organization> This operation responds with a set of references to Organizations that match the criteria specified in the request element.
<wd-hr:get-academic-unit-hierarchies> This operation is used to retrieve Academic Unit Hierarchies.
<wd-hr:get-academic-units> Returns detailed information for Academic Units.
<wd-hr:get-company-insider-types> This operation will get Company Insider Types for the specified criteria.
<wd-hr:get-contingent-worker> This operation retrieves data related to a Contingent Worker and his/her Contract and Personal information.
<wd-hr:get-contingent-worker-contract-info> This operation retrieves data related to a Contingent Worker and his/her Contract information.
<wd-hr:get-contingent-worker-personal-info> This operation retrieves data related to a Contingent Worker and his/her Personal (e.g.
<wd-hr:get-difficulty-to-fill> Gets the difficulty level of filling a job profile.
<wd-hr:get-disabilities> This operation retrieves the disabilities that are currently defined.
<wd-hr:get-employee> This operation retrieves data related to an Employee and his/her Employment, Personal and Compensation.
<wd-hr:get-employee-employment-info> This operation retrieves data related to an Employee and his/her Employment (e.g.
<wd-hr:get-employee-image> Get a photographic image of this employee.
<wd-hr:get-employee-personal-info> This operation retrieves data related to an Employee and his/her Personal (e.g.
<wd-hr:get-employee-related-persons> This operation retrieves data related to an Employee's Related Persons (e.g.
<wd-hr:get-ethnicities> This operation retrieves data related to Ethnicities.
<wd-hr:get-former-workers> This operation retrieves Former Workers.
<wd-hr:get-frequencies> This operation retrieves data related to Frequencies.
<wd-hr:get-holiday-calendars> Returns Holiday Calendars based on criteria.
<wd-hr:get-job-categories> This operation will get Job Categories for the specified criteria.
<wd-hr:get-job-classification-groups> Returns job classification group data.
<wd-hr:get-job-families> Returns job family data.
<wd-hr:get-job-family-groups> Returns job family and job family group data.
<wd-hr:get-job-profiles> This operation retrieves data related to a Job Profile for the specified criteria.
<wd-hr:get-locations> This operation retrieves data related to a Location for the specified criteria.
<wd-hr:get-organization> This operation retrieves data related to an Organization (e.g.
<wd-hr:get-organizations> Returns organization information for a type of organization.
<wd-hr:get-political-affiliations> This operation retrieves the political affiliations that are currently defined.
<wd-hr:get-previous-system-job-history> Returns a worker's job or position history imported from a previous system; that is, the user's system prior to migrating to Workday.
<wd-hr:get-provisioning-group-assignments> This web service operation will get assignments of persons to provisioning groups.
<wd-hr:get-provisioning-groups> This web service operation will get provisioning groups.
<wd-hr:get-search-settings> This operation will get information for search settings.
<wd-hr:get-server-timestamp> This operation retrieves Workday's current system datetime.
<wd-hr:get-training-types> This operation retrieves Training Types defined in the system.
<wd-hr:get-work-shifts> This operation retrieves data related to a Work Shift.
<wd-hr:get-worker-event-history> This operation retrieves references to all Events (created through workflow) associated with a Worker based on the Event Type and Date parameters.
<wd-hr:get-worker-profile> This operation retrieves a subset of data related to a Worker (e.g.
<wd-hr:get-workers> Returns information for specified workers.
<wd-hr:get-workers-compensation-codes> This operation will get Workers Compensation Codes for the specified criteria.
<wd-hr:inactivate-organization> This operation will inactivate an Organization.
<wd-hr:maintain-contact-information> Creates or updates contact information for a person.
<wd-hr:manage-union-membership> Operation that will add a new worker to a union.
<wd-hr:put-academic-unit> This operation adds or updates Academic Units
<wd-hr:put-academic-unit-hierarchy> This operation is used to create an Academic Unit Hierarchy.
<wd-hr:put-address-for-country-format-extension> Use this operation ONLY for the country format extension.
<wd-hr:put-company-insider-type> This operation adds or updates Company Insider Types.
<wd-hr:put-difficulty-to-fill> This operation adds or updates a job profile's Difficulty to Fill.
<wd-hr:put-disability> This operation adds or updates a Disability.
<wd-hr:put-ethnicity> This operation adds or updates an Ethnicity.
<wd-hr:put-former-worker> This operation allows Former Workers to be added and edited.
<wd-hr:put-frequency> This operation adds or updates a Frequency.
<wd-hr:put-holiday-calendar> Adds or updates Holiday Calendar.
<wd-hr:put-job-category> This operation adds or updates a Job Category.
<wd-hr:put-job-classification-group> Adds or updates a job classification group and/or job classifications.
<wd-hr:put-job-family> Adds or updates a job family.
<wd-hr:put-job-family-group> Adds or updates a job family group.
<wd-hr:put-job-profile> This operations adds or updates a Job Profile.
<wd-hr:put-location> This operation adds or updates a Location.
<wd-hr:put-political-affiliation> This operation adds or updates a Political Affiliation.
<wd-hr:put-previous-system-job-history> Loads history for a Worker whose history did not get loaded during the initial implementation period.
<wd-hr:put-provisioning-group> This web service operation updates an existing provisioning group if a reference is provided on the request, else it creates a new one.
<wd-hr:put-provisioning-group-assignment> This operation creates or updates the assignment of a person to a provisioning group.
<wd-hr:put-search-settings> This operation will put search configurations into workday.
<wd-hr:put-training-type> This operation adds or updates a Training Type
<wd-hr:put-work-shift> This operation adds or updates a Work Shift.
<wd-hr:put-workers-compensation-code> This operation adds or updates a Worker's Compensation Code.
<wd-hr:update-academic-appointment> This operation will invoke the Business Process to update an Academic Appointment.
<wd-hr:update-contingent-worker-personal-info> This operation updates Personal (e.g.
<wd-hr:update-employee-image> This operation updates an image (e.g.
<wd-hr:update-employee-personal-info> This operation updates Personal (e.g.
<wd-hr:update-workday-account> This operation updates an existing Workday Account (e.g.

Configuration

To use the this module within a flow the namespace to the module must be included. The resulting flow will look similar to the following:

<mule xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xmlns:wd-hr="http://www.mulesoft.org/schema/mule/wd-hr"
      xsi:schemaLocation="
               http://www.mulesoft.org/schema/mule/core
               http://www.mulesoft.org/schema/mule/core/current/mule.xsd
               http://www.mulesoft.org/schema/mule/wd-hr
               http://www.mulesoft.org/schema/mule/wd-hr/current/mule-wd-hr.xsd">

      <!-- here goes your flows and configuration elements -->

</mule>

Connection Pool

This connector offers automatic connection management via the use of a connection pool. The pool will act a storage mechanism for all the connections that are in-use by the user of this connector.

Prior to execution of a processor, the connector will attempt to lookup an already established connection and if one doesn't exists it will create one. That lookup mechanism is done in the connection pool via the use of connection variables declared as keys.

The user of the connector can configure the pool by adding a connection-pooling-profile to the connector configuration like this:

    <wd-hr:connection-pooling-profile maxActive="10" maxIdle="10"
                             exhaustedAction="WHEN_EXHAUSTED_GROW" maxWait="120" minEvictionMillis="60000" evictionCheckIntervalMillis="30000"/>

The following is a list of connection attributes, each connection attribute can be configured at the config element level or they can also be added to each processor. If they are used at the processor level they get the benefit of full expression resolution.

Connection Attributes
Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
hrUser		Workday user	String	/	UTF-8
hrPassword		Workday password	String	/	UTF-8
hrEndpoint		Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Reconnection Strategies

Reconnection Strategies specify how a connector behaves when its connection fails. You can control how Mule attempts to reconnect by specifying a number of criteria:

The type of exception
Number and frequency of reconnection attempts
The notifications generated, and more

With a reconnection strategy, you can better control the behavior of a failed connection, by configuring it, for example, to re-attempt the connection only once every 15 minutes, and to give up after 30 attempts. You can also send an automatic notification to your IT administrator whenever this reconnection strategy goes into effect. You can even define a strategy that attempts to reconnect only during business hours. Such a setting can prove useful if your server is frequently shut down for nightly maintenance.

Configuration

A reconnection strategy that allows the user to configure how many times a reconnection should be attempted and how long to wait between attempts.

    <wd-hr:config>
         <reconnect count="5" frequency="1000"/>
    </wd-hr:config>

Reconnect Attributes
Name	Default Value	Description
frequency	2000	Optional. How often (in ms) to reconnect
count	2	Optional. How many reconnection attempts to make

For more information about reconnection strategies in Mule, or even how to write your own custom reconnection strategy please check this section.

Message Processors

<wd-hr:add-academic-appointment>

This operation will invoke the Business Process to add an Academic Appointment.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
addAcademicAppointmentRequest	#[payload]	Optional. The request object for the operation	AddAcademicAppointmentRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
AcademicAppointmentResponseType	The response from the operation

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:add-update-organization>

Adds a new Organization (or updates an existing Organization) with the supplied information

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
organization	#[payload]	Optional. Encapsulating element containing all Organization data.	OrganizationAddUpdateType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
OrganizationAddUpdateType	the updated organization

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:add-workday-account>

Adds a new Workday Account (e.g. User Name / Password) with the supplied information

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
workdayAccount	#[payload]	Optional. Data element to add a new User Account into the Workday system.	WorkdayAccountForWorkerAddType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
WorkdayAccountForWorkerAddType	the added Workday account

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:change-additional-names>

Sets a worker's additional names. Does not use an event.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
changeAdditionalNamesRequest	#[payload]	Optional. The request object for the operation	ChangeAdditionalNamesRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
ChangeAdditionalNamesResponseType	The response from the operation

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:change-background-check-status>

Updates the employee's background check status by adding a new instance of Background Check Descriptor, which stores Status Date, Status, and Comment.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
changeBackground	#[payload]	Optional. Object encapsulating background check status change	ChangeBackgroundCheckStatusRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
ChangeBackgroundCheckStatusResponseType	element containing information on Background Check Event

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:change-government-ids>

This web service allows the updating of Government IDs for a worker.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
changeGovernmentIDsRequest	#[payload]	Optional. The request object for the operation	ChangeGovernmentIDsRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
ChangeGovernmentIDsResponseType	The response from the operation

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:change-legal-name>

Sets a worker's legal name. Uses the Legal Name Change business process.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
changeLegalNameRequest	#[payload]	Optional. The request object for the operation	ChangeLegalNameRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
ChangeLegalNameResponseType	The response from the operation

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:change-licenses>

This web service allows the updating of Licenses for a worker.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
changeLicensesRequest	#[payload]	Optional. The request object for the operation	ChangeLicensesRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
ChangeLicensesResponseType	The response from the operation

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:change-other-ids>

This web service allows the updating of Other IDs for a worker.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
changeOtherIDsRequest	#[payload]	Optional. The request object for the operation	ChangeOtherIDsRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
ChangeOtherIDsResponseType	The response from the operation

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:change-passports-and-visas>

This web service allows the updating of Passports and Visas for a worker.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
changePassportsAndVisasRequest	#[payload]	Optional. The request object for the operation	ChangePassportsAndVisasRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
ChangePassportsAndVisasResponseType	The response from the operation

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:change-personal-information>

Sets a worker's personal information. Uses the Personal Information Change business process.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
changePersonalInformationRequest	#[payload]	Optional. The request object for the operation	ChangePersonalInformationRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
ChangePersonalInformationResponseType	The response from the operation

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:change-preferred-name>

Sets a worker's preferred name. Uses the Preferred Name Change business process.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
changePreferredNameRequest	#[payload]	Optional. The request object for the operation	ChangePreferredNameRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
ChangePreferredNameResponseType	The response from the operation

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:dissolve-organization-structure>

This operation will dissolve an Organization structure (e.g. disconnect the subordinate and contained organizations).

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
organizationStructureDissolve	#[payload]	Optional. Element containing organization dissolve information	OrganizationStructureDissolveType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
OrganizationStructureDissolveType	element containing all Organization Structure Dissolve data.

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:end-academic-appointment>

This operation will invoke the Business Process to end an Academic Appointment.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
endAcademicAppointmentRequest	#[payload]	Optional. The request object for the operation	EndAcademicAppointmentRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
AcademicAppointmentResponseType	The response from the operation

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:find-organization>

This operation responds with a set of references to Organizations that match the criteria specified in the request element. Utilize the following criteria options to search for Contingent Workers within the Workday system. The Contingent Worker references that are returned are those that satisfy ALL criteria included in the request. Therefore, the result set will become more limited with every criterium that is populated.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
organizationFind	#[payload]	Optional. Search options	OrganizationFindType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
List<OrganizationReferenceWWSType>	Set of Contingent Worker Reference elements.

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:get-academic-unit-hierarchies>

This operation is used to retrieve Academic Unit Hierarchies.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
getAcademicUnitHierarchiesRequest	#[payload]	Optional. The request object for the operation	GetAcademicUnitHierarchiesRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetAcademicUnitHierarchiesResponseType	The response from the operation

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:get-academic-units>

Returns detailed information for Academic Units.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
getAcademicUnitsRequest	#[payload]	Optional. The request object for the operation	GetAcademicUnitsRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetAcademicUnitsResponseType	The response from the operation

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:get-company-insider-types>

This operation will get Company Insider Types for the specified criteria. The request criteria can be for a single entry based on a Reference ID or all Company Insider Types will be retrieved if no criteria is specified. Company Insider Type data includes the Reference ID, the name and the description.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
companyInsiderRequest	#[payload]	Optional. Search options	GetCompanyInsiderTypesRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetCompanyInsiderTypesResponseType	Element containing Company Insider response elements including received criteria, references, data based on criteria and grouping, results filter and result summary.

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:get-contingent-worker>

This operation retrieves data related to a Contingent Worker and his/her Contract and Personal information. Utilize the Reference element (and other optional attributes) to retrieve an instance of Contingent Worker and its associated data.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
contingentWorkerRequest	#[payload]	Optional. Search options	ContingentWorkerGetType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
ContingentWorkerType	element containing an instance of Contingent Worker and its associated data.

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:get-contingent-worker-contract-info>

This operation retrieves data related to a Contingent Worker and his/her Contract information. Utilize the reference element (and other optional attributes) to retrieve an instance of Contingent Worker and his/her Contract Information.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
contingentWorkerContractInfoRequest	#[payload]	Optional. Request information	ContingentWorkerContractInfoGetType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
ContingentWorkerContractInfoType	element containing an instance of Contingent Worker and his/her Contract Information.

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:get-contingent-worker-personal-info>

This operation retrieves data related to a Contingent Worker and his/her Personal (e.g. Biographic, Demographic, etc.) information. Utilize the reference element (and other optional attributes) to retrieve an instance of Contingent Worker and his/her Contract Information.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
contingentWorkerPersonalInfoRequest	#[payload]	Optional. Search options	ContingentWorkerPersonalInfoGetType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
ContingentWorkerPersonalInfoType	element containing an instance of Contingent Worker and his/her Personal Information.

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:get-difficulty-to-fill>

Gets the difficulty level of filling a job profile.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
difficultyToFillRequest	#[payload]	Optional. The request component of the Get Difficulty to Fill web service task.	GetDifficultyToFillRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetDifficultyToFillResponseType	element for difficulty to fill

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:get-disabilities>

This operation retrieves the disabilities that are currently defined.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
disabilitiesRequest	#[payload]	Optional. Request element for Get Disabilies service task	GetDisabilitiesRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetDisabilitiesResponseType	Contains the response elements for the Get Disabilities and Put Disability service requests.

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:get-employee>

This operation retrieves data related to an Employee and his/her Employment, Personal and Compensation.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
employeeRequest	#[payload]	Optional. The criteria to look for	EmployeeGetType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
EmployeeType	An instance of Employee and its associated data.

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:get-employee-employment-info>

This operation retrieves data related to an Employee and his/her Employment (e.g. Position, Job, Status, etc.) information.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
employeeEmploymentInfoRequest	#[payload]	Optional. Reference element (and other optional attributes) to retrieve an instance of Employee and his/her Employment Information.	EmployeeEmploymentInfoGetType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
EmployeeEmploymentInfoType	element containing an instance of Employee and his/her Employment Information.

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:get-employee-image>

Get a photographic image of this employee.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
employeeImageRequest	#[payload]	Optional. The reference to the employee for which the photographic image is required	EmployeeImageGetType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
EmployeeImageType	The Employee photographic image data for a specified employee reference

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:get-employee-personal-info>

This operation retrieves data related to an Employee and his/her Personal (e.g. Biographic, Demographic, etc.) information.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
employeePersonalInfoRequest	#[payload]	Optional. Reference element (and other optional attributes) to retrieve an instance of Employee and his/her Personal Information.	EmployeePersonalInfoGetType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
EmployeePersonalInfoType	element containing an instance of Employee and his/her Personal Information.

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:get-employee-related-persons>

This operation retrieves data related to an Employee's Related Persons (e.g. Dependents, Beneficiaries, etc.) and each of his/her Personal (e.g. Biographic, Demographic, etc.) information.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
employeeRelatedPersonsRequest	#[payload]	Optional. Reference element (and other optional attributes) to retrieve an instance of Employee, all of his/her Related Persons and personal information for each.	EmployeeRelatedPersonsGetType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
EmployeeRelatedPersonsType	element containing an instance of Employee, all of his/her Related Persons and personal information for each.

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:get-ethnicities>

This operation retrieves data related to Ethnicities.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
ethnicitiesRequest	#[payload]	Optional. Request element	GetEthnicitiesRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetEthnicitiesResponseType	response element

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:get-former-workers>

This operation retrieves Former Workers. Former Worker Storage is for tracking data for individuals that have previously been employed but were not included as a Workday worker. Data includes personal details, contact information, and job details as of termination date.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
getFormerWorkersRequest	#[payload]	Optional. The request object for the operation	GetFormerWorkersRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetFormerWorkersResponseType	The response from the operation

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:get-frequencies>

This operation retrieves data related to Frequencies.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
frequenciesRequest	#[payload]	Optional. Request element	GetFrequenciesRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetFrequenciesResponseType	get frequencies response

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:get-holiday-calendars>

Returns Holiday Calendars based on criteria.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
getHolidayCalendarsRequest	#[payload]	Optional. The request object for the operation	GetHolidayCalendarsRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetHolidayCalendarsResponseType	The response from the operation

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:get-job-categories>

This operation will get Job Categories for the specified criteria. The request criteria can be for a single entry based on a Reference ID or all Job Categories will be retrieved if no criteria is specified. Job Category data includes the Reference ID, the name and the description and inactive flag.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
jobCategoriesRequest	#[payload]	Optional. Request reference and filter for getting Job Category data.	GetJobCategoriesRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetJobCategoriesResponseType	Element containing Job Category response elements include received criteria, references, data based on criteria and grouping, results filter and result summary.

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:get-job-classification-groups>

Returns job classification group data.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
jobClassificationGroupsRequest	#[payload]	Optional. Request element	GetJobClassificationGroupsRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetJobClassificationGroupsResponseType	response element

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:get-job-families>

Returns job family data.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
jobFamiliesRequest	#[payload]	Optional. Request element	GetJobFamiliesRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetJobFamiliesResponseType	response element

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:get-job-family-groups>

Returns job family and job family group data.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
getJobFamilyGroupsRequest	#[payload]	Optional. The request object for the operation	GetJobFamilyGroupsRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetJobFamilyGroupsResponseType	The response from the operation

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:get-job-profiles>

This operation retrieves data related to a Job Profile for the specified criteria. The request criteria can be for a single entry based on a Reference ID, management level, job level, job family, job category, company insider type, job classification, workers compensation code, pay rate type , Job Exempt location context, work hours profiles or all Job Profiles will be retrieved if no criteria is specified. The data returned is organized into different response groups which can be include or not.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
jobProfilesRequest	#[payload]	Optional. Element used to find and get Job Profiles and their associated data.	GetJobProfilesRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetJobProfilesResponseType	element containing an instances of job profiles and their associated data.

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:get-locations>

This operation retrieves data related to a Location for the specified criteria. The request criteria can be for a single entry based on a Reference ID, Location Name or all Locations will be retrieved if no criteria is specified.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
locationsRequest	#[payload]	Optional. Element used to find and get Locations and their associated data.	GetLocationsRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetLocationsResponseType	element containing instances of locations and their associated data.

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:get-organization>

This operation retrieves data related to an Organization (e.g. Staffing Configuration, Structure, etc.).

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
organizationRequest	#[payload]	Optional. Element (and other optional attributes) to retrieve an instance of Organization and its associated data.	OrganizationGetType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
OrganizationType	element containing an instance of Organization and its associated data.

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:get-organizations>

Returns organization information for a type of organization. If the request does not specify an organization, the operation returns information for all organizations.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
organizationsRequest	#[payload]	Optional. Request	GetOrganizationsRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetOrganizationsResponseType	Contains each Organization based on the Request References or Request Criteria. The data returned is the current information as of the dates in the response filter, and does not include all historical information about the Organization.

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:get-political-affiliations>

This operation retrieves the political affiliations that are currently defined.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
getPoliticalAffiliationsRequest	#[payload]	Optional. The request object for the operation	GetPoliticalAffiliationsRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetPoliticalAffiliationsResponseType	The response from the operation

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:get-previous-system-job-history>

Returns a worker's job or position history imported from a previous system; that is, the user's system prior to migrating to Workday.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
previousSystemJobHistoryRequest	#[payload]	Optional. Request element used to return a worker's job/position history loaded from a previous system. If no worker reference is requested, then all workers with previous system job data will be returned.	GetPreviousSystemJobHistoryRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetPreviousSystemJobHistoryResponseType	element containing the instances of workers and their previous job history.

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:get-provisioning-group-assignments>

This web service operation will get assignments of persons to provisioning groups. For each assignment a reference to the provisioning group, the person, the worker and status information will be returned. The request can be made for a list of persons as specified in the request criteria. Alternatively a list of workers can be specified there. Requests can also be made for individual assignments by specifying an assignment reference. If no request references or criteria are specified, the assignments for all persons will be returned.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
provisioningGroupAssignmentsRequest	#[payload]	Optional. Element to retrieve assignments of persons and workers to provisioning groups.	GetProvisioningGroupAssignmentsRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
ProvisioningGroupAssignmentsResponseType	element containing the requested instances of provisioning group assignments and their associated data.

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:get-provisioning-groups>

This web service operation will get provisioning groups. It will return the provisioning groups and their associated information excluding any provisioning group assignments. The request can be for a single transaction based on reference, or all transactions can be retrieved if no reference is specified.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
provisioningGroupsRequest	#[payload]	Optional. Element to retrieve provisioning group setup data.	GetProvisioningGroupsRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
ProvisioningGroupsResponseType	element containing the requested instances of provisioning groups and their associated data.

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:get-search-settings>

This operation will get information for search settings.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
searchSettingsRequest	#[payload]	Optional. Request object	GetSearchSettingsRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetSearchSettingsResponseType	element search setup data

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:get-server-timestamp>

This operation retrieves Workday's current system datetime.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
ServerTimestampType	element containing the current DateTime of the Workday system.

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:get-training-types>

This operation retrieves Training Types defined in the system.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
trainingTypesRequest	#[payload]	Optional. Request element for Get Training Types	GetTrainingTypesRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetTrainingTypesResponseType	Response element for Get Training Types

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:get-work-shifts>

This operation retrieves data related to a Work Shift.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
workShiftsRequest	#[payload]	Optional. Request references and filter for getting Work Shift Data.	GetWorkShiftsRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetWorkShiftsResponseType	Element containing Work Shift response elements including received criteria, references, data based on criteria and grouping, results filter and result summary.

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:get-worker-event-history>

This operation retrieves references to all Events (created through workflow) associated with a Worker based on the Event Type and Date parameters.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
workerEventHistoryRequest	#[payload]	Optional. Reference element (and other optional attributes) to retrieve instances of Worker Events and their associated data.	WorkerEventHistoryGetType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
WorkerEventHistoryType	element containing an instance of Worker and his/her Worker Event History.

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:get-worker-profile>

This operation retrieves a subset of data related to a Worker (e.g. Employee and Contingent Worker) and his/her Employment/Contract, Personal and Compensation information.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
workerProfileRequest	#[payload]	Optional. Reference element (and other optional attributes) to retrieve an instance of Worker and his/her summarized Personal and Employment/Contract information.	WorkerProfileGetType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
WorkerProfileType	element containing an instance of Worker and his/her summarized Personal and Employment/Contract information.

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:get-workers>

Returns information for specified workers. If the request does not specify a worker, then the operation returns information for all workers.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
workersRequest	#[payload]	Optional. Request element used to find and get workers and their associated data.	GetWorkersRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetWorkersResponseType	element containing an instances of workers and their associated data.

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:get-workers-compensation-codes>

This operation will get Workers Compensation Codes for the specified criteria. The request criteria can be for a single entry based on a Reference ID; a specified country, country region, or business site; or all Worker's Compensation Codes will be retrieved if no criteria is specified. Worker's Compensation Code data includes the code, name, business site, country, country region and inactive flag.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
workersCompensationCodesRequest	#[payload]	Optional. Contains request reference, filter and response group for getting Workers Compensation Code data	GetWorkersCompensationCodesRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetWorkersCompensationCodesResponseType	Element containing Worker Compensation Codes response elements including received criteria, references, data based on criteria and grouping, results filter and result summary

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:inactivate-organization>

This operation will inactivate an Organization.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
organizationInactivate	#[payload]	Optional. Elements to Inactivate an existing Organization within the Workday system.	OrganizationInactivateType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
OrganizationInactivateType	organization inactive reference

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:maintain-contact-information>

Creates or updates contact information for a person. Contact information includes email addresses, physical addresses, phone numbers, web addresses, and instant messenger contact information. Changes are routed through existing Contact Information for Person Event business process for necessary approvals. Submitted contact information by default replaces existing entries of the same type. For example, submitting a new email address replaces the current email address. Set the Add Only flag to override this default behavior. When this flag is set to true, existing information is not replaced in cases where multiple entries are allowed.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
contactInformation	#[payload]	Optional. Request object	MaintainContactInformationForPersonEventRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
MaintainContactInformationForPersonEventResponseType	The Contact Information for Person Event created by the corresponding request

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:manage-union-membership>

Operation that will add a new worker to a union. Generates a Union Membership Event.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
unionMembership	#[payload]	Optional. Element containing the information needed to create a new union member instance	ManageUnionMembershipRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
ManageUnionMembershipResponseType	the response data for the Put Union member WS. Returns the Union Membership Event Reference info for the instance created.

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:put-academic-unit>

This operation adds or updates Academic Units

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
putAcademicUnitRequest	#[payload]	Optional. The request object for the operation	PutAcademicUnitRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutAcademicUnitResponseType	The response from the operation

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:put-academic-unit-hierarchy>

This operation is used to create an Academic Unit Hierarchy.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
putAcademicUnitHierarchyRequest	#[payload]	Optional. The request object for the operation	PutAcademicUnitHierarchyRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutAcademicUnitHierarchyResponseType	The response from the operation

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:put-address-for-country-format-extension>

Use this operation ONLY for the country format extension. Since many countries require more granular address components than Workday currently supports, the Alternate Address Formats allow Workday customers to define a Basic and an Extended Address Format metadata for these countries. Customers can then control address formats using Tenant Setup - Global when they want to use extended formats for a country. This operation uploads addresses for a specified country after the addresses are modified to fit a new extended format. Note that the attribute use Extended Address Format in Tenant Setup - Global must be enabled for the country beforeusing this operation to uploading addresses.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
addressForCountryFormatExtension	#[payload]	Optional. Element containing Address update information.	PutAddressesForCountryFormatExtensionRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutAddressesForCountryFormatExtensionResponseType	element containing Address reference.

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:put-company-insider-type>

This operation adds or updates Company Insider Types.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
companyInsiderType	#[payload]	Optional. Contains data for adding or updating a Company Insider Type	PutCompanyInsiderTypeRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutCompanyInsiderTypeResponseType	Element containing Put Company Insider Type Response Data

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:put-difficulty-to-fill>

This operation adds or updates a job profile's Difficulty to Fill.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
difficultyToFill	#[payload]	Optional. Component of the Put Difficulty to Fill web service task.	PutDifficultyToFillRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutDifficultyToFillResponseType	element for difficulty to fill.

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:put-disability>

This operation adds or updates a Disability.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
disability	#[payload]	Optional. Element for Put Disability	PutDisabilityRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutDisabilityResponseType	element for the Put Disability operation.

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:put-ethnicity>

This operation adds or updates an Ethnicity.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
ethnicity	#[payload]	Optional. Request element for Put Ethnicity	PutEthnicityRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutEthnicityResponseType	Response element for Put Ethnicity

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:put-former-worker>

This operation allows Former Workers to be added and edited. Former Worker Storage is for tracking data for individuals that have previously been employed but were not included as a Workday worker. Data includes personal details, contact information, and job details as of termination date.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
putFormerWorkerRequest	#[payload]	Optional. The request object for the operation	PutFormerWorkerRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutFormerWorkerResponseType	The response from the operation

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:put-frequency>

This operation adds or updates a Frequency.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
frequency	#[payload]	Optional. Request element for Put Frequency	PutFrequencyRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutFrequencyResponseType	Response element for Put Frequency

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:put-holiday-calendar>

Adds or updates Holiday Calendar.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
putHolidayCalendarRequest	#[payload]	Optional. The request object for the operation	PutHolidayCalendarRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutHolidayCalendarResponseType	The response from the operation

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:put-job-category>

This operation adds or updates a Job Category.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
jobCategory	#[payload]	Optional. Contains data for adding or updating a Job Category.	PutJobCategoryRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutJobCategoryResponseType	Element containing the Put Job Category response data.

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:put-job-classification-group>

Adds or updates a job classification group and/or job classifications.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
jobClassificationGroup	#[payload]	Optional. Request Element for Put Job Classification Group	PutJobClassificationGroupRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutJobClassificationGroupResponseType	Response element for Put Job Classification

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:put-job-family>

Adds or updates a job family.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
jobFamily	#[payload]	Optional. Request element for Put Job Family	PutJobFamilyRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutJobFamilyResponseType	Response element for Put Job Family

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:put-job-family-group>

Adds or updates a job family group. Also adds or removes a group's associated job families.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
jobFamilyGroup	#[payload]	Optional. Request element for Put Job Family Group	PutJobFamilyGroupRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutJobFamilyGroupResponseType	Response element for the Put Job Family Group

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:put-job-profile>

This operations adds or updates a Job Profile.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
jobProfile	#[payload]	Optional. Contains data for adding or updating a Job Profile.	PutJobProfileRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutJobProfileResponseType	Response element for Put Job Profile.

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:put-location>

This operation adds or updates a Location. Location Addresses, Usages, Email Addresses, Phone Numbers, and Time Profile data can be added and updated with this operation.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
location	#[payload]	Optional. Contains data for adding or updating a Location.	PutLocationRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutLocationResponseType	Response element for Put Location operation.

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:put-political-affiliation>

This operation adds or updates a Political Affiliation.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
putPoliticalAffiliationRequest	#[payload]	Optional. The request object for the operation	PutPoliticalAffiliationRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutPoliticalAffiliationResponseType	The response from the operation

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:put-previous-system-job-history>

Loads history for a Worker whose history did not get loaded during the initial implementation period. This operation allows free-form text entry of changes that occurred between the Worker's original hire date and the date that the implementation occurred. Existing entries can be deleted or updated.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
previousSystemJobHistory	#[payload]	Optional. Contains the Data for adding, updating or deleting a previous system job history entry for a worker.	PutPreviousSystemJobHistoryRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutPreviousSystemJobHistoryResponseType	Response for Put Previous System Job History. Returns the worker.

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:put-provisioning-group>

This web service operation updates an existing provisioning group if a reference is provided on the request, else it creates a new one. The provisioning group data to be specified as part of the request includes the name and description. Assignment information needs to be submitted using the operation Put Provisioning Group Assignment.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
provisioningGroup	#[payload]	Optional. Put Provisioning Group Request	PutProvisioningGroupRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutProvisioningGroupResponseType	Reference to the provisioning group created or updated.

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:put-provisioning-group-assignment>

This operation creates or updates the assignment of a person to a provisioning group. If the an assignment between the person and the provisioning group exists, it will be updated with the data given in the request, else a new one will be created. The data to be specified include a reference to the person and the provisioning group. Alternatively to the person a worker can be specified. In this case the operation will retrieve the person for that worker and create or update the assignment between that person and the group. The assignment status does not have to be specified on the request. If it is omitted, a default status of “Assigned” will be set.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
provisioningGroupAssignment	#[payload]	Optional. Request element to add or update a provisioning group assignment	GetProvisioningGroupAssignmentsRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
ProvisioningGroupAssignmentsResponseType	Reference to the created or updated provisioning group assignment

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:put-search-settings>

This operation will put search configurations into workday.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
searchSettings	#[payload]	Optional. Put search settings request.	PutSearchSettingsRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutSearchSettingsResponseType	Response element containing tenant setup search data

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:put-training-type>

This operation adds or updates a Training Type

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
trainingType	#[payload]	Optional. Request element for Put Training	PutTrainingTypeRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutTrainingTypeResponseType	Response element for Put Training Type

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:put-work-shift>

This operation adds or updates a Work Shift.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
workShift	#[payload]	Optional. Contains data for adding or updating a Work Shift.	PutWorkShiftRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutWorkShiftResponseType	Element Containing Put Work Shift Response Data

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:put-workers-compensation-code>

This operation adds or updates a Worker's Compensation Code.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
workersCompensationCode	#[payload]	Optional. Contains data for adding or updating a Workers Compensation Code.	PutWorkersCompensationCodeRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutWorkersCompensationCodeResponseType	Element containing Put Workers Compensation Code Response Data

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:update-academic-appointment>

This operation will invoke the Business Process to update an Academic Appointment.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
updateAcademicAppointmentRequest	#[payload]	Optional. The request object for the operation	UpdateAcademicAppointmentRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
AcademicAppointmentResponseType	The response from the operation

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:update-contingent-worker-personal-info>

This operation updates Personal (e.g. Biographic, Demographic, etc.) information related to a Contingent Worker.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
contingentWorkerPersonalInfo	#[payload]	Optional. Element to update the Personal Information for an existing Contingent Worker within the Workday system.	ContingentWorkerPersonalInfoUpdateType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
ContingentWorkerPersonalInfoUpdateType	updated contingent worker personal info

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:update-employee-image>

This operation updates an image (e.g. picture) related to a employee.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
employeeImage	#[payload]	Optional. Element to update the Image (e.g. picture) for an existing Employee within the Workday system.	EmployeeImageUpdateType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
EmployeeImageUpdateType	updated image info

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:update-employee-personal-info>

This operation updates Personal (e.g. Biographic, Demographic, etc.) information related to an Employee

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
employeePersonalInfo	#[payload]	Optional. Update information	EmployeePersonalInfoUpdateType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
EmployeePersonalInfoUpdateType	updated employee personal info

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-hr:update-workday-account>

This operation updates an existing Workday Account (e.g. User Name / Password) with the supplied information.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
workdayAccount	#[payload]	Optional. Element to update an existing Workday Account into the Workday system.	WorkdayAccountForWorkerUpdateType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
hrUser		Optional. Workday user	String	/	UTF-8
hrPassword		Optional. Workday password	String	/	UTF-8
hrEndpoint		Optional. Workday endpoint	String	/	UTF-8
hrWsdlLocation	https://community.workday.com/custom/developer/API/Human_Resources/v20/Human_Resources.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
WorkdayAccountForWorkerUpdateType	updated workday account info

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown