Service Directory > v31.2 > Talent > Get_Proficiency_Rating_Scales
 

Operation: Get_Proficiency_Rating_Scales

This operation retrieves the Proficiency Rating Scales currently defined.


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

This element contains optional reference and filter criteria for the request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Proficiency_Rating_Scale_Request_References  [0..1]  Element used to filter the request to specific Rating Scales.   
Request_Criteria [Choice]   Proficiency_Rating_Scale_Request_Criteria  [0..1]  Used to filter the Rating Scale request.   
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  Proficiency_Rating_Scale_Response_Group  [0..1]  Element used to filter the response.   
top
 

Response Element: Get_Proficiency_Rating_Scales_Response

Response element for Get Proficiency Rating Scales.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Proficiency_Rating_Scale_Request_References  [0..1]  Element used to filter the request to specific Proficiency Rating Scale.   
Request_Criteria  Proficiency_Rating_Scale_Request_Criteria  [0..1]  Used to filter the Rating Scale request. Not currently in use.   
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  Proficiency_Rating_Scale_Response_Group  [0..1]  Element used to filter the response.   
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  Proficiency_Rating_Scale_Response_Data  [0..1]  Contains rating scale response data.   
top
 

Proficiency_Rating_Scale_Request_References

part of: Get_Proficiency_Rating_Scales_Request, Get_Proficiency_Rating_Scales_Response
Element used to filter the request to specific Rating Scales.
 
Parameter name Type/Value Cardinality Description Validations
Proficiency_Rating_Scale_Reference  Proficiency_Rating_ScaleObject  [0..*]  Rating Scales to filter the request.   
top
 

Proficiency_Rating_ScaleObject

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

Proficiency_Rating_ScaleObjectID

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

Proficiency_Rating_Scale_Request_Criteria

part of: Get_Proficiency_Rating_Scales_Request, Get_Proficiency_Rating_Scales_Response
Used to filter the rating scale request. Not currently in use.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Proficiency_Rating_Scales_Request, Get_Proficiency_Rating_Scales_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
 

Proficiency_Rating_Scale_Response_Group

part of: Get_Proficiency_Rating_Scales_Request, Get_Proficiency_Rating_Scales_Response
Element used to filter the response.
 
Parameter name Type/Value Cardinality Description Validations
Include_Proficiency_Rating_Reference  boolean  [0..1]  Indicates if the Proficiency Rating Reference should be returned.   
top
 

Response_Results

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

Proficiency_Rating_Scale_Response_Data

part of: Get_Proficiency_Rating_Scales_Response
Contains proficiency rating scale response data.
 
Parameter name Type/Value Cardinality Description Validations
Proficiency_Rating_Scale  Proficiency_Rating_Scale  [0..*]  Contains the Response Data from the Get Proficiency Ratign Scale operation   
top
 

Proficiency_Rating_Scale

part of: Proficiency_Rating_Scale_Response_Data
Contains the Response Data from the Get Proficiency Rating Scale operation.
 
Parameter name Type/Value Cardinality Description Validations
Proficiency_Rating_Scale_Reference  Proficiency_Rating_ScaleObject  [0..1]  Reference to an existing rating scale.   
Proficiency_Rating_Scale_Data  Proficiency_Rating_Scale_Data  [0..*]  This element contains the data elements for a Proficiency Rating Scale.   
top
 

Proficiency_Rating_Scale_Data

part of: Proficiency_Rating_Scale
This element contains the data elements for a Proficiency Rating Scale.
 
Parameter name Type/Value Cardinality Description Validations
Proficiency_Rating_Scale_ID  string  [0..1]  The ID of the Proficiency Rating Scale.   
Rating_Scale_Name  string  [1..1]  Name of the Rating Scale.   
Description  string  [0..1]  Description of the Rating Scale.   
Inactive  boolean  [0..1]  Boolean to specify if the rating scale is active or inactive.   
Proficiency_Rating_Data  Proficiency_Rating_Data  [0..*]  This element contains the data elements for a Proficiency Rating Scale. 
Validation Description
Begin Range and/or End Range value(s) overlaps with other ranges.   
If Exclude From Calculations is true then Rating Value, Range Begin and Range End must each be 0.   
Cannot add new Proficiency Ratings when Proficiency Rating Scale is in Use.   
 
top
 

Proficiency_Rating_Data

part of: Proficiency_Rating_Scale_Data
This element contains the data elements for a Proficiency Rating Scale.
 
Parameter name Type/Value Cardinality Description Validations
Proficiency_Rating_Reference  Proficiency_RatingObject  [0..1]  Reference to an existing competency level. Only needs to be populated for inbound requests when updating a specific Competency Level.   
Proficiency_Rating_ID  string  [0..1]  Reference ID to a Proficiency Rating. Can be specified to update an existing one or as a custom ID for a new one. If nothing is specified, then a reference ID will get automatically generated.   
Rating_Order  string (6)   [0..1]  Rating Order of the Competency Rating Level   
Rating  string  [1..1]  Name of the Competency Level.   
Exclude_From_Calculations  boolean  [0..1]  If selected then an item with this rating will be excluded from the rating calculation.   
Rating_Value  decimal (11, 2) >0   [0..1]  This is the Rating Value for the competency level.   
Range_Begin  decimal (11, 2) >0   [0..1]  Begin range of the rating value for the competency level.   
Range_End  decimal (11, 2) >0   [0..1]  End range of the rating value for the competency level.   
Proficiency_Rating_Behavior_Data  Proficiency_Rating_Behavior_Data  [0..1]  This element contains the data elements for a Rating Behavior.   
Validation Description
Begin Range and/or End Range value(s) overlaps with other ranges.   
If Exclude From Calculations is true then Rating Value, Range Begin and Range End must each be 0.   
Cannot add new Proficiency Ratings when Proficiency Rating Scale is in Use.   
top
 

Proficiency_RatingObject

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

Proficiency_RatingObjectID

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

Proficiency_Rating_Behavior_Data

part of: Proficiency_Rating_Data
This element contains the data elements for a proficiency rating behavior.
 
Parameter name Type/Value Cardinality Description Validations
Description  string  [0..1]  Behavior for proficiency rating .   
top
 

Proficiency_Rating_ScaleReferenceEnumeration

part of: Proficiency_Rating_ScaleObjectID
Base Type
string
top
 

Proficiency_RatingReferenceEnumeration

part of: Proficiency_RatingObjectID
Base Type
string
top