Service Directory > v32.1 > Tenant_Data_Translation > Get_Translatable_Tenant_Data_Public
 

Operation: Get_Translatable_Tenant_Data_Public

Public Web Service Task to export translatable tenant data


@ - 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_Translatable_Tenant_Data_Public_Request

Finds and gets translatable objects and their associated data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Translatable_Tenant_Data_Public_Request_References  [0..*]  Finds and gets translatable objects and their associated data.   
Request_Criteria  Translatable_Tenant_Data_Public_Request_Criteria  [0..*]  Finds and gets translatable objects and their associated data.   
Response_Filter  Response_Filter  [0..1]  Finds and gets translatable objects and their associated data. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Translatable_Tenant_Data_Public_Response

Returns instances of translatable objects and their associated data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Translatable_Tenant_Data_Public_Request_Criteria  [0..1]  Specific criteria needed to search for translatable tenant data 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. 
 
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  Translatable_Tenant_Data_Public_Response_Data  [0..1]  Finds and gets translatable objects and their associated data.   
top
 

Translatable_Tenant_Data_Public_Request_References

part of: Get_Translatable_Tenant_Data_Public_Request
Specific references needed to search for translatable tenant data instances.
 
Parameter name Type/Value Cardinality Description Validations
Translatable_Class_Reference  Unique_IdentifierObject  [1..1]  Reference ID of the translatable object.   
top
 

Unique_IdentifierObject

part of: Translatable_Tenant_Data_Public_Request_References
 
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
 

Translatable_Tenant_Data_Public_Request_Criteria

part of: Get_Translatable_Tenant_Data_Public_Request, Get_Translatable_Tenant_Data_Public_Response
Specific criteria needed to search for translatable tenant data instances.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Translatable_Tenant_Data_Public_Request, Get_Translatable_Tenant_Data_Public_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_Translatable_Tenant_Data_Public_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
 

Translatable_Tenant_Data_Public_Response_Data

part of: Get_Translatable_Tenant_Data_Public_Response
Finds and gets translatable objects and their associated data.
 
Parameter name Type/Value Cardinality Description Validations
Translatable_Tenant_Data_Public  Translatable_User_Language_Public  [0..*]  Parameters that specify the context of the translatation tasks.   
top
 

Translatable_User_Language_Public

part of: Translatable_Tenant_Data_Public_Response_Data
Returns target User Language for translations.
 
Parameter name Type/Value Cardinality Description Validations
Translatable_Tenant_Data_Public_Data  Translatable_Class_Attribute_Data  [1..*]  Parameters that specify the context of the translatation tasks. 
Validation Description
Attribute is not translatable for specified Class.   
Invalid Attribute Reference.   
Invalid Class Name.   
Class is not translatable.   
 
top
 

Translatable_Class_Attribute_Data

part of: Translatable_User_Language_Public
Parameters that specify the context of the translatation tasks.
 
Parameter name Type/Value Cardinality Description Validations
User_Language_Reference  User_LanguageObject  [0..1]  Target User Language for translation.   
Class_Name  string  [1..1]  Name of the object.   
Attribute_Reference  Attribute_Reference  [1..1]  Attribute information of the object. 
Validation Description
Invalid Namespace URI.   
 
Translated_Value_for_Instance_Data  Translated_Value_for_Instance_Data  [0..*]  Translatable data in base language and target languages. 
Validation Description
Instance Reference is not valid. Only tenanted instances can be uploaded for translation.   
 
Validation Description
Attribute is not translatable for specified Class.   
Invalid Attribute Reference.   
Invalid Class Name.   
Class is not translatable.   
top
 

User_LanguageObject

part of: Translatable_Class_Attribute_Data
 
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
 

Attribute_Reference

part of: Translatable_Class_Attribute_Data
Attribute information of the object.
 
Parameter name Type/Value Cardinality Description Validations
Name  string  [1..1]  Attribute name of the object.   
Namespace_URI  string  [0..1]  Workday internal use only. Customers should not populate this column.   
Validation Description
Invalid Namespace URI.   
top
 

Translated_Value_for_Instance_Data

part of: Translatable_Class_Attribute_Data
Translatable data in base language and target languages.
 
Parameter name Type/Value Cardinality Description Validations
Instance_Reference  InstanceObject  [1..1]  A unique identifier for an instance of an object.   
Base_Value  string  [0..1]  Plain text base value.   
Translated_Value  string  [0..1]  Enter the translated value of the instance in the corresponding User Language and in plain text.   
Rich_Base_Value  RichText  [0..1]  Rich text base value.   
Translated_Rich_Value  RichText  [0..1]  Enter the translated value of the instance in the corresponding User Language and in rich text.   
Validation Description
Instance Reference is not valid. Only tenanted instances can be uploaded for translation.   
top
 

InstanceObject

part of: Translated_Value_for_Instance_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
 

RichText

part of: Translated_Value_for_Instance_Data, Translated_Value_for_Instance_Data
Base Type
string
top