Service Directory > v31.2 > Performance_Management > Get_Review_Types
 

Operation: Get_Review_Types

Task to export all Review Types from the tenant.


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

This element is the top level request element for the "Get Review Types" operation.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Review_Type_Request_References  [0..1]  Container for Review Type Request References.   
Request_Criteria [Choice]   Review_Type_Request_Criteria  [0..1]  Container for Review Type Request Criteria.   
Response_Filter  Response_Filter  [0..1]  Contains effective date, entry moment, and WWS page and count for getting Customer Goal Units data. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Review_Types_Response

Container for Get Review Types Response.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Review_Type_Request_References  [0..1]  Container for Review Type Request References.   
Request_Criteria  Review_Type_Request_Criteria  [0..1]  Container for Review Type 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_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  Review_Type_Response_Data  [0..1]  Container for the Review Type Response Data.   
top
 

Review_Type_Request_References

part of: Get_Review_Types_Request, Get_Review_Types_Response
Container for Review Type Request References.
 
Parameter name Type/Value Cardinality Description Validations
Review_Type_Reference  Review_TypeObject  [1..*]  One or more Review Type Request Reference ID's.   
top
 

Review_TypeObject

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

Review_TypeObjectID

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

Review_Type_Request_Criteria

part of: Get_Review_Types_Request, Get_Review_Types_Response
Container for Review Type Request Criteria.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Review_Types_Request, Get_Review_Types_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_Review_Types_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
 

Review_Type_Response_Data

part of: Get_Review_Types_Response
Container for the Review Type Response Data.
 
Parameter name Type/Value Cardinality Description Validations
Review_Type  Review_Type  [0..*]  Container for Review Type.   
top
 

Review_Type

part of: Review_Type_Response_Data
Container for Review Type.
 
Parameter name Type/Value Cardinality Description Validations
Review_Type_Reference  Review_TypeObject  [0..1]  Review Type Reference.   
Review_Type_Data  Review_Type_Data  [0..*]  Container for Review Type Data. 
Validation Description
Enter a Review Type Name that isn't already in use.   
You can't delete a Review Type that is in use.   
 
top
 

Review_Type_Data

part of: Review_Type
Container for Review Type Data.
 
Parameter name Type/Value Cardinality Description Validations
Review_Type_ID  string  [0..1]  Reference ID of the Review Type.   
Review_Type_Name  string  [1..1]  Name of the Review Type.   
Review_Type_Category_Reference  Review_CategoryObject  [1..1]  Container for the Review Category of the Review Type.   
Review_Initiated_for_Employee  boolean  [0..1]  Whether the review is initiated for the individual employee related to this review type.   
Review_Initiated_by_Employee  boolean  [0..1]  Whether the review is initiated by the individual employee related to this review type. 
Validation Description
You can't specify Review Initiated by Employee if Review Category is Disciplinary Action, Performance Improvement Plan, or Performance Review.   
 
Used_by_Templates_Count  decimal (12, 0) >0   [0..1]  The count employee review templates that this Review Type is associated with. This field is for Extracts only and not for loads.   
Validation Description
Enter a Review Type Name that isn't already in use.   
You can't delete a Review Type that is in use.   
top
 

Review_CategoryObject

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

Review_CategoryObjectID

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

Review_TypeReferenceEnumeration

part of: Review_TypeObjectID
Base Type
string
top
 

Review_CategoryReferenceEnumeration

part of: Review_CategoryObjectID
Base Type
string
top