Service Directory > v32.1 > Talent > Get_Skills
 

Operation: Get_Skills

This operation retrieves skill items.


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

This request allows you to specify parameters for which skills should be returned.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Skill_Request_References  [0..1]  Use this to specify specific skills to be returned in the response   
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_Skills_Response

This shows all of the tenanted Skill Items or the tenanted Skill Items specified in the request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Skill_Request_References  [0..1]  Using this will allow you specify which skills get returned in the response.   
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  Skill_Response_Data  [0..1]  This contains all of the skills in the response.   
top
 

Skill_Request_References

part of: Get_Skills_Request, Get_Skills_Response
Use this to specify specific skills to be returned in the response
 
Parameter name Type/Value Cardinality Description Validations
Skill_Reference  Skill_Item__Tenanted_Object  [1..*]  This allows specific Skill Items to be returned by reference ID   
top
 

Skill_Item__Tenanted_Object

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

Skill_Item__Tenanted_ObjectID

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

Skill_Response_Data

part of: Get_Skills_Response
This contains the Skill Item content for the response.
 
Parameter name Type/Value Cardinality Description Validations
Skill  Skill  [0..*]  Wrapper element for Skill Items.   
top
 

Skill

part of: Skill_Response_Data
Wrapper element for Skill Items.
 
Parameter name Type/Value Cardinality Description Validations
Skill_Reference  Skill_Item__Tenanted_Object  [0..1]  A reference to a Skill Item.   
Skill_Data  Skill_Item_Data  [0..1]  An element containing information about a Skill Item. 
Validation Description
Skill Item Name already exists.  Checks to see if the Skill Item name already exists to prevent duplicates. 
 
top
 

Skill_Item_Data

part of: Skill
Contains all the information about the Skill Item.
 
Parameter name Type/Value Cardinality Description Validations
@Name  string  [1..1]  The name of the skill item.   
@Inactive  boolean  [1..1]  When true, the Skill Item is inactive.   
Category_Reference  Skill_Item_CategoryObject  [0..1]  A reference to the Skill Item Category associated with the Skill Item.   
ID  string  [0..1]  The ID of the skill item.   
Hide_from_Candidates  boolean  [0..1]  When true, this Skill Item will not be shown to candidates.   
Validation Description
Skill Item Name already exists.  Checks to see if the Skill Item name already exists to prevent duplicates. 
top
 

Skill_Item_CategoryObject

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

Skill_Item_CategoryObjectID

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

Skill_Item__Tenanted_ReferenceEnumeration

part of: Skill_Item__Tenanted_ObjectID
Base Type
string
top
 

Skill_Item_CategoryReferenceEnumeration

part of: Skill_Item_CategoryObjectID
Base Type
string
top