Service Directory > v31.2 > Talent > Get_Talent_Review_Onboarding_Setup
 

Operation: Get_Talent_Review_Onboarding_Setup

This operation retrieves the current configuration of the talent review onboarding setup.


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

This element is the top level request element for the "Get Talent Review Onboarding Setup" operation.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Talent_Review_Onboarding_Setup_Request_References  [0..1]  Get Talent Review Onboarding Setup Request References.   
Request_Criteria [Choice]   Talent_Review_Onboarding_Setup_Request_Criteria  [0..1]  Get Talent Review Onboarding Setup Request Criteria.   
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_Review_Onboarding_Setup_Response_Group  [0..1]  Get Talent Review Onboarding Setup Response Group   
top
 

Response Element: Get_Talent_Review_Onboarding_Setup_Response

Wrapper element containing the response for Talent Review Onboarding Setup.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Talent_Review_Onboarding_Setup_Request_References  [0..1]  Get Talent Review Onboarding Setup Request References.   
Request_Criteria  Talent_Review_Onboarding_Setup_Request_Criteria  [0..1]  Get Talent Review Onboarding Setup Request Criteria.   
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_Review_Onboarding_Setup_Response_Group  [0..1]  Get Talent Review Onboarding Setup Response Group   
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_Review_Onboarding_Setup_Response_Data  [0..1]  Response Data for Talent Review Onboarding Setup   
top
 

Talent_Review_Onboarding_Setup_Request_References

part of: Get_Talent_Review_Onboarding_Setup_Request, Get_Talent_Review_Onboarding_Setup_Response
Get Talent Review Onboarding Setup Request References.
 
Parameter name Type/Value Cardinality Description Validations
Talent_Review_Onboarding_Setup_Reference  Talent_Review_Onboarding_SetupObject  [1..*]  One or more Talent Review Onboarding Setup Reference ID.   
top
 

Talent_Review_Onboarding_SetupObject

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

Talent_Review_Onboarding_SetupObjectID

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

part of: Get_Talent_Review_Onboarding_Setup_Request, Get_Talent_Review_Onboarding_Setup_Response
Get Talent Review Onboarding Setup Request Criteria.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Talent_Review_Onboarding_Setup_Request, Get_Talent_Review_Onboarding_Setup_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_Review_Onboarding_Setup_Response_Group

part of: Get_Talent_Review_Onboarding_Setup_Request, Get_Talent_Review_Onboarding_Setup_Response
Get Talent Review Onboarding Setup Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

part of: Get_Talent_Review_Onboarding_Setup_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_Review_Onboarding_Setup_Response_Data

part of: Get_Talent_Review_Onboarding_Setup_Response
Response Data for Talent Review Onboarding Setup
 
Parameter name Type/Value Cardinality Description Validations
Talent_Review_Onboarding_Setup  Talent_Review_Onboarding_Setup  [0..*]  Wrapper Element for Talent Review Onboarding Setup   
top
 

Talent_Review_Onboarding_Setup

part of: Talent_Review_Onboarding_Setup_Response_Data
Wrapper Element for Talent Review Onboarding Setup
 
Parameter name Type/Value Cardinality Description Validations
Talent_Review_Onboarding_Setup_Data  Talent_Review_Onboarding_Setup_Data  [0..*]  Data element for Talent Review Onboarding Setup.   
top
 

Talent_Review_Onboarding_Setup_Data

part of: Talent_Review_Onboarding_Setup
Data element for Talent Review Onboarding Setup.
 
Parameter name Type/Value Cardinality Description Validations
Default_Template_Reference  Talent_Review_TemplateObject  [0..1]  Element Content for the default Talent Review Template. If there is no Talent Review Template passed in, then the Default Talent Review Template will be changed to null. 
Validation Description
Correct the critical errors on the selected Talent Review Template using the Configure Talent Review Template task.   
 
Templates_with_Rule_Data  Templates_with_Rule_Data  [0..*]  Data element for Talent Review Templates with a rule. 
Validation Description
Enter an order that isn't already in use.  An order can only be used once. 
Enter an order.  An order is required unless the row is being deleted. 
You can only use a Talent Review template once.  A Talent Review Template can only be used once. 
 
top
 

Talent_Review_TemplateObject

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

Talent_Review_TemplateObjectID

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

Templates_with_Rule_Data

part of: Talent_Review_Onboarding_Setup_Data
Data element for Talent Review Templates with a rule.
 
Parameter name Type/Value Cardinality Description Validations
Order  string (6)   [0..1]  Element Content for the order of the Talent Review Onboarding Setup.   
Template_with_Rule_Reference  Talent_Review_TemplateObject  [1..1]  Element Content for the template of the Talent Review Onboarding Setup. The template should be active and with a rule. 
Validation Description
Correct the critical errors on the selected Talent Review Template using the Configure Talent Review Template task.   
 
Delete_Flag  boolean  [0..1]  Element Content for the delete flag of the Talent Review Onboarding Setup. If the delete flag is marked as true, the row will be deleted. The talent review will not be deleted.   
Validation Description
Enter an order that isn't already in use.  An order can only be used once. 
Enter an order.  An order is required unless the row is being deleted. 
You can only use a Talent Review template once.  A Talent Review Template can only be used once. 
top
 

Talent_Review_Onboarding_SetupReferenceEnumeration

part of: Talent_Review_Onboarding_SetupObjectID
Base Type
string
top
 

Talent_Review_TemplateReferenceEnumeration

part of: Talent_Review_TemplateObjectID
Base Type
string
top