Service Directory > v23.0 > Campus_Engagement > Get_Engagement_Conversation_Tags
 

Operation: Get_Engagement_Conversation_Tags

Retrieves the tags used to categorize Engagement Conversations.


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

Web Service Element for a Get Engagement Conversation Tag Request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Engagement_Conversation_Tag_Request_References  [0..1]  Web Service Element Containing Reference IDs of Engagement Conversation Tags for Request   
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_Engagement_Conversation_Tags_Response

Web Service Element containing a Get Engagement Conversation Tags request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Engagement_Conversation_Tag_Request_References  [0..1]  Web Service Element Containing Reference IDs of Engagement Conversation Tags for Request   
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  Engagement_Conversation_Tag_Response_Data  [0..1]  Web Service Element containing reference IDs for requested Engagement Conversation Tags   
top
 

Engagement_Conversation_Tag_Request_References

part of: Get_Engagement_Conversation_Tags_Request, Get_Engagement_Conversation_Tags_Response
Web Service Element Containing Reference IDs of Engagement Conversation Tags for Request
 
Parameter name Type/Value Cardinality Description Validations
Engagement_Conversation_Tag_Reference  Engagement_Conversation_TagObject  [1..*]  Web Service Element Containing the Reference ID for Engagement Conversation Tag   
top
 

Engagement_Conversation_TagObject

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

Engagement_Conversation_TagObjectID

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

Engagement_Conversation_Tag_Response_Data

part of: Get_Engagement_Conversation_Tags_Response
Web Service Element containing reference IDs for requested Engagement Conversation Tags
 
Parameter name Type/Value Cardinality Description Validations
Engagement_Conversation_Tag  Engagement_Conversation_Tag  [0..*]  Web Service Element Containing the Reference ID for Engagement Conversation Tag   
top
 

Engagement_Conversation_Tag

part of: Engagement_Conversation_Tag_Response_Data
Web Service Element Containing the Reference ID for Engagement Conversation Tag
 
Parameter name Type/Value Cardinality Description Validations
Engagement_Conversation_Tag_Reference  Engagement_Conversation_TagObject  [0..1]  Reference ID of a Engagement Conversation Tag   
Engagement_Conversation_Tag_Data  Engagement_Conversation_Tag_Data  [0..*]  Web Service Element for Engagement Conversation Tag data   
top
 

Engagement_Conversation_Tag_Data

part of: Engagement_Conversation_Tag
Web Service Element for Engagement Conversation Tag data
 
Parameter name Type/Value Cardinality Description Validations
Engagement_Conversation_Tag_Name  string  [1..1]  Unique Name for Engagement Conversation Tag 
Validation Description
Enter a Tag Name that isn't already in use.   
 
Engagement_Conversation_Tag_Category_Reference  Engagement_Conversation_Tag_CategoryObject  [0..*]  Category for Engagement Conversation Tag   
top
 

Engagement_Conversation_Tag_CategoryObject

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

Engagement_Conversation_Tag_CategoryObjectID

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

Engagement_Conversation_TagReferenceEnumeration

part of: Engagement_Conversation_TagObjectID
Base Type
string
top
 

Engagement_Conversation_Tag_CategoryReferenceEnumeration

part of: Engagement_Conversation_Tag_CategoryObjectID
Base Type
string
top