Service Directory > v32.1 > Talent > Get_Succession_Strategies
 

Operation: Get_Succession_Strategies

Returns Succession Strategies by Reference ID, or returns all Succession Strategies if no Reference ID is provided.


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

Element for Get Succession Strategies Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Succession_Strategy_Request_References  [0..1]  Element Container for Request References   
Response_Filter  Response_Filter  [0..1]  Element Container for Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Succession_Strategies_Response

Element for Get Succession Strategies Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Succession_Strategy_Request_References  [0..1]  Element Content for Succession Strategy Request References   
Response_Filter  Response_Filter  [0..1]  Element Content for Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  Element Content for Response Result   
Response_Data  Succession_Strategy_Response_Data  [0..1]  Element Content for Response Data   
top
 

Succession_Strategy_Request_References

part of: Get_Succession_Strategies_Request, Get_Succession_Strategies_Response
Element for Succession Strategy Request References
 
Parameter name Type/Value Cardinality Description Validations
Succession_Strategy_Reference  Succession_StrategyObject  [1..*]  Element Content for Succession Strategy Reference   
top
 

Succession_StrategyObject

part of: Succession_Strategy_Request_References, Succession_Strategy
 
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
 

Response_Filter

part of: Get_Succession_Strategies_Request, Get_Succession_Strategies_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
 

Response_Results

part of: Get_Succession_Strategies_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_Strategy_Response_Data

part of: Get_Succession_Strategies_Response
Element for Succession Strategy Response Data
 
Parameter name Type/Value Cardinality Description Validations
Succession_Strategy  Succession_Strategy  [0..*]  Element Container for Succession Strategy   
top
 

Succession_Strategy

part of: Succession_Strategy_Response_Data
Element for Succession Strategy
 
Parameter name Type/Value Cardinality Description Validations
Succession_Strategy_Reference  Succession_StrategyObject  [0..1]  Element Container for Succession Strategy Reference   
Succession_Strategy_Data  Succession_Strategy_Data  [0..*]  Element Container for Succession Strategy Data 
Validation Description
You can't delete a Succession Strategy that is in use.   
Enter a Succession Strategy that isn't already in use.   
Specify a name for the Succession Strategy.   
 
top
 

Succession_Strategy_Data

part of: Succession_Strategy
Element Succession Strategy Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Element Container for ID   
Succession_Strategy_Name  string  [0..1]  Element Container for Succession Strategy Name   
Inactive  boolean  [0..1]  Element Container for Succession Strategy Inactive   
In_Use  boolean  [0..1]  Element Container for In Use   
Validation Description
You can't delete a Succession Strategy that is in use.   
Enter a Succession Strategy that isn't already in use.   
Specify a name for the Succession Strategy.   
top
 

Succession_StrategyReferenceEnumeration

part of: Succession_StrategyObjectID
Base Type
string
top