Service Directory > v31.2 > Human_Resources > Put_Job_Family
 

Operation: Put_Job_Family

Adds or updates a job family.


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

Request element for Put Job Family
 
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_Reference  Job_FamilyObject  [0..1]  Reference element representing a unique instance of Job Family. 
Validation Description
Job Family reference, '[job family group]', is a Job Family Group, not a Job Family.   
 
Job_Family_Data  Job_Family_Data  [0..1]  Data to be used for adding a new Job Family or updating an existing Job Family.   
Validation Description
Job Family, '[job family]', already exists.   
top
 

Response Element: Put_Job_Family_Response

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

Job_FamilyObject

part of: Put_Job_Family_Request, Put_Job_Family_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_Data

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

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