Service Directory > v31.2 > Dynamic_Document_Generation > Put_Text_Block_Category
 

Operation: Put_Text_Block_Category

Adds or updates a text block category.


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

Request element for Put Text Block Category
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update.   
Text_Block_Category_Reference  Text_Block_CategoryObject  [0..1]  The reference to the text block category.   
Text_Block_Category_Data  Text_Block_Category_Data  [1..1]  Wrapper element for the details of a text block category.   
Validation Description
The Web Service is set to Add Only; but the Text Block Category already exists.   
top
 

Response Element: Put_Text_Block_Category_Response

Response element for Put Text Bock Category.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Text_Block_Category_Reference  Text_Block_CategoryObject  [0..1]  The reference to the text block category.   
top
 

Text_Block_CategoryObject

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

Text_Block_CategoryObjectID

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

Text_Block_Category_Data

part of: Put_Text_Block_Category_Request
The text block category data.
 
Parameter name Type/Value Cardinality Description Validations
Text_Block_Category_ID  string  [0..1]  The ID for the text block category.   
Text_Block_Category_Name  string  [1..1]  The name of the text block category. 
Validation Description
Enter a unique Text Block Category Name. The name [name] is already in use.   
 
top
 

Text_Block_CategoryReferenceEnumeration

part of: Text_Block_CategoryObjectID
Base Type
string
top