Service Directory > v31.2 > Dynamic_Document_Generation > Get_Text_Blocks
 

Operation: Get_Text_Blocks

Returns text blocks.


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

Request Criteria for Get Text Blocks.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Text_Block_Request_References  [0..1]  The Text Block reference(s) to be retrieved.   
Request_Criteria [Choice]   Text_Block_Request_Criteria  [0..1]  Request Criteria for Get Text Blocks.   
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_Text_Blocks_Response

Response element for Get Text Blocks.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Text_Block_Request_References  [0..1]  The Text Block reference(s) to be retrieved.   
Request_Criteria  Text_Block_Request_Criteria  [0..1]  Request Criteria for Get Text Blocks.   
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  Text_Block_Response_Data  [0..1]  Text Block Response Data containing the retrieved Text Block information.   
top
 

Text_Block_Request_References

part of: Get_Text_Blocks_Request, Get_Text_Blocks_Response
The Text Block reference(s) to be retrieved.
 
Parameter name Type/Value Cardinality Description Validations
Text_Block_Reference  Text_BlockObject  [1..*]  The reference to the text block.   
top
 

Text_BlockObject

part of: Text_Block_Request_References, Text_Block
 
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_Request_Criteria

part of: Get_Text_Blocks_Request, Get_Text_Blocks_Response
Request Criteria for Get Text Blocks.
 
Parameter name Type/Value Cardinality Description Validations
Text_Block_Category_Reference  Text_Block_CategoryObject  [0..1]  The reference to the text block category.   
Text_Block_Name  string  [0..1]  The name of the text block.   
top
 

Text_Block_CategoryObject

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

Response_Filter

part of: Get_Text_Blocks_Request, Get_Text_Blocks_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_Text_Blocks_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
 

Text_Block_Response_Data

part of: Get_Text_Blocks_Response
Text Block Response Data containing the retrieved Text Block information.
 
Parameter name Type/Value Cardinality Description Validations
Text_Block  Text_Block  [0..*]  The text block information retrieved as a result of the request.   
top
 

Text_Block

part of: Text_Block_Response_Data
The text block information retrieved as a result of the request.
 
Parameter name Type/Value Cardinality Description Validations
Text_Block_Reference  Text_BlockObject  [0..1]  The reference to the text block.   
Text_Block_Data  Text_Block_Data  [0..*]  The text block data.   
top
 

Text_Block_Data

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

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, Custom_Field_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
 

Text_Block_CategoryReferenceEnumeration

part of: Text_Block_CategoryObjectID
Base Type
string
top
 

Template_TypeReferenceEnumeration

part of: Template_TypeObjectID
Base Type
string
top
 

RichText

part of: Text_Block_Data
Base Type
string
top
 

External_FieldReferenceEnumeration

part of: External_FieldObjectID
Base Type
string
top