Service Directory > v25.1 > Human_Resources

 

Web Service: Human_Resources (v25.1)

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.

Version

Operations

Operation Description
Add_Academic_Appointment This operation will invoke the Business Process to add an Academic Appointment. 
Add_Update_Company_Tax_ID END OF LIFE DEPRECATED: The functionality within this operation has been replaced with the "Put_Company_Tax_ID" operation. This operation adds (or updates) the Tax ID for a company. 
Add_Update_Organization This operation adds a new Organization (or updates an existing Organization) with the supplied information. 
Add_Workday_Account This operation adds a new Workday Account (e.g. User Name / Password) with the supplied information. 
Assign_Employee_Collective_Agreement_Event Creates or Updates Collective Agreement for a Worker. The Collective Agreement includes Applicable Factors and Factor options. 
Assign_Establishment Manually assign establishments to workers' positions 
Assign_Members_to_Custom_Organization Directly assign or unassign worker positions as members to a custom organization. The custom organization type must be configured in 'Maintain Organization Types' as 'Allow Reorganization Tasks (like Move Workers, Assign Workers)' = Y and 'Position Unique' = N. The Reorganization determines the effective date that a position is added as a member. In the UI, the equivalent task is executed via related action off the custom organization: Reorganization > Assign Workers > Select Workers by Individual. 
Change_Additional_Names Sets a worker's additional names. Does not use an event. 
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. 
Change_Emergency_Contacts This web service allows the updating of emergency contacts for a person. 
Change_Government_IDs This web service allows the updating of Government IDs for a worker. 
Change_Legal_Name Sets a worker's legal name. Uses the Legal Name Change business process. 
Change_Licenses This web service allows the updating of Licenses for a worker. 
Change_Other_IDs This web service allows the updating of Other IDs for a worker. 
Change_Passports_and_Visas This web service allows the updating of Passports and Visas for a worker. 
Change_Personal_Information Sets a worker's personal information. Uses the Personal Information Change business process. 
Change_Preferred_Name Sets a worker's preferred name. Uses the Preferred Name Change business process. 
Change_Veteran_Status_Identification Manually assign Veteran Status Identifications for an Employee. 
Create_Named_Professorship This operation will invoke the Business Process to create an Named Professorship. 
Dissolve_Organization_Structure This operation will dissolve an Organization structure (e.g. disconnect the subordinate and contained organizations). 
Edit_Named_Professorship Put Task for Edit named Professorship 
End_Academic_Appointment This operation will invoke the Business Process to end an Academic Appointment. 
End_Collective_Agreement_Assignment Ends the Collective Agreement Assignment for a ~Worker~ as of the effective data. 
Find_Business_Site DEPRECATED DEPRECATED: This web service operation is deprecated. Please use the Get Locations web service operation instead. This operation responds with a set of references to Business Sites that match the criteria specified in the request element. 
Find_Contingent_Worker DEPRECATED DEPRECATED: The functionality within this operation has been replaced with the "Get_Workers" operation. This operation responds with a set of references to Contingent Workers that match the criteria specified in the request element. 
Find_Employee DEPRECATED DEPRECATED: The functionality within this operation has been replaced with the "Get_Workers" operation. This operation responds with a set of references to Employees that match the criteria specified in the request element. 
Find_Job_Classification_Group DEPRECATED: The functionality within this operation has been replaced with the "Get_Job_Classifications" operation. This operation responds with a set of references to Job Classification Groups that match the criteria specified in the request element. 
Find_Job_Family_Group DEPRECATED: This deprecated operation responds with a set of references to Job Family Groups that match the criteria specified in the request element. It has been replaced by Get Job Family Groups. 
Find_Job_Profile DEPRECATED: This deprecated operation responds with a set of references to Job Profiles that match the criteria specified in the request element. It has been replaced by Get Job Profiles. 
Find_Organization This operation responds with a set of references to Organizations that match the criteria specified in the request element. 
Find_Worker DEPRECATED DEPRECATED: The functionality within this operation has been replaced with the "Get_Workers" operation. This operation responds with a set of references to Workers (e.g. Employees and Contingent Workers) that match the criteria specified in the request element. 
Get_Academic_Ranks Get Academic Rank Web Service 
Get_Academic_Unit_Hierarchies This operation is used to retrieve Academic Unit Hierarchies. 
Get_Academic_Units Returns detailed information for Academic Units. 
Get_Appointment_Specialties This operation retrieves Appointment Specialties. 
Get_Business_Site DEPRECATED DEPRECATED: This web service operation is deprecated. Please use the Get Locations web service operation instead. This operation retrieves data related to an Business Site. 
Get_Committee_Classification_Groups This operation retrieves Committee Classification Groups 
Get_Committee_Classifications This operation retrieves Committee Classifications 
Get_Committee_Definition This operation gets the current committee(s) definition 
Get_Committee_Membership_Types This operation retrieves Committee Member Types. 
Get_Committee_Types This operation retrieves Committee Types 
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. 
Get_Company_Tax_ID END OF LIFE DEPRECATED: The functionality within this operation has been replaced with the "Get_Company_Tax_IDs" operation. This operation retrieves the Tax ID for a company. 
Get_Company_Tax_IDs END OF LIFE DEPRECATED: This operation has been replaced by Get Workday Companies. This operation retrieves Tax ID information for one or more companies. 
Get_Contingent_Worker This operation retrieves data related to a Contingent Worker and his/her Contract and Personal information. 
Get_Contingent_Worker_Contract_Info This operation retrieves data related to a Contingent Worker and his/her Contract information. 
Get_Contingent_Worker_Personal_Info This operation retrieves data related to a Contingent Worker and his/her Personal (e.g. Biographic, Demographic, etc.) information. 
Get_Difficulty_to_Fill Gets the difficulty level of filling a job profile. 
Get_Disabilities This operation retrieves the disabilities that are currently defined. 
Get_Employee This operation retrieves data related to an Employee and his/her Employment, Personal and Compensation. 
Get_Employee_Employment_Info This operation retrieves data related to an Employee and his/her Employment (e.g. Position, Job, Status, etc.) information. 
Get_Employee_Image Get a photographic image of this employee. 
Get_Employee_Personal_Info This operation retrieves data related to an Employee and his/her Personal (e.g. Biographic, Demographic, etc.) information. 
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. 
Get_Establishments Get Establishments Data. 
Get_Ethnicities This operation retrieves data related to Ethnicities. 
Get_Former_Worker_Documents Returns former worker document data 
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. 
Get_Frequencies This operation retrieves data related to Frequencies. 
Get_Holiday_Calendars Returns Holiday Calendars based on criteria. 
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. 
Get_Job_Classification_Group DEPRECATED: This deprecated operation retrieves data related to a Job Classification Group. It has been replaced by Get Job Classification Groups. 
Get_Job_Classification_Groups Returns job classification group data. 
Get_Job_Families Returns job family data. 
Get_Job_Family_Group DEPRECATED: This deprecated operation retrieves data related to a Job Family Group. It has been replaced by Get Job Family Groups. 
Get_Job_Family_Groups Returns job family and job family group data. 
Get_Job_Profile DEPRECATED: This deprecated operation retrieves data related to a Job Profile. It has been replaced by Get Job Profiles. 
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. 
Get_LGBT_Identifications This operation retrieves the LGBT Identifications that are currently defined. 
Get_Location_Hierarchy_Organization_Assignments Returns Organization Assignments for Location Hierarchies. 
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. 
Get_Organization This operation retrieves data related to an Organization (e.g. Staffing Configuration, Structure, etc.). 
Get_Organization_Reference_IDs This task can be used to retrieve Organization Reference ID for an Organization. 
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. 
Get_Political_Affiliations This operation retrieves the political affiliations that are currently defined. 
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. 
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. 
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. 
Get_Search_Settings This operation will get information for search settings. 
Get_Server_Timestamp This operation retrieves Workday's current system datetime. 
Get_Service_Center_Representative_Workday_Accounts Get Service Center Representative Workday Accounts. 
Get_Service_Center_Representatives Get Service Center Representatives. 
Get_Social_Benefits_Localities This operation retrieves the social benefits localities that are currently defined. 
Get_Supervisory_Organization_Assignment_Restrictions This operation retrieves the Organization Assignment Default Values and Allowed Values for Supervisory Organizations. 
Get_Training_Types This operation retrieves Training Types defined in the system. 
Get_Work_Schedule_Calendars View Work Schedule Calendars. 
Get_Work_Shifts This operation retrieves data related to a Work Shift. 
Get_Workday_Account Get Workday Accounts for a user or set of users 
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. 
Get_Worker_Photos Gets a Photo Image of the Worker 
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. 
Get_Workers Returns information for specified workers. If the request does not specify a worker, then the operation returns information for all workers. 
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 Workers' Compensation Codes will be retrieved if no criteria is specified. Workers' Compensation Code data includes the code, name, business site, country, country region and inactive flag. 
Inactivate_Organization This operation will inactivate an Organization. If you do not choose to 'Keep in Hierarchy' then the organization being inactivated will be moved out of the hierarchy. Default behavior for inactive subordinates / included organizations is that they remain as is. Default behavior for active subordinates is that they are moved to the superior unless you specify another organization to move them to. If the organization has subordinates or included content that you do not want to move to its superior or another organization, you can use the DISSOLVE_ORGANIZATION_STRUCTURE web service to disconnect it from the hierarchy and remove its subordinates and included organizations. In this web service, the Integration_ID_Reference must be the external system id. 
Maintain_Committee_Definition This operation adds or updates a Committee Definition 
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. 
Manage_Committee_Membership This operation invokes the Manage Committee Membership business process. 
Manage_Employee_Probation_Periods_Event Creates or Updates Probation Periods for a Worker. 
Manage_Union_Membership Operation that will add a new worker to a union. Generates a Union Membership Event. 
Put_Academic_Rank This operation adds or updates Academic Ranks 
Put_Academic_Unit This operation adds or updates Academic Units 
Put_Academic_Unit_Hierarchy This operation is used to create an Academic Unit Hierarchy. 
Put_Addresses_for_Country_Format_Extension Use this operation ONLY for the country format extension and for local script addresses population. 1. 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. 2. Local Script Address Population Local script address components were added in W18 to allow address input in local script. This operation uploads addresses with new local address components. 
Put_Appointment_Specialty This operation adds or updates Appointment Specialty. 
Put_Committee_Classification This operation adds or updates Committee Classification 
Put_Committee_Classification_Group This operation adds or updates Committee Classification Groups 
Put_Committee_Membership_Type This operation adds or updates Committee Member Type. 
Put_Committee_Type This operation adds or updates Committee Types 
Put_Company_Insider_Type This operation adds or updates Company Insider Types. 
Put_Company_Tax_ID END OF LIFE DEPRECATED: This operation has been replaced by Get Workday Companies. This operation adds (or updates) the Tax ID for a company. 
Put_Dependent DEPRECATED DEPRECATED: Adds or updates a dependent 
Put_Difficulty_to_Fill This operation adds or updates a job profile's Difficulty to Fill. 
Put_Disability This operation adds or updates a Disability. 
Put_Establishment Loads Establishment Data. 
Put_Ethnicity This operation adds or updates an Ethnicity. 
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. 
Put_Former_Worker_Document Adds or updates a former worker document. The operation adds documents not associated with events and those documents are not secured by the events. 
Put_Frequency This operation adds or updates a Frequency. 
Put_Holiday_Calendar Adds or updates Holiday Calendar. 
Put_Job_Category This operation adds or updates a Job Category. 
Put_Job_Classification_Group Adds or updates a job classification group and/or job classifications. 
Put_Job_Family Adds or updates a job family. 
Put_Job_Family_Group Adds or updates a job family group. Also adds or removes a group's associated job families. 
Put_Job_Profile This operations adds or updates a Job Profile. 
Put_LGBT_Identification This operation adds or updates a LGBT Identification 
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. 
Put_Location_Hierarchy_Organization_Assignments This operation adds, updates, replaces the Organization Assignment Allowed Values for a Location Hierarchy 
Put_Organization_Reference_ID This task allows changing Organization Reference ID for an Organization. For Supervisory Organizations - if a valid sequence generator is defined, and the Organization Reference ID field is set to empty, then ID will be replaced with an automatically generated ID - if no sequence generator is defined, and the Organization Reference ID field is set to empty, then ID will be generated follow default pattern (SUPERVISORY_ORGANIZATION_XX_YY) - an option 'Include Organization ID in Name' can be set 
Put_Political_Affiliation This operation adds or updates a Political Affiliation. 
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. 
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. 
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. 
Put_Search_Settings This operation will put search configurations into workday. 
Put_Service_Center_Representative Adds or updates a Service Center Representative. 
Put_Service_Center_Representative_Workday_Account Adds or updates a Service Center Representative Workday Account. 
Put_Social_Benefits_Locality This operation adds or updates a Social Benefits Locality. 
Put_Supervisory_Organization_Assignment_Restrictions This operation updates the Organization Assignment Default Value and Allowed Values for a Supervisory Organization. Updates can be made by organization type. Note, the default value of Replace_All attribute is FALSE. This is different from most other webservices with this attribute because in this case, FALSE is more conservative. Default and allowed values for all organization types are inherited from the superior when no values have been specified for any organization types. Once a default or allowed value is specified for any organization type, the inheritance is severed. In the UI, inherited values are persisted when inheritance is severed. In order to mimic this behavior in the web service, inherited values will be persisted unless the 'Replace All' or 'Delete' options are set to TRUE. 
Put_Training_Type This operation adds or updates a Training Type 
Put_Work_Schedule_Calendar Adds or updates Work Schedule Calendar 
Put_Work_Shift This operation adds or updates a Work Shift. 
Put_Worker_Photo This operation adds or updates a workers photo. 
Put_Workers_Compensation_Code This operation adds or updates a Workers' Compensation Code. 
Reactivate_Organization This operation reactivates an organization based on the specified reference ID or WID. The organization must already be inactive or be inactive in the future. The system automatically sets the reactivation effective date to the same date as the date of the last inactivation so that there are no gaps when an active organization was inactive. This web service can currently be used to reactivate these organization types: Supervisory, Company, Cost Center, Region, Matrix, Pay Group, Retiree, Custom Org, Company Hierarchy, Cost Center Hierarchy, Location Hierarchy, Region Hierarchy. 
Reassign_Superior_to_Inactive_Organization Provides ability to assign the previous superior to an organization that is currently inactive, does not have a superior, and the latest event was 'Inactivate'. 
Update_Academic_Appointment This operation will invoke the Business Process to update an Academic Appointment. 
Update_Contingent_Worker_Personal_Info DEPRECATED This operation updates Personal (e.g. Biographic, Demographic, etc.) information related to a Contingent Worker. 
Update_Employee_Image This operation updates an image (e.g. picture) related to a employee. 
Update_Employee_Personal_Info DEPRECATED This operation updates Personal (e.g. Biographic, Demographic, etc.) information related to an Employee. 
Update_Workday_Account This operation updates an existing Workday Account (e.g. User Name / Password) with the supplied information.