Service Directory > v32.1 > Tenant_Data_Translation > Get_Base_Language_Change
 

Operation: Get_Base_Language_Change

Retrieve instances where you want to change the base language.


@ - A parameter name with this symbol denotes an XML attribute within the document instead of an XML element.


Contents

 

Web Service

 

Request

 

Response

 

Element(s)

 

Request Element: Get_Base_Language_Change_Request

This request will retrieve all translatable instances of the given business object. Optionally, if supplied, all instances will be filtered by the base language reference.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Base_Language_Change_References  [0..*]  Element containing a reference to a specify Translatable Business Object 
Validation Description
Class is not translatable.   
 
Request_Criteria  Base_Language_Change_Criteria  [0..*]  Element containing criteria to filter particular Translatable Instances   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Base_Language_Change_Response

Set of translatable instances, their current state, and their proposed changes.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Base_Language_Change_References  [0..1]  A translatable business object, the instances of which are to have their base language changed 
Validation Description
Class is not translatable.   
 
Request_Criteria  Base_Language_Change_Criteria  [0..1]  Additional criteria to limit the instances whose base language can be changed   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.   
Response_Data  Base_Language_Change_Response_Data  [0..1]  Response Data   
top
 

Base_Language_Change_References

part of: Get_Base_Language_Change_Request, Get_Base_Language_Change_Response
Get Change Base Language References
 
Parameter name Type/Value Cardinality Description Validations
Translatable_Business_Object_Reference  Unique_IdentifierObject  [1..1]  A translatable business object, the instances of which are to have their base language changed   
Validation Description
Class is not translatable.   
top
 

Unique_IdentifierObject

part of: Base_Language_Change_References, Base_Language_Change
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Unique_IdentifierObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Unique_IdentifierObjectID

part of: Unique_IdentifierObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  IID, WID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Base_Language_Change_Criteria

part of: Get_Base_Language_Change_Request, Get_Base_Language_Change_Response
Get Change Base Language Criteria
 
Parameter name Type/Value Cardinality Description Validations
Current_Base_Language_Reference  User_LanguageObject  [0..1]  Optionally, if this reference is non-empty, only instances of this base language will be included in the request.   
top
 

User_LanguageObject

part of: Base_Language_Change_Data, Base_Language_Change_Data, Base_Language_Change_Criteria, Base_Language_Change
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  User_LanguageObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

User_LanguageObjectID

part of: User_LanguageObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, User_Language_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Response_Filter

part of: Get_Base_Language_Change_Request, Get_Base_Language_Change_Response
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Response_Results

part of: Get_Base_Language_Change_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Base_Language_Change_Response_Data

part of: Get_Base_Language_Change_Response
Response Data
 
Parameter name Type/Value Cardinality Description Validations
Base_Language_Change  Base_Language_Change  [0..*]  Contains all instances of a Translatable Business Object based on the Request Reference and Request Criteria   
top
 

Base_Language_Change

part of: Base_Language_Change_Response_Data
Contains Business Object and its Base Language Change Set
 
Parameter name Type/Value Cardinality Description Validations
Translatable_Business_Object_Reference  Unique_IdentifierObject  [0..1]  A translatable business object, the instances of which are to have their base language changed   
User_Language_Reference  User_LanguageObject  [0..1]  The base language reference submitted in Request Criteria, if any   
Base_Language_Change_Data  Base_Language_Change_Data  [0..*]  A translatable instance showing current and proposed base language 
Validation Description
You are missing one or more translated values for your proposed base language. Fully translate the object into the proposed base language or enable Copy Current Base Value to Proposed Base Value.  You are missing one or more translated values for your proposed base language. Fully translate the object into the proposed base language or enable Copy Current Base Value to Proposed Base Value. 
 
top
 

Base_Language_Change_Data

part of: Base_Language_Change
A translatable instance, its current state, and the proposed changes.
 
Parameter name Type/Value Cardinality Description Validations
Translatable_Instance_Reference  InstanceObject  [1..1]  The translatable instance to change the Base Language of.   
Current_Base_Language_Reference  User_LanguageObject  [0..1]  The current base language.   
Proposed_Base_Language_Reference  User_LanguageObject  [0..1]  The proposed base language.   
Copy_Current_Base_Values_to_Proposed_Base_Values  boolean  [0..1]  If true, the instance's values for the current base language will be copied for any missing proposed base language values. If false, existing values under the proposed base language will not be changed.   
Validation Description
You are missing one or more translated values for your proposed base language. Fully translate the object into the proposed base language or enable Copy Current Base Value to Proposed Base Value.  You are missing one or more translated values for your proposed base language. Fully translate the object into the proposed base language or enable Copy Current Base Value to Proposed Base Value. 
top
 

InstanceObject

part of: Base_Language_Change_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]     
ID  Instance_ID  [0..*]     
top
 

Instance_ID

part of: InstanceObject
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@parent_id  string  [1..1]     
@parent_type  string  [1..1]     
@type  string  [1..1]     
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

User_LanguageReferenceEnumeration

part of: User_LanguageObjectID
Base Type
string
top