Service Directory > v31.2 > Human_Resources > Get_Job_Families
 

Operation: Get_Job_Families

Returns job family data.


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

Request element for Get Job Families
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Job_Family_Request_References  [0..1]  The Job Family reference(s) to be retrieved. Does not support job family groups.   
Request_Criteria  Job_Families_Request_Criteria  [0..1]  Utilize the Request Criteria element to limit the Job Families returned based on the specific criteria. Job Families that are returned must meet all of the criteria specified.   
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_Group  Job_Family_Response_Group  [0..1]  Job Family Response Group which controls the type and amount of data returned.   
top
 

Response Element: Get_Job_Families_Response

Response element for Get Job Families.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Job_Family_Request_References  [0..1]  The Job Family reference(s) to be retrieved. Does not support job family groups.   
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. 
 
Request_Criteria  Job_Families_Request_Criteria  [0..1]  Utilize the Request Criteria element to limit the Job Families returned based on the specific criteria. Job Families that are returned must meet all of the criteria specified.   
Response_Group  Job_Family_Response_Group  [0..1]  Job Family Response Group   
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_Family_Response_Data  [0..1]  Job Family Response Data containing the retrieved Job Family information   
top
 

Job_Family_Request_References

part of: Get_Job_Families_Request, Get_Job_Families_Response
The Job Family reference(s) to be retrieved. Does not support job family groups.
 
Parameter name Type/Value Cardinality Description Validations
@Skip_Non_Existing_Instances  boolean  [1..1]     
Job_Family_Reference  Job_FamilyObject  [1..*]  Reference element representing a unique instance of Job Family. Does not support job family groups.   
top
 

Job_FamilyObject

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

Job_FamilyObjectID

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

Job_Families_Request_Criteria

part of: Get_Job_Families_Request, Get_Job_Families_Response
Utilize the Request Criteria element to limit the Job Families returned based on the specific criteria. Job Families that are returned must meet all of the criteria specified.
 
Parameter name Type/Value Cardinality Description Validations
Field_And_Parameter_Criteria_Data  Field_And_Parameter_Criteria_Data  [0..1]  Field Result Request Criteria   
Include_InActive_Job_Families  boolean  [0..1]  Gives the customer the ability to have inactive job families returned   
top
 

Field_And_Parameter_Criteria_Data

part of: Job_Families_Request_Criteria
Field Result Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Provider_Reference  External_Field_and_Parameter_Initialization_ProviderObject  [1..*]  Field And Parameter Initialization Provider Reference   
top
 

External_Field_and_Parameter_Initialization_ProviderObject

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

External_Field_and_Parameter_Initialization_ProviderObjectID

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

Job_Family_Response_Group

part of: Get_Job_Families_Request, Get_Job_Families_Response
Job Family Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Flag indicating if the reference to the Job Family should be included. If omitted, the default is to return the references.   
Include_Job_Profile_Info_Data  boolean  [0..1]  Flag indicating whether or not to include the basic data about Job Profiles that are used by the Job Families associated with the group. Default is to not return this additional information.   
top
 

Response_Results

part of: Get_Job_Families_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_Family_Response_Data

part of: Get_Job_Families_Response
Job Family Response Data containing the retrieved Job Family information
 
Parameter name Type/Value Cardinality Description Validations
Job_Family  Job_Family  [0..*]  contains the retrieved Job Family information   
top
 

Job_Family

part of: Job_Family_Response_Data
Contains Job Family information
 
Parameter name Type/Value Cardinality Description Validations
Job_Family_Reference  Job_FamilyObject  [0..1]  Reference element representing a unique instance of Job Family.   
Job_Family_Data  Job_Family_Data  [0..1]  Encapsulating element containing all Job Family data.   
top
 

Job_Family_Data

part of: Job_Family
Encapsulating element containing all Job Family data.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  The ID of the Job Family data (Job_Family_ID).   
Effective_Date  date  [0..1]  Effective Date of Job Family. 
Validation Description
The effective date of the change [date] cannot be earlier than the earliest effective date [early].   
 
Name  string  [0..1]  Text attribute identifying Job Family Name. 
Validation Description
Name is required.   
Another Job Family or Job Family Group is already using this name.   
 
Summary  string  [0..1]  Text attribute identifying Job Family Summary.   
Inactive  boolean  [0..1]  Boolean attribute indicating if a Job Family/Job Family Group is Inactive or not. Inactive Job Families/Groups will not appear in prompts.   
Job_Profile_Data  Job_Profile_for_Job_Family_Data  [0..*]  Element containing the Job Profile reference for a Job Family.   
Integration_Field_Override_Data  Document_Field_Result_Data  [0..*]  Result of the evaluation of an External Field based on a contextual instance.   
top
 

Job_Profile_for_Job_Family_Data

part of: Job_Family_Data
Element containing the Job Profile reference for a Job Family.
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  If True is entered, the job profile reference will be deleted.   
Job_Profile_Reference  Job_ProfileObject  [0..1]  A unique identifier for the job profile.   
top
 

Job_ProfileObject

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

Job_ProfileObjectID

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

Document_Field_Result_Data

part of: Job_Family_Data
Result of the evaluation of an External Field based on a contextual instance.
 
Parameter name Type/Value Cardinality Description Validations
Field_Reference  Integration_Document_FieldObject  [0..1]  Integration Document Field Reference. Eligibility Criteria element is used in conjunction with Workday delivered integrations.   
Value  string  [0..1]  Value   
top
 

Integration_Document_FieldObject

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

Integration_Document_FieldObjectID

part of: Integration_Document_FieldObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Integration_Document_Field_Name, Workday_Integration_Document_Field_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".   
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_type  WID, Integration_Document_Name, Workday_Integration_Document_Name  [1..1]  The unique identifier type of a parent object   
top
 

Job_FamilyReferenceEnumeration

part of: Job_FamilyObjectID
Base Type
string
top
 

External_Field_and_Parameter_Initialization_ProviderReferenceEnumeration

part of: External_Field_and_Parameter_Initialization_ProviderObjectID
Base Type
string
top
 

Job_ProfileReferenceEnumeration

part of: Job_ProfileObjectID
Base Type
string
top
 

Integration_Document_FieldReferenceEnumeration

part of: Integration_Document_FieldObjectID
Base Type
string
top
 

Base Type
string

top