Service Directory > v31.2 > Talent > Manage_Succession_Pool
 

Operation: Manage_Succession_Pool

Web service for Managing a Succession Plan for a job profile.


@ - 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: Manage_Succession_Pool_Request

Manage Succession Plan for a job profile.
 
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.   
Succession_Pool_Reference  Succession_PoolObject  [0..1]  The Reference ID that specifies a Job Profile Succession Plan.   
Succession_Pool_Data  Succession_Pool_Data  [0..1]  Encapsulating Element for managing a Succession Plan.   
Validation Description
Succession Pool already exists.   
A name must be specified for a Succession Pool.   
Job Profile must be specified for a Succession Pool.   
top
 

Response Element: Manage_Succession_Pool_Response

Job Profile Succession Plan Response.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Job_Profile_Succession_Plan_Reference  Succession_PoolObject  [0..1]  The reference for the Succession Plan processed.   
top
 

Succession_PoolObject

part of: Manage_Succession_Pool_Request, Manage_Succession_Pool_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  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_Data

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