Service Directory > v25.1 > Campus_Engagement > Put_Engagement_Conversation_Tag
 

Operation: Put_Engagement_Conversation_Tag

Adds or updates an Engagement Conversation Tag, which is an identifier used to group Engagement Conversations using the information provided 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: Put_Engagement_Conversation_Tag_Request

Web Service Request Element for Add/Edit an Engagement Conversation Tag
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Indicates that this request may only be used to add a new tag, not modify an existing one.   
Engagement_Conversation_Tag_Reference  Engagement_Conversation_TagObject  [0..1]  Element containing the Reference ID of the tag to modify (not present when adding a new tag)   
Engagement_Conversation_Tag_Data  Engagement_Conversation_Tag_Data  [1..1]  Web Service Element for Engagement Conversation Tag data   
Validation Description
The Web Service is set to Add Only, but the Engagement Conversation Tag already exists.   
top
 

Response Element: Put_Engagement_Conversation_Tag_Response

Web Service Element containing the Reference ID of the New/Modified Engagement Conversation Tag
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Engagement_Conversation_Tag_Reference  Engagement_Conversation_TagObject  [0..1]  Reference ID of the New/Modified Engagement Conversation Tag   
top
 

Engagement_Conversation_TagObject

part of: Put_Engagement_Conversation_Tag_Request, Put_Engagement_Conversation_Tag_Response
 
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
 

Engagement_Conversation_Tag_Data

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