Service Directory > v32.1 > Dynamic_Document_Generation > Put_Text_Block
 

Operation: Put_Text_Block

Adds or updates a text block.


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

Request element for Put Text Block
 
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_Reference  Text_BlockObject  [0..1]  The reference to the text block.   
Text_Block_Data  Text_Block_Data  [1..1]  Wrapper element for the details of a text block.   
Validation Description
The Web Service is set to Add Only; but the Text Block already exists.   
top
 

Response Element: Put_Text_Block_Response

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

Text_BlockObject

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

Text_BlockObjectID

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

part of: Put_Text_Block_Request
The text block data.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  The ID for the text block.   
Text_Block_Name  string  [1..1]  The name of the text block. 
Validation Description
The text block name "[name]" is currently in use within Source "[source]".   
 
Source_Reference  Template_TypeObject  [1..1]  The reference to the source of the text block. 
Validation Description
The source "[source]" is not valid.   
The Source cannot be changed as the text block is already in use.   
 
Text_Block_Category_Reference  Text_Block_CategoryObject  [0..1]  The reference to the text block category.   
Inactive  boolean  [0..1]  Indicates if the text block data is inactive.   
Do_Not_Allow_Editing  boolean  [0..1]  Indicates if the text block is non-editable.   
Text_Block_Content  RichText  [1..1]  The rich text dynamic text block content. 
Validation Description
External Field(s) within Text Block content are invalid. Please remove them before saving: [fields]   
 
External_Field_Reference  External_FieldObject  [0..*]  External Fields referenced in the Text Block Content   
top
 

Template_TypeObject

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

Template_TypeObjectID

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

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

External_FieldObject

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

External_FieldObjectID

part of: External_FieldObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Calculated_Field_ID, Computed_Data_Source_Field_ID, Custom_Field_Data_Set_ID, Extension_Computed_Data_Field_Reference_ID, External_Analytics_Data_Source_Field_ID, WCP_Component_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_BlockReferenceEnumeration

part of: Text_BlockObjectID
Base Type
string
top
 

Template_TypeReferenceEnumeration

part of: Template_TypeObjectID
Base Type
string
top
 

Text_Block_CategoryReferenceEnumeration

part of: Text_Block_CategoryObjectID
Base Type
string
top
 

RichText

part of: Text_Block_Data
Base Type
string
top
 

External_FieldReferenceEnumeration

part of: External_FieldObjectID
Base Type
string
top