Service Directory > v31.2 > Talent > Get_Subspecialties
 

Operation: Get_Subspecialties

This operation will get the Subspecialties 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_Subspecialties_Request

Request element for the Get Subspecialties operation
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Subspecialty_Request_References  [0..1]  Utilize the Request References element to retrieve a specific instance(s) of Subspecialty and its associated data.   
Request_Criteria [Choice]   Subspecialty_Request_Criteria  [0..1]  Utilize the Subspecialty Request Criteria element to retrieve instances of Subspecialty based on their Name, Code, or Inactive/Active status   
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_Subspecialties_Response

Response element for the Get Subspecialties operation
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Subspecialty_Request_References  [0..1]  Utilize the Request References element to retrieve a specific instance(s) of Subspecialty and its associated data.   
Request_Criteria  Subspecialty_Request_Criteria  [0..1]  Utilize the Subspecialty Request Criteria element to retrieve instances of Subspecialty based on their Name, Code, or Inactive/Active status   
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  Subspecialty_Response_Data  [0..1]  Response element for the Get Subspecialties operation.   
top
 

Subspecialty_Request_References

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

Specialty_ChildObject

part of: Subspecialty_Request_References, Subspecialty
 
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
 

Subspecialty_Request_Criteria

part of: Get_Subspecialties_Request, Get_Subspecialties_Response
Utilize the Subspecialty Request Criteria element to retrieve instances of Subspecialty based on their Name, Code, or Inactive/Active status
 
Parameter name Type/Value Cardinality Description Validations
Subspecialty_Name  string  [0..1]  Retrieve a Subspecialty based on whether their name contains this search name. Case insensitive.   
Subspecialty_Code  string  [0..1]  Retrieve a Subspecialty based on whether their code contains this search code. Case insensitive.   
Subspecialty_Active  boolean  [0..1]  Retrieve Subspecialties based on whether they have the same inactive/active flag.   
top
 

Response_Filter

part of: Get_Subspecialties_Request, Get_Subspecialties_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_Subspecialties_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
 

Subspecialty_Response_Data

part of: Get_Subspecialties_Response
Response element for the Get Subspecialties operation.
 
Parameter name Type/Value Cardinality Description Validations
Subspecialty  Subspecialty  [0..*]  Encapsulating element containing all Subspecialty dayta   
top
 

Subspecialty

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

Subspecialty_Data

part of: Subspecialty
Contains the detailed information about a Subspecialty.
 
Parameter name Type/Value Cardinality Description Validations
Subspecialty_Name  string  [1..1]  The name of the Subspecialty. This is a required field. The Subspecialty Name combined with the Subspecialty Code must be unique.   
Subspecialty_Description  string  [0..1]  A description for the subspecialty.   
Subspecialty_Code  string  [1..1]  An alphanumeric code for the subspecialty. This is a required field. The combination of the Specialty Code and the Specialty name must be unique.   
Subspecialty_ID  string  [0..1]  ID Field (Subspecialty_ID)   
URL  string  [0..1]  A URL for the Subspecialty.   
Inactive  boolean  [0..1]  Indicates whether the subspecialty is inactive or not. Inactive subspecialties cannot be added to certification achievements by workers.   
Validation Description
You must first select Enable Specialties for Certifications on the Maintain Skills and Experience Setup task.   
top
 

Specialty_ChildReferenceEnumeration

part of: Specialty_ChildObjectID
Base Type
string
top