Service Directory > v32.1 > Human_Resources > Get_Job_Family_Groups
 

Operation: Get_Job_Family_Groups

Returns job family and job family group 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_Family_Groups_Request

Request element for Get Job Family Groups
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Job_Family_Group_Request_References  [0..1]  Utilize the Request References element to retrieve a specific instance(s) of Job Family Group and its associated data.   
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_Group_Response_Group  [0..1]  Get Job Family Group Response Group   
top
 

Response Element: Get_Job_Family_Groups_Response

Response element for the Get Job Family Group request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Job_Family_Group_Request_References  [0..1]  Utilize the Request References element to retrieve a specific instance(s) of Job Family Group and its associated data.   
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_Group_Response_Group  [0..1]  Contains settings to control the type and amount of data returned by the request.   
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_Group_Response_Data  [0..1]  Response element for the Get Job Family request   
top
 

Job_Family_Group_Request_References

part of: Get_Job_Family_Groups_Request, Get_Job_Family_Groups_Response
Utilize the Request References element to retrieve a specific instance(s) of Job Family Group and its associated data.
 
Parameter name Type/Value Cardinality Description Validations
@Skip_Non_Existing_Instances  boolean  [1..1]     
Job_Family_Group_Reference  Job_FamilyObject  [1..*]  A unique identifier used to reference a Job Family Group.   
top
 

Job_FamilyObject

part of: Job_Family_Group_New, Job_Family_Group_Request_References, Job_Family_Group_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
 

Response_Filter

part of: Get_Job_Family_Groups_Request, Get_Job_Family_Groups_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_Group_Response_Group

part of: Get_Job_Family_Groups_Request, Get_Job_Family_Groups_Response
Get Job Family Group Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Flag indicating if the reference to the Job Family Group 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_Family_Groups_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_Group_Response_Data

part of: Get_Job_Family_Groups_Response
Response element for the Get Job Family request
 
Parameter name Type/Value Cardinality Description Validations
Job_Family_Group  Job_Family_Group_New  [0..*]  Encapsulating element containing all Job Family Group data.   
top
 

Job_Family_Group_New

part of: Job_Family_Group_Response_Data
Encapsulating element containing all Job Family Group data.
 
Parameter name Type/Value Cardinality Description Validations
@As_Of_Date  date  [1..1]  Defines the As Of Date to be used for any application effective dated data within the Workday system. For "Request" elements, the "As Of Date" determines what data is to be used within search logic or returned in a response. For "Response" elements, this element will echo "As Of Date" entered in the "Request" element or the default "As Of Date" if omitted..   
@As_Of_Moment  dateTime  [1..1]  Defines the latest moment (e.g. datetime) data was entered into the Workday system. For "Request" elements, the "As Of Moment" determines what data is to be used within search logic or returned in a response. For "Response" elements, this element will echo "As Of Moment" entered in the "Request" element or the default "As Of Moment" if omitted.   
Job_Family_Group_Reference  Job_FamilyObject  [0..1]  A unique identifier used to reference a Job Family Group.   
Job_Family_Group_Data  Job_Family_Group_Data  [0..1]  Contains the detailed information about an Job Family Group.   
top
 

Job_Family_Group_Data

part of: Job_Family_Group_New
Encapsulating element containing all Job Family Group data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  This is the reference id of the Job Family Group (Job_Family_Group_ID). 
Validation Description
Job Family, '[job family]' specified where Job Family Group expected.   
 
Effective_Date  date  [0..1]  Effective date of Job Family Group 
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 Group Name. This can be used for compensation and benefits eligibility rules. 
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 Group 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_Family_Data  Job_Family_Group_Job_Family  [0..*]  Job Family Data. Contains the references to Job Families contained in the group. Optionally contains other data about the contained families, however this extra data is for information only and cannot be updated here.   
top
 

Job_Family_Group_Job_Family

part of: Job_Family_Group_Data
Job Family Data. Contains the references to Job Families contained in the group. Optionally contains other data about the contained families, however this extra data is for information only and cannot be updated here.
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  Flag indicating that the association of the given Job Family should be removed from the group.   
Job_Family_Reference  Job_FamilyObject  [1..1]  Reference element representing a unique instance of Job Family.   
Job_Family_Info_Data  Job_Family_Group_Job_Family_Data  [0..1]  Optional, read-only, data about the job family. This extra information is optionally provided on the Get operation.   
top
 

Job_Family_Group_Job_Family_Data

part of: Job_Family_Group_Job_Family
Info only data about a Job Family
 
Parameter name Type/Value Cardinality Description Validations
Job_Family_Name  string  [0..1]  The name of the Job Family.   
Job_Family_Summary  string  [0..1]  A summary description of the Job Family.   
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_Info_Data  Job_Profile_Summary_Data  [0..*]  Optional, Information only, Job Profile data. This data is optionally included here and cannot be updated.   
top
 

Job_Profile_Summary_Data

part of: Job_Family_Group_Job_Family_Data
Contains the details of a Job Profile.
 
Parameter name Type/Value Cardinality Description Validations
Job_Profile_Reference  Job_ProfileObject  [0..1]  A unique identifier for the job profile.   
Job_Profile_Name  string  [0..1]  The name of the job profile.   
Management_Level_Reference  Management_LevelObject  [0..1]  A unique identifier for the management level.   
Job_Category_Reference  Job_CategoryObject  [0..1]  A unique identifier for the job category.   
Job_Family_Reference  Job_Family_BaseObject  [0..*]  A unique identifier for the job family.   
Work_Shift_Required  boolean  [0..1]  A boolean attribute that returns true if a work shift is required on the position where this job profile is used.   
Job_Profile_Exempt_Data  Job_Profile_Exempt_Data  [0..*]  Element containing the Job Profile Exempt data for a Job Profile. 
Validation Description
Only one Job Exempt entry for a Country/Country Region is allowed. This Country/Country Region is entered more than once: [Location Context].   
 
Critical_Job  boolean  [0..1]  Boolean attribute indicating whether the job profile is considered a critical job.   
Difficulty_to_Fill_Reference  Difficulty_to_FillObject  [0..1]  A unique identifier for the difficulty to fill.   
top
 

Job_ProfileObject

part of: Job_Profile_Summary_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
 

Management_LevelObject

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

Management_LevelObjectID

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

part of: Job_Profile_Summary_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_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
 

Job_Family_BaseObject

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

Job_Family_BaseObjectID

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

part of: Job_Profile_Summary_Data
Element containing the Job Profile Exempt data for a Job Profile.
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  If True is entered, the Job Exempt for the supplied Country/Country Region reference will be deleted. 
Validation Description
Delete is selected but the Job Profile does not have a Job Exempt entry for this Country/Country Region as of the effective date. Job Profile: [profile] Country/Country Region: [location] Effective Date: [date]   
 
Location_Context_Reference  Location_ContextObject  [1..1]  Contains the reference to the Country Reference or Country Region Reference for this Job Exempt value. Leave ISO 3166 1 Alpha 2 Code blank when there‚Äôs a value on Location Context.   
Job_Exempt  boolean  [0..1]  Returns True if the Job Profile is Exempt for the given Country or Country Region.   
Validation Description
Only one Job Exempt entry for a Country/Country Region is allowed. This Country/Country Region is entered more than once: [Location Context].   
top
 

Location_ContextObject

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

Location_ContextObjectID

part of: Location_ContextObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Country_Region_ID, Country_Subregion_Code_In_Country, Country_Subregion_Internal_ID, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code, ISO_3166-2_Code  [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, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code  [1..1]  The unique identifier type of a parent object   
top
 

Difficulty_to_FillObject

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

Difficulty_to_FillObjectID

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

part of: Job_FamilyObjectID
Base Type
string
top
 

Job_ProfileReferenceEnumeration

part of: Job_ProfileObjectID
Base Type
string
top
 

Management_LevelReferenceEnumeration

part of: Management_LevelObjectID
Base Type
string
top
 

Job_CategoryReferenceEnumeration

part of: Job_CategoryObjectID
Base Type
string
top
 

Job_Family_BaseReferenceEnumeration

part of: Job_Family_BaseObjectID
Base Type
string
top
 

Location_ContextReferenceEnumeration

part of: Location_ContextObjectID
Base Type
string
top
 

Base Type
string

top
 

Difficulty_to_FillReferenceEnumeration

part of: Difficulty_to_FillObjectID
Base Type
string
top