Service Directory > v31.2 > Human_Resources > Get_Job_Categories
 

Operation: Get_Job_Categories

This operation will get Job Categories for the specified criteria. The request criteria can be for a single entry based on a Reference ID or all Job Categories will be retrieved if no criteria is specified. Job Category data includes the Reference ID, the name and the description and inactive flag.


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

Contains request reference and filter for getting Job Category data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Job_Category_Request_References  [0..1]  Element containing reference instance for a Job Category.   
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_Job_Categories_Response

Element containing Job Category response elements include received criteria, references, data based on criteria and grouping, results filter and result summary.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Job_Category_Request_References  [0..1]  Element containing reference instance for a Job Category.   
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  Job_Category_Response_Data  [0..1]  Wrapper element that includes the Job Category reference instance and data.   
top
 

Job_Category_Request_References

part of: Get_Job_Categories_Request, Get_Job_Categories_Response
Element containing reference instance for a Job Category.
 
Parameter name Type/Value Cardinality Description Validations
Job_Category_Reference  Job_CategoryObject  [1..*]  Reference to a Job Category.   
top
 

Job_CategoryObject

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

Job_CategoryObjectID

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

Response_Filter

part of: Get_Job_Categories_Request, Get_Job_Categories_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_Job_Categories_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
 

Job_Category_Response_Data

part of: Get_Job_Categories_Response
Wrapper element that includes the Job Category reference instance and data.
 
Parameter name Type/Value Cardinality Description Validations
Job_Category  Job_Category  [0..*]  Element containing the job category reference and data.   
top
 

Job_Category

part of: Job_Category_Response_Data
Element containing the job category reference and data.
 
Parameter name Type/Value Cardinality Description Validations
Job_Category_Reference  Job_CategoryObject  [0..1]  Reference to a Job Category.   
Job_Category_Data  Job_Category_Data  [0..*]  Wrapper element that encapsulates the Job Category Data   
top
 

Job_Category_Data

part of: Job_Category
Wrapper element that encapsulates the Job Category Data
 
Parameter name Type/Value Cardinality Description Validations
Job_Category_ID  string  [0..1]  A unique identifier for the job category.   
Job_Category_Name  string  [0..1]  Name of the Job Category. 
Validation Description
Job Category Name is required.   
 
Job_Category_Description  string  [0..1]  Free form text describing a job category.   
Inactive  boolean  [0..1]  Boolean which indicates if the Job category is inactive.   
top
 

Job_CategoryReferenceEnumeration

part of: Job_CategoryObjectID
Base Type
string
top