Service Directory > v31.2 > Human_Resources > Put_Job_Family_Group
 

Operation: Put_Job_Family_Group

Adds or updates a job family group. Also adds or removes a group's associated job families.


@ - 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: Put_Job_Family_Group_Request

Request element for Put Job Family Group
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update.   
Job_Family_Group_Reference  Job_FamilyObject  [0..1]  A unique identifier used to reference a Job Family Group. 
Validation Description
Job Family Group reference, '[job family]', is a Job Family, not a Job Family Group.   
 
Job_Family_Group_Data  Job_Family_Group_Data  [0..1]  Encapsulating element containing all Job Family Group data   
Validation Description
Job Family Group ID already exists for '[job family group]'.   
top
 

Response Element: Put_Job_Family_Group_Response

Response element for the Put Job Family Group
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Job_Family_Groups_Reference  Job_FamilyObject  [0..1]  Reference element representing a unique instance of Job Family Group.   
top
 

Job_FamilyObject

part of: Job_Family_Group_Job_Family, Put_Job_Family_Group_Request, Put_Job_Family_Group_Response
 
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_Family_Group_Data

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