Service Directory > v32.1 > Talent > Get_Succession_Pools
 

Operation: Get_Succession_Pools

Enable Succession Pool and its membership retrieval via SOAP Web Service request.


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

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
@version string [0..1] Web Service version  
Request_References [Choice]   Succession_Pool_Request_References  [0..1]  Web Service wrapper to request Succession Pool and Membership retrieval.   
Request_Criteria [Choice]   Succession_Pool_Request_Criteria  [0..1]  Hold criteria for Succession 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  Succession_Pool_Response_Group  [0..1]  Section holds response behavior.   
top
 

Response Element: Get_Succession_Pools_Response

Holds response to requested Succession Pool.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Succession_Pool_Request_References  [0..1]  Web Service wrapper to request Succession Pool and Membership retrieval.   
Request_Criteria  Succession_Pool_Request_Criteria  [0..1]  Hold criteria for Succession 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  Succession_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  Succession_Pool_Response_Data  [0..1]  Web Service wrapper to Succession Pool and Membership retrieval response.   
top
 

Succession_Pool_Request_References

part of: Get_Succession_Pools_Request, Get_Succession_Pools_Response
Web Service wrapper to request Succession Pool and Membership retrieval.
 
Parameter name Type/Value Cardinality Description Validations
Succession_Pool_Reference  Succession_PoolObject  [1..*]  Holds references to Succession Pool . Use WID or Succession_Pool_ID as reference to Succession Pool.   
top
 

Succession_PoolObject

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

Succession_PoolObjectID

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

Succession_Pool_Request_Criteria

part of: Get_Succession_Pools_Request, Get_Succession_Pools_Response
Hold criteria for Succession Pool Request.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

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

Succession_Pool_Response_Group

part of: Get_Succession_Pools_Request, Get_Succession_Pools_Response
Section holds response behavior.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Boolean flag to include Reference in response.   
top
 

Response_Results

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

Succession_Pool_Response_Data

part of: Get_Succession_Pools_Response
Web Service wrapper to Succession Pool and Membership retrieval response.
 
Parameter name Type/Value Cardinality Description Validations
Succession_Pool  Succession_Pool  [0..*]  Holds Succession Pool section of response.   
top
 

Succession_Pool

part of: Succession_Pool_Response_Data
Contain response to describe Succession Pool definition and its membership.
 
Parameter name Type/Value Cardinality Description Validations
Succession_Pool_Reference  Succession_PoolObject  [0..1]  Holds references to Succession Pool (WID or Succession_Pool_ID as reference to Succession Pool)   
Succession_Pool_Data  Succession_Pool_Data  [0..*]  Hold detail information to describe succession pool and contains memberships node.   
top
 

Succession_Pool_Data

part of: Succession_Pool
Encapsulating Element for managing a Succession Plan.
 
Parameter name Type/Value Cardinality Description Validations
@Replace_All  boolean  [1..1]  Setting this value to true will remove Succession Pool memberships prior to adding member(s)   
ID  string  [0..1]  Holds Reference_ID of Job Profile Succession Plan.   
Name  string  [1..1]  Holds Succession Plan Name attribute value.   
Description  string  [0..1]  Holds Succession Plan Description attribute value.   
Inactive  boolean  [0..1]  Holds Succession Plan Inactivate boolean value.   
Restricted_View  boolean  [0..1]  Restricted Succession pool holds a boolean value. This Boolean value is used to specify if the succession plan 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   
Job_Profile_Reference  Job_ProfileObject  [1..*]  Holds Job Profile reference for this succession plan.   
Succession_Pool_Candidate  Succession_Pool_Candidate  [0..*]  Holds Reference to Succession Pool Candidate instance. 
Validation Description
Adding External Candidates to Succession Pool is not allowed.   
 
top
 

Job_ProfileObject

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

Job_ProfileObjectID

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

Succession_Pool_Candidate

part of: Succession_Pool_Data
Holds Element to contain information for Succession Pool Membership
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  Setting value to true will remove this worker membership from Succession Pool. If set to false, worker membership remains to the succession pool. Default is FALSE.   
Succession_Pool_Candidate_Reference  Succession_Pool_CandidateObject  [0..*]  Reference to Workday ID of Succession Pool Candidate   
Succession_Pool_Candidate_Data  Succession_Pool_Candidate_Data  [0..1]  Element to contain attribute information for Succession Pool Candidate   
Validation Description
Adding External Candidates to Succession Pool is not allowed.   
top
 

Succession_Pool_CandidateObject

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

Succession_Pool_CandidateObjectID

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

Succession_Pool_Candidate_Data

part of: Succession_Pool_Candidate
Encapsulating element containing candidate data for a Succession Plan.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Holds Reference_ID of Succession Pool Candidate.   
Top_Candidate  boolean  [0..1]  Indicates whether the worker is the top candidate for this succession plan.   
XMLNAME__Worker__Reference [Choice]   WorkerObject  [0..1]  Holds Worker reference data for this succession plan.   
Candidate_Reference [Choice]   CandidateObject  [0..1]  Holds Candidate reference which is used to add membership to Succession Pool.   
Succession_Readiness_Reference  Succession_ReadinessObject  [0..1]  The readiness of the candidate to fill this job.   
Succession_Pool_Candidate_Notes  Succession_Pool_Candidate_Note_Data  [0..*]  Holds reference to Note instance to Succession Pool Candidate.   
top
 

WorkerObject

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

CandidateObject

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

CandidateObjectID

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

Succession_ReadinessObject

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

Succession_ReadinessObjectID

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

Succession_Pool_Candidate_Note_Data

part of: Succession_Pool_Candidate_Data
Encapsulating element containing candidate note data for a Succession Plan.
 
Parameter name Type/Value Cardinality Description Validations
Succession_Pool_Candidate_Notes  RichText  [0..1]  Notes on this candidate.   
Added_By__Worker__Reference  WorkerObject  [0..1]  Notes added by worker.   
top
 

Succession_PoolReferenceEnumeration

part of: Succession_PoolObjectID
Base Type
string
top
 

Job_ProfileReferenceEnumeration

part of: Job_ProfileObjectID
Base Type
string
top
 

Succession_Pool_CandidateReferenceEnumeration

part of: Succession_Pool_CandidateObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

CandidateReferenceEnumeration

part of: CandidateObjectID
Base Type
string
top
 

Succession_ReadinessReferenceEnumeration

part of: Succession_ReadinessObjectID
Base Type
string
top
 

RichText

part of: Succession_Pool_Candidate_Note_Data
Base Type
string
top