Service Directory > v32.1 > Talent > Get_Talent_Statement_Types
 

Operation: Get_Talent_Statement_Types

Web Service task to export all Talent Statement Types from the tenant.


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

This element is the top level request element for the "Get Talent Statement Type" operation.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Talent_Statement_Type_Request_References  [0..1]  Container for Talent Statement Type Request References.   
Request_Criteria [Choice]   Talent_Statement_Type_Request_Criteria  [0..1]  Container for Talent Statement Type Request Criteria.   
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_Group  Talent_Statement_Type_Response_Group  [0..1]  Container for Talent Statement Type Response Group.   
top
 

Response Element: Get_Talent_Statement_Types_Response

Wrapper element containing each Talent Statement Type's response Data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Talent_Statement_Type_Request_References  [0..1]  Container for Talent Statement Type Request References.   
Request_Criteria  Talent_Statement_Type_Request_Criteria  [0..1]  Container for Talent Statement Type Request Criteria.   
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_Group  Talent_Statement_Type_Response_Group  [0..1]  Container for Talent Statement Type Response Group.   
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  Talent_Statement_Type_Response_Data  [0..1]  Wrapper element containing each Talent Statement Type's response Data.   
top
 

Talent_Statement_Type_Request_References

part of: Get_Talent_Statement_Types_Request, Get_Talent_Statement_Types_Response
Container for Talent Statement Type Request References.
 
Parameter name Type/Value Cardinality Description Validations
Talent_Statement_Type_Reference  Talent_Statement_TypeObject  [1..*]  One or more Talent Statement Type Request Reference ID.   
top
 

Talent_Statement_TypeObject

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

Talent_Statement_TypeObjectID

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

Talent_Statement_Type_Request_Criteria

part of: Get_Talent_Statement_Types_Request, Get_Talent_Statement_Types_Response
Container for Talent Statement Type Request Criteria.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

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

Talent_Statement_Type_Response_Group

part of: Get_Talent_Statement_Types_Request, Get_Talent_Statement_Types_Response
Container for Talent Statement Type Response Group.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Boolean to indicate if need to include reference of Talent Statement Type.   
top
 

Response_Results

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

Talent_Statement_Type_Response_Data

part of: Get_Talent_Statement_Types_Response
Wrapper element containing each Talent Statement Type's response Data.
 
Parameter name Type/Value Cardinality Description Validations
Talent_Statement_Type  Talent_Statement_Type  [0..*]  Wrapper element containing Talent Statement Type and its data.   
top
 

Talent_Statement_Type

part of: Talent_Statement_Type_Response_Data
Wrapper element containing Talent Statement Type and its data.
 
Parameter name Type/Value Cardinality Description Validations
Talent_Statement_Type_Reference  Talent_Statement_TypeObject  [0..1]  A reference to the Talent Statement Type being created, edited, or deleted.   
Talent_Statement_Type_Data  Talent_Statement_Type_Data  [0..*]  Data element for the current Talent Statement Type 
Validation Description
You can't inactivate a talent statement type displayed on the professional profile.   
Talent System Type Name field must be unique.   
You can't edit the Name of a Talent System Type that is in use.   
Talent Statement Type Name field is required.   
You can't delete a Talent Statement Type that is in use.   
 
top
 

Talent_Statement_Type_Data

part of: Talent_Statement_Type
Data element for the current Talent Statement Type
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  A unique identifier for the Talent Statement Type.   
Name  string  [0..1]  The name of the Talent Statement Type.   
Description  string  [0..1]  A description of the Talent Statement Type.   
Display_on_Professional_Profile  boolean  [0..1]  Whether or not the Talent Statement Type should be displayed on the professional profile.   
Inactive  boolean  [0..1]  Whether or not the Talent Statement Type is currently active.   
In_Use  boolean  [0..1]  Whether or not the Talent Statement Type is currently being used.   
Validation Description
You can't inactivate a talent statement type displayed on the professional profile.   
Talent System Type Name field must be unique.   
You can't edit the Name of a Talent System Type that is in use.   
Talent Statement Type Name field is required.   
You can't delete a Talent Statement Type that is in use.   
top
 

Talent_Statement_TypeReferenceEnumeration

part of: Talent_Statement_TypeObjectID
Base Type
string
top