Service Directory > v31.2 > Talent > Get_Talent_Pools
 

Operation: Get_Talent_Pools

This web service allows retrieval of Talent Pools and memberships information.


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

Web Service wrapper to request Talent Pool and Worker Membership retrieval.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Talent_Pool_Request_References  [0..1]  Holds references to Talent Pool   
Request_Criteria [Choice]   Talent_Pool_Request_Criteria  [0..1]  Optional. Section holds Criteria for Talent Pool Request.   
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_Pool_Response_Group  [0..1]  Section holds response behavior.   
top
 

Response Element: Get_Talent_Pools_Response

Web Service wrapper to Talent Pool and Worker Membership retrieval response.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Talent_Pool_Request_References  [0..1]  Holds references to Talent Pool   
Request_Criteria  Talent_Pool_Request_Criteria  [0..1]  Optional. Section holds Criteria for Talent Pool Request.   
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_Pool_Response_Group  [0..1]  Section holds response behavior.   
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_Pool_Response_Data  [0..1]  Section holds web service total/page results, Talent Pools and Worker membership information.   
top
 

Talent_Pool_Request_References

part of: Get_Talent_Pools_Request, Get_Talent_Pools_Response
Holds references to Talent Pool
 
Parameter name Type/Value Cardinality Description Validations
Static_Talent_Pool_Reference  Talent_Management_PoolObject  [1..*]  Optional. This section holds references to talent pool . Use WID or Talent_Pool_ID as reference to specific talent pool.   
top
 

Talent_Management_PoolObject

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

Talent_Management_PoolObjectID

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

part of: Get_Talent_Pools_Request, Get_Talent_Pools_Response
Optional. Section holds Criteria for Talent Pool Request.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Talent_Pools_Request, Get_Talent_Pools_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_Pool_Response_Group

part of: Get_Talent_Pools_Request, Get_Talent_Pools_Response
Section holds response behavior.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Optional. Boolean flag to include Reference in response.   
Include_Talent_Pool_Data  boolean  [0..1]  Optional. Boolean flag to include Talent Pool Data in response.   
Include_Shareable_Data  boolean  [0..1]  Optional. Boolean flag to include Shareable Data in response.   
top
 

Response_Results

part of: Get_Talent_Pools_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_Pool_Response_Data

part of: Get_Talent_Pools_Response
Section holds web service total/page results, Talent Pools and Worker membership information.
 
Parameter name Type/Value Cardinality Description Validations
Talent_Pool  Talent_Pool  [0..*]  Section holds web service response containing Talent Pools and Worker membership information.   
top
 

Talent_Pool

part of: Talent_Pool_Response_Data
Holds response section for Talent Pool and Worker Reference
 
Parameter name Type/Value Cardinality Description Validations
Static_Talent_Pool_Reference  Talent_Management_PoolObject  [0..1]  Holds Talent Pool (WID and Talent_Pool_ID) information.   
Talent_Pool_Data  Talent_Pool_Data  [0..1]  Holds Talent Pool and Worker Reference information   
top
 

Talent_Pool_Data

part of: Talent_Pool
This Element contains Talent Pool ID, Name, Inactive (boolean), and worker membership to this talent pool
 
Parameter name Type/Value Cardinality Description Validations
@Replace_All  boolean  [1..1]  Setting this value to true will remove Static Talent Pool memberships (worker) prior to adding membership as listed in service request. If set to false, it will keep existing worker membership and then process membership as listed in service request. Default is False.   
ID  string  [0..1]  Holds Reference_ID of Talent Pool   
Name  string  [1..1]  Holds Talent Pool Name attribute value   
Description  string  [0..1]  Holds Talent Pool Description attribute value   
Inactive  boolean  [0..1]  Holds Talent Pool Inactivate boolean value   
Restricted_View  boolean  [0..1]  Restricted Pool is used to specify whether the talent pool is restricted or not.   
Exclude_from_Termination  boolean  [0..1]  This Boolean value is used to specify if the succession/talent pool will be excluded from processing during the Remove Worker from Talent business process   
Talent_Pool_Member  Static_Talent_Pool_Member  [0..*]  Holds element which contain Talent Pool Worker membership.   
top
 

Static_Talent_Pool_Member

part of: Talent_Pool_Data
Holds element which contain Talent Pool Worker membership.
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  Setting value to true will remove this worker membership from Static Talent Pool. If set to false, worker membership remains to the talent pool. Default is FALSE.   
Worker_Reference [Choice]   WorkerObject  [1..1]  Holds Worker reference which is used to add membership to Static Talent Pool.   
top
 

WorkerObject

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

WorkerObjectID

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

part of: Talent_Management_PoolObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top