Service Directory > v32.1 > Talent > Get_Competency_Snapshots
 

Operation: Get_Competency_Snapshots

This web service task is used to get Competency Snapshot information for use in translation integrations.


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

Top level element for request. This web service will return the current snapshot information for each competency. Note that this will become out of date if the competency is changed.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Competency_Snapshots_Request_References  [0..1]  Used to specify the competency to get information for. If this is blank, each competency will be returned.   
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. 
 
top
 

Response Element: Get_Competency_Snapshots_Response

Top level response for the transaction.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Competency_Snapshots_Request_References  [0..1]  Used to specify a competency to get data for.   
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  Competency_Snapshots_Response_Data  [0..1]  Contains the response for the Competency.   
top
 

Competency_Snapshots_Request_References

part of: Get_Competency_Snapshots_Response, Get_Competency_Snapshots_Request
Used to specify a competency to get data for.
 
Parameter name Type/Value Cardinality Description Validations
Competency_Reference  CompetencyObject  [1..1]  If this competency is specified, snapshot data will only be returned for this competency.   
top
 

CompetencyObject

part of: Competency_Snapshot_Info, Competency_Snapshots_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  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
 

Response_Filter

part of: Get_Competency_Snapshots_Response, Get_Competency_Snapshots_Request
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_Competency_Snapshots_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_Snapshots_Response_Data

part of: Get_Competency_Snapshots_Response
Contains the response for the Competency.
 
Parameter name Type/Value Cardinality Description Validations
Competency_Snapshot_Info  Competency_Snapshot_Info  [0..*]  Contains all of the Snapshot information for the Competency   
top
 

Competency_Snapshot_Info

part of: Competency_Snapshots_Response_Data
Contains all of the Snapshot information for the Competency
 
Parameter name Type/Value Cardinality Description Validations
Competency_Reference  CompetencyObject  [0..1]  The Competency that ties these snapshots together   
Competency_Snapshot_Data  Competency_Snapshot_Data  [0..*]  This contains the most recent Default Snapshot for the Competency. This is set on the Configure Competency page in the UI, and is not tied to any specific Band.   
Competency_Band_Snapshot_Data  Competency_Band_Snapshot_Data  [0..*]  This contains the information about each specific Competency Band. Each one is tied to a specific management level or compensation grade.   
top
 

Competency_Snapshot_Data

part of: Competency_Snapshot_Info
Contains all the information about the Default Competency Snapshot
 
Parameter name Type/Value Cardinality Description Validations
Competency_Default_Snapshot_Reference  Unique_IdentifierObject  [0..1]  This is the Competency Default Snapshot instance. This ID may be useful for integrations trying to translate competency descriptions. Keep in mind that this ID will become out of date if the competency is ever updated.   
Competency_Snapshot_Description  RichText  [0..1]  The description of the Default Competency Snapshot   
Competency_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.   
 
top
 

Unique_IdentifierObject

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

Unique_IdentifierObjectID

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

Competency_Band_Snapshot_Data

part of: Competency_Snapshot_Info
The container for all of the Competency Band Snapshot data.
 
Parameter name Type/Value Cardinality Description Validations
Competency_Band_Reference  Competency_BandObject  [0..1]  The Competency Band. This is configurable with Put Competency Band (Web Service). It represents this particular competency for this particular Management Level/Compensation grade   
Competency_Band_Snapshot_Reference  Unique_IdentifierObject  [0..1]  The current snapshot for the Competency Band. This could be useful for integrations involving translating the competency snapshot description. Keep in mind that this ID will become out of date if the competency band is ever updated.   
Management_Level_or_Compensation_Grade_Reference  Competency_Band_EnabledObject  [0..1]  This is the instance that the Competency Band is for. This can be a Management Level or a Compensation Grade   
XMLNAME__Competency__Description  RichText  [0..1]  The description of the Competency Band   
Competency_Rating_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.   
 
top
 

Competency_BandObject

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

Competency_BandObjectID

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

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

Competency_Band_EnabledObjectID

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

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

RichText

part of: Competency_Band_Snapshot_Data, Competency_Snapshot_Data
Base Type
string
top
 

Proficiency_RatingReferenceEnumeration

part of: Proficiency_RatingObjectID
Base Type
string
top
 

Competency_BandReferenceEnumeration

part of: Competency_BandObjectID
Base Type
string
top
 

Competency_Band_EnabledReferenceEnumeration

part of: Competency_Band_EnabledObjectID
Base Type
string
top