Service Directory > v31.2 > Workday_Connect > Get_Message_Template
 

Operation: Get_Message_Template

Returns information for message templates specified in the request.


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

Wrapper element around a list of elements representing the Customer specific criteria needed to search for instances (all of the elements are "AND" conditions). These are attributes and/or references that provide an alternate way to find instances or data outside of the Workday IDs and Lookup IDs contained within the "Request_References" element.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Message_Template_Request_References  [0..1]  Wrapper element containing references to specific notification contents.   
Request_Criteria [Choice]   Message_Template_Request_Criteria  [0..1]  Wrapper element around a list of elements representing the Customer specific criteria needed to search for instances (all of the elements are "AND" conditions). These are attributes and/or references that provide an alternate way to find instances or data outside of the Workday IDs and Lookup IDs contained within the "Request_References" element.   
Response_Filter  Response_Filter  [0..1]  The "Response_Filter" element contains common WWS information that allows you control the response data that you will be provided including As_Of_Date, As_Of_Entry_Moment, and Page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Message_Template_Response_Group  [0..1]  The response group allows for the response data to be tailored to only included elements that the user is looking for. If no response group is provided in the request, then all groups will be returned.   
top
 

Response Element: Get_Message_Template_Response

Wrapper element containing Message Template Response Data for requested references or criteria and for requested response group.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Message_Template_Request_References  [0..1]  Contains message template references.   
Request_Criteria  Message_Template_Request_Criteria  [0..1]  Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Message_Template_Response_Group  [0..1]  Response Group   
Response_Results  Response_Results  [0..1]  Response Results   
Response_Data  Message_Template_Response_Data  [0..1]  Response Data   
top
 

Message_Template_Request_References

part of: Get_Message_Template_Request, Get_Message_Template_Response
Contains message template references.
 
Parameter name Type/Value Cardinality Description Validations
Message_Template_Reference  Message_TemplateObject  [1..*]  Message Template Request References   
top
 

Message_TemplateObject

part of: Message_Template_Request_References, Message_Template
 
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  Message_TemplateObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Message_TemplateObjectID

part of: Message_TemplateObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Message_Template_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
 

Message_Template_Request_Criteria

part of: Get_Message_Template_Request, Get_Message_Template_Response
Utilize the following criteria options to search for Message Template within the Workday system. The Message Template 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.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Message_Template_Request, Get_Message_Template_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
 

Message_Template_Response_Group

part of: Get_Message_Template_Request, Get_Message_Template_Response
Element containing Notification Content response grouping options
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Response Group   
top
 

Response_Results

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

Message_Template_Response_Data

part of: Get_Message_Template_Response
Wrapper element containing Message Template Response Data for requested references or criteria and for requested response group.
 
Parameter name Type/Value Cardinality Description Validations
Message_Template  Message_Template  [0..*]  Data for a Message Template.   
top
 

Message_Template

part of: Message_Template_Response_Data
Wrapper element containing Message Template Response Data for requested references or criteria and for requested response group.
 
Parameter name Type/Value Cardinality Description Validations
Message_Template_Reference  Message_TemplateObject  [0..1]  Reference to a Message Template.   
Message_Template_Data  Message_Template_Data  [0..*]  Data for a Message Template. 
Validation Description
External Field(s) are invalid. Please remove them before saving: [fields]   
 
top
 

Message_Template_Data

part of: Message_Template
Contains Notification Content data.
 
Parameter name Type/Value Cardinality Description Validations
Message_Template_ID  string  [0..1]  Unique identifier for the message template. If not entered, one will be generated.   
Message_Template_Name  string  [0..1]  Name for Message Template. 
Validation Description
A Message Template with the same name already exists. Please enter a new Message Template name.   
 
Notification_Type_Reference  Notification_CategoryObject  [0..1]  Notification Type for Message Template.   
Email_Notification_Configuration_Replacement_Data  Email_Notification_Configuration_Replacement_Data  [0..*]  Wrapper element for Email Message Template data.   
Push_Notification_Configuration_Replacement_Data  Push_Notification_Configuration_Replacement_Data  [0..*]  Wrapper element for Push Message Template data.   
Validation Description
External Field(s) are invalid. Please remove them before saving: [fields]   
top
 

Notification_CategoryObject

part of: Message_Template_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  Notification_CategoryObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Notification_CategoryObjectID

part of: Notification_CategoryObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, NOTIFICATION_CATEGORY  [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
 

Email_Notification_Configuration_Replacement_Data

part of: Message_Template_Data
Contains Email Notification data.
 
Parameter name Type/Value Cardinality Description Validations
Email_Subject_Reference  RichText  [1..1]  Subject for Email Notification.   
Email_From_Display_Name_Reference  string  [0..1]  Display Name for Email Notification.   
Email_Reply_To_Reference  string  [0..1]  Reply To for Email Notification.   
Email_Body_Reference  RichText  [1..1]  Body for Email Notification.   
top
 

Push_Notification_Configuration_Replacement_Data

part of: Message_Template_Data
Contains Push Notification data.
 
Parameter name Type/Value Cardinality Description Validations
Push_Message_Reference  RichText  [1..1]  Message for push notification.   
top
 

Message_TemplateReferenceEnumeration

part of: Message_TemplateObjectID
Base Type
string
top
 

Notification_CategoryReferenceEnumeration

part of: Notification_CategoryObjectID
Base Type
string
top
 

RichText

part of: Email_Notification_Configuration_Replacement_Data, Email_Notification_Configuration_Replacement_Data, Push_Notification_Configuration_Replacement_Data
Base Type
string
top