Service Directory > v31.2 > Performance_Management > Get_Competencies
 

Operation: Get_Competencies

This operation retrieves the Competencies 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_Competencies_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]   Competency_Request_References  [0..1]  Element used to filter the request to specific Competencies.   
Request_Criteria [Choice]   Competency_Request_Criteria  [0..1]  Used to filter the Competency 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  Competency_Response_Group  [0..1]  Element used to filter the response.   
top
 

Response Element: Get_Competencies_Response

Response element for Get Competencies
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Competency_Request_References  [0..1]  Element used to filter the request to specific Competencies.   
Request_Criteria  Competency_Request_Criteria  [0..1]  Used to filter the Competency 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  Competency_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  Competency_Response_Data  [0..1]  Contains the Competency response data.   
top
 

Competency_Request_References

part of: Get_Competencies_Request, Get_Competencies_Response
Element used to filter the request to specific Competencies.
 
Parameter name Type/Value Cardinality Description Validations
Competency_Reference  CompetencyObject  [1..*]  The Competencies to filter the request.   
top
 

CompetencyObject

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

CompetencyObjectID

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

Competency_Request_Criteria

part of: Get_Competencies_Request, Get_Competencies_Response
Used to filter the Competency request. Not currently in use.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Competencies_Request, Get_Competencies_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
 

Competency_Response_Group

part of: Get_Competencies_Request, Get_Competencies_Response
Element used to filter the response.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Boolean which indicates if the Competency Reference should be returned.   
top
 

Response_Results

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

Competency_Response_Data

part of: Get_Competencies_Response
Contains the Competency response data.
 
Parameter name Type/Value Cardinality Description Validations
Competency  Competency  [0..*]  Contains the Response Data from the Get Competencies operation.   
top
 

Competency

part of: Competency_Response_Data
Contains the Response Data from the Get Competencies operation.
 
Parameter name Type/Value Cardinality Description Validations
Competency_Reference  CompetencyObject  [0..1]  Reference to an existing competency.   
Competency_Data  Competency_Data  [0..*]  This element contains the data elements for a Competency. 
Validation Description
Competency ID for '[process-instance]' already exists.   
A competency with the name '[competency name]' already exists in the system, and duplicates are not allowed.   
Number of Proficiency Ratings do not match with number of competency levels in a Proficiency Rating Scale.   
 
top
 

Competency_Data

part of: Competency
This element contains the data elements for a Competency.
 
Parameter name Type/Value Cardinality Description Validations
Competency_ID  string  [0..1]  The ID of the Competency.   
Competency_Name  string  [1..1]  The Competency Name of the Competency. When adding a new Competency, duplicate names are not allowed.   
Competency_Description  RichText  [0..1]  The Description of the Competency.   
Description_Applies_to_All_Levels  boolean  [0..1]  The Description of the Competency will be the same everywhere. If Applies to All Levels is not marked True, Descriptions can be modified for each Management Level or Compensation Grade   
Competency_Category_Reference  Competency_CategoryObject  [0..*]  The Competency Category for the Competency.   
Proficiency_Rating_Behavior_Data  Competency_Rating_Behavior_Data  [0..*]  Defines a Proficiency Rating used in a Competency. 
Validation Description
Proficiency Rating selected is not part of Proficiency Rating Scale.   
 
Inactive  boolean  [0..1]  Boolean which indicates if the Competency is inactive.   
Effective_Date  date  [0..1]  On a Put this is the date the change to the Job Profile will take effect. Will default to today if not submitted. On a Get this is the As of Effective Date specified in the Response Filter or today's date if no request criteria is specified. During implementation, we recommend using a date of 01-01-1900 for the initial entry.   
Proficiency_Rating_Scale_Reference  Proficiency_Rating_ScaleObject  [0..1]  The Competency Proficiency Rating Scale   
Behaviors_Apply_to_All_Levels  boolean  [0..1]  Boolean to specify if competency behaviors apply to all levels.   
Used_For_Talent_Matrix  boolean  [0..1]  Check this box if you would like to use this Competency as the horizontal axis when setting up nBox reports for the Talent Matrix.   
Validation Description
Competency ID for '[process-instance]' already exists.   
A competency with the name '[competency name]' already exists in the system, and duplicates are not allowed.   
Number of Proficiency Ratings do not match with number of competency levels in a Proficiency Rating Scale.   
top
 

Competency_CategoryObject

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

Competency_CategoryObjectID

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

Competency_Rating_Behavior_Data

part of: Competency_Data
Defines a Proficiency Rating used in a Competency.
 
Parameter name Type/Value Cardinality Description Validations
Proficiency_Rating_Reference  Proficiency_RatingObject  [1..1]  Proficiency Rating for the Competency.   
Rating_Behavior  string  [0..1]  Describes the Proficiency Level in specific terms for the Competency.   
Validation Description
Proficiency Rating selected is not part of Proficiency Rating Scale.   
top
 

Proficiency_RatingObject

part of: Competency_Rating_Behavior_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_ScaleObject

part of: Competency_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_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
 

CompetencyReferenceEnumeration

part of: CompetencyObjectID
Base Type
string
top
 

RichText

part of: Competency_Data
Base Type
string
top
 

Competency_CategoryReferenceEnumeration

part of: Competency_CategoryObjectID
Base Type
string
top
 

Proficiency_RatingReferenceEnumeration

part of: Proficiency_RatingObjectID
Base Type
string
top
 

Proficiency_Rating_ScaleReferenceEnumeration

part of: Proficiency_Rating_ScaleObjectID
Base Type
string
top