Service Directory > v32.1 > Talent > Manage_Succession_Plan
 

Operation: Manage_Succession_Plan

Web service for Managing a Succession Plan for a position.


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

Manage the succession plan for a position.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Business_Process_Parameters  Business_Process_Parameters  [0..1]  Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.   
Succession_Plan_Data  Manage_Succession_Plan_Business_Process_Data  [1..1]  Encapsulating Element for managing a Succession Plan.   
top
 

Response Element: Manage_Succession_Plan_Response

Manage Succession Plan Response.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Manage_Succession_Plan_Event_Reference  Unique_IdentifierObject  [0..1]  The reference for the Succession Plan Event processed.   
top
 

Business_Process_Parameters

part of: Manage_Succession_Plan_Request
Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.
 
Parameter name Type/Value Cardinality Description Validations
Auto_Complete  boolean  [0..1]  When set to "true" or "1", the business process is automatically processed. This means that all approvals will be automatically approved in the system, all reviews and to-do's will be automatically by-passed, and all notifications will be automatically suppressed.   
Run_Now  boolean  [0..1]  Indicates the transaction should process to completion before the response is generated. Note: All < v12 operations will process with Run_Now = True for backwards compatibility but please review this setting in your environment for performance conditions.   
Comment_Data  Business_Process_Comment_Data  [0..1]  Captures a comment for the Business Process.   
Business_Process_Attachment_Data  Business_Process_Attachment_Data  [0..*]  Element for the attachments pertaining to a Event entered through a web service. 
Validation Description
This Business Process Type has been configured to not accept Event Attachments.   
 
top
 

Business_Process_Comment_Data

part of: Business_Process_Parameters
Captures a comment for the Business Process.
 
Parameter name Type/Value Cardinality Description Validations
Comment  string  [0..1]  Free form comment regarding the business process. 
Validation Description
This Business Process has been configured to disable comment. Please remove the comment or change the setting in the Business Process Policy or tenant setup.   
 
Worker_Reference  WorkerObject  [0..1]  Default the Person making the comment to the processing person if not submitted via the web service.   
top
 

WorkerObject

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

Business_Process_Attachment_Data

part of: Business_Process_Parameters
Element for the attachments pertaining to a Event entered through a web service.
 
Parameter name Type/Value Cardinality Description Validations
File_Name  string (255)   [1..1]  Filename for the attachment.   
Event_Attachment_Description  string  [0..1]  Free form text comment about the attachment.   
Event_Attachment_Category_Reference  Event_Attachment_CategoryObject  [0..1]  Category of attachment. 
Validation Description
This Business Process Type has been configured to not accept Attachment Categories.   
 
File  base64Binary  [0..1]  Binary file contents.   
Content_Type  string (80)   [0..1]  Text attribute identifying Content Type of the Attachment.   
top
 

Event_Attachment_CategoryObject

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

Event_Attachment_CategoryObjectID

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

Manage_Succession_Plan_Business_Process_Data

part of: Manage_Succession_Plan_Request
Encapsulating Element for managing a Succession Plan.
 
Parameter name Type/Value Cardinality Description Validations
Position_Element_Reference  Position_ElementObject  [1..1]  Position ID with active Succession Plan. 
Validation Description
Position submitted is not filled as of the effective date.   
 
Consider_External_Candidate  boolean  [0..1]  Whether or not the candidate is external.   
Candidate_Data  Manage_Succession_Plan_Event_Candidate_Data  [0..*]  Encapsulating element containing candidate data for a Succession Plan. 
Validation Description
[candidate name] is an external candidate. Remove [candidate name] from the list or select Consider External Candidate.   
[Strategy Name] (Inactive) is inactive. Select an active strategy.   
You can't have more than 1 row with the same candidate or same strategy.   
You can't have more than 1 row with no candidate and no strategy.   
 
top
 

Position_ElementObject

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

Position_ElementObjectID

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

Manage_Succession_Plan_Event_Candidate_Data

part of: Manage_Succession_Plan_Business_Process_Data
Encapsulating element containing candidate data for a Succession Plan.
 
Parameter name Type/Value Cardinality Description Validations
Candidate_Reference  Succession_Plan_MemberObject  [0..1]  Candidate Reference   
Succession_Strategy_Reference  Succession_StrategyObject  [0..1]  The strategy to be used for this succession plan.   
Succession_Readiness_Reference  Succession_ReadinessObject  [1..1]  The readiness of the candidate to fill this position.   
Top_Candidate  boolean  [0..1]  Indicates whether the employee is the top candidate for this succession plan.   
Temporary_Fill  boolean  [0..1]  Indicates whether the employee is a temporary fill for this succession plan.   
Notes  RichText  [0..1]  Notes on this candidate.   
Validation Description
[candidate name] is an external candidate. Remove [candidate name] from the list or select Consider External Candidate.   
[Strategy Name] (Inactive) is inactive. Select an active strategy.   
You can't have more than 1 row with the same candidate or same strategy.   
You can't have more than 1 row with no candidate and no strategy.   
top
 

Succession_Plan_MemberObject

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

Succession_Plan_MemberObjectID

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

Succession_StrategyObject

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

Succession_StrategyObjectID

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

Unique_IdentifierObject

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

Unique_IdentifierObjectID

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

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Event_Attachment_CategoryReferenceEnumeration

part of: Event_Attachment_CategoryObjectID
Base Type
string
top
 

Position_ElementReferenceEnumeration

part of: Position_ElementObjectID
Base Type
string
top
 

Succession_Plan_MemberReferenceEnumeration

part of: Succession_Plan_MemberObjectID
Base Type
string
top
 

Succession_StrategyReferenceEnumeration

part of: Succession_StrategyObjectID
Base Type
string
top
 

Succession_ReadinessReferenceEnumeration

part of: Succession_ReadinessObjectID
Base Type
string
top
 

RichText

part of: Manage_Succession_Plan_Event_Candidate_Data
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top