Service Directory > v32.1 > Talent > Get_Specialties
 

Operation: Get_Specialties

This operation will get the Specialties 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_Specialties_Request

Request element for the Get Specialties operation
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Specialty_Request_References  [0..1]  Utilize the Request References element to retrieve a specific instance(s) of Specialty and its associated data.   
Request_Criteria [Choice]   Specialty_Request_Criteria  [0..1]  Element that allows users to specify selection criteria for Specialties.   
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_Specialties_Response

Response element for the Get Specialties operation
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Specialty_Request_References  [0..1]  Utilize the Request References element to retrieve a specific instance(s) of Specialty and its associated data.   
Request_Criteria  Specialty_Request_Criteria  [0..1]  Element that allows users to specify selection criteria for Specialties.   
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  Specialty_Response_Data  [0..1]  Response element for the Get Specialty operation   
top
 

Specialty_Request_References

part of: Get_Specialties_Request, Get_Specialties_Response
Utilize the Request References element to retrieve a specific instance(s) of Specialty and its associated data.
 
Parameter name Type/Value Cardinality Description Validations
Specialty_Reference  Specialty_ParentObject  [1..*]  A unique identifier used to reference a Specialty   
top
 

Specialty_ParentObject

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

Specialty_ParentObjectID

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

Specialty_Request_Criteria

part of: Get_Specialties_Request, Get_Specialties_Response
Element that allows users to specify selection criteria for Specialties.
 
Parameter name Type/Value Cardinality Description Validations
Specialty_Name  string  [0..1]  Allows users to select Specialties based on Name.   
Specialty_Code  string  [0..1]  Allows users to select Specialties based on Code.   
Specialty_Inactive  boolean  [0..1]  Allows users to select Specialties based on Active/Inactive status.   
top
 

Response_Filter

part of: Get_Specialties_Request, Get_Specialties_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_Specialties_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
 

Specialty_Response_Data

part of: Get_Specialties_Response
Response element for the Get Specialty operation
 
Parameter name Type/Value Cardinality Description Validations
Specialty  Specialty  [0..*]  Encapsulating element containing all Specialty data   
top
 

Specialty

part of: Specialty_Response_Data
Encapsulating element containing all Specialty data
 
Parameter name Type/Value Cardinality Description Validations
Specialty_Reference  SpecialtyObject  [0..1]  A unique identifier used to reference a Specialty.   
Specialty_Data  Specialty_Data  [0..*]  Contains the detailed information about a Specialty. 
Validation Description
You must first select Enable Specialties for Certifications on the Maintain Skills and Experience Setup task.   
 
top
 

SpecialtyObject

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

SpecialtyObjectID

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

Specialty_Data

part of: Specialty
Contains the detailed information about a Specialty.
 
Parameter name Type/Value Cardinality Description Validations
Specialty_Name  string  [1..1]  The name of a Specialty. The name combined with the code must be unique.   
Specialty_Description  string  [0..1]  The description of the specialty   
Specialty_Code  string  [1..1]  An alphanumeric identifier for the Specialty. The code combined with the name must be unique.   
Specialty_ID  string  [0..1]  ID field (Specialty_ID)   
Restrict_Specialty_Usage  boolean  [0..1]  When true, prevents the specialty from being used during ad-hoc certification creation.   
Specialty_Inactive  boolean  [0..1]  Indicates if the Specialty is inactive. If inactive, it cannot be added to a certification.   
Specialty_URL  string  [0..1]  A URL associated with the Specialty   
Subspecialty_Reference  Specialty_ChildObject  [0..*]  Provides references to each Subspecialty associated with the Specialty.   
Validation Description
You must first select Enable Specialties for Certifications on the Maintain Skills and Experience Setup task.   
top
 

Specialty_ChildObject

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

Specialty_ChildObjectID

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

Specialty_ParentReferenceEnumeration

part of: Specialty_ParentObjectID
Base Type
string
top
 

SpecialtyReferenceEnumeration

part of: SpecialtyObjectID
Base Type
string
top
 

Specialty_ChildReferenceEnumeration

part of: Specialty_ChildObjectID
Base Type
string
top