Service Directory > v25.1 > Staffing > Set_Hiring_Restrictions
 

Operation: Set_Hiring_Restrictions

This operation will create the hiring restrictions for a job management supervisory organization.


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

Wrapper element for set hiring restrictions web service
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Business_Process_Parameters  Business_Process_Parameters  [0..1]  Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place.   
Set_Hiring_Restrictions_Data  Set_Hiring_Restrictions_Data  [1..1]  Wrapper element for the creation of Hiring Restrictions   
top
 

Response Element: Set_Hiring_Restrictions_Response

Responds with the event id for the Job Restrictions Request Event, and the Supervisory Organization Reference.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Event_Reference  Unique_IdentifierObject  [0..1]  Reference to the Job Restrictions Request Event   
Supervisory_Organization_Reference  Supervisory_OrganizationObject  [0..1]  Reference to the Supervisory Organization   
top
 

Business_Process_Parameters

part of: Set_Hiring_Restrictions_Request
Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place.
 
Parameter name Type/Value Cardinality Description Validations
Auto_Complete  boolean  [0..1]  When set to "true" or "1", the business process is automatically processed. This means that all approvals will be automatically approved in the system, all reviews and to-do's will be automatically by-passed, and all notifications will be automatically suppressed.   
Run_Now  boolean  [0..1]  Indicates the transaction should process to completion before the response is generated. Note: All < v12 operations will process with Run_Now = True for backwards compatibility but please review this setting in your environment for performance conditions.   
Comment_Data  Business_Process_Comment_Data  [0..1]  Captures a comment for the Business Process.   
Business_Process_Attachment_Data  Business_Process_Attachment_Data  [0..*]  Element for the attachments pertaining to a Event entered through a web service. 
Validation Description
This Business Process Type has been configured to not accept Event Attachments.   
 
top
 

Business_Process_Comment_Data

part of: Business_Process_Parameters
Captures a comment for the Business Process.
 
Parameter name Type/Value Cardinality Description Validations
Comment  string  [0..1]  Free form comment regarding the business process. 
Validation Description
This Business Process has been configured to disable comment. Please remove the comment or change the setting in the Business Process Policy or tenant setup.   
 
Worker_Reference  WorkerObject  [0..1]  Default the Person making the comment to the processing person if not submitted via the web service.   
top
 

WorkerObject

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

WorkerObjectID

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

Business_Process_Attachment_Data

part of: Business_Process_Parameters
Element for the attachments pertaining to a Event entered through a web service.
 
Parameter name Type/Value Cardinality Description Validations
File_Name  string (255)   [1..1]  Filename for the attachment.   
Event_Attachment_Description  string  [0..1]  Free form text comment about the attachment.   
Event_Attachment_Category_Reference  Event_Attachment_CategoryObject  [0..1]  Category of attachment. 
Validation Description
This Business Process Type has been configured to not accept Attachment Categories.   
 
File  base64Binary  [0..1]  Binary file contents.   
Content_Type  string (80)   [0..1]  Text attribute identifying Content Type of the Attachment.   
top
 

Event_Attachment_CategoryObject

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

Event_Attachment_CategoryObjectID

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

Set_Hiring_Restrictions_Data

part of: Set_Hiring_Restrictions_Request
Wrapper element for setting hiring restrictions
 
Parameter name Type/Value Cardinality Description Validations
Supervisory_Organization_Reference  Supervisory_OrganizationObject  [1..1]  Reference to the supervisory organization to set hiring restrictions for 
Validation Description
Supervisory Organization submitted is not valid. Verify that it is active, uses the Job Management Staffing Model and that the user has access to it.   
The submitted organization already has hiring restrictions. Use the edit hiring restrictions process to update the restrictions for this organization.   
 
Hiring_Restrictions_Request_Reason_Reference  Event_Classification_SubcategoryObject  [0..1]  Reference to the reason the hiring restrictions are being set   
Position_Group_Restrictions_Data  Position_Group_Restriction_Data  [1..1]  Wrapper for restriction data for openings for all staffing models. 
Validation Description
Availability Date is required for an opening or hiring restriction.   
Earliest hire date is required for an opening or hiring restriction.   
 
top
 

Supervisory_OrganizationObject

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

Supervisory_OrganizationObjectID

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

Event_Classification_SubcategoryObject

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

Event_Classification_SubcategoryObjectID

part of: Event_Classification_SubcategoryObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Benefits_Event_Subcategory_ID, Change_Job_Subcategory_ID, End_Additional_Job_Subcategory_ID, Event_Classification_Subcategory_ID, General_Event_Subcategory_ID, Leave_of_Absence_Type_ID, Termination_Subcategory_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
 

Position_Group_Restriction_Data

part of: Set_Hiring_Restrictions_Data
Wrapper for restriction data for openings for all staffing models.
 
Parameter name Type/Value Cardinality Description Validations
Availability_Date  date  [0..1]  Date the opening is available. On a create, this will default to current date if no date is provided. 
Validation Description
Enter an Availability Date that is on or after [date1], the date the hiring restrictions were created.   
 
Earliest_Hire_Date  date  [0..1]  Earliest date that a worker can be hired/contracted into this opening. This field is required to have a value. On creation it will default to the current date. On an edit, if not submitted the existing value will be retained. This date cannot be earlier than the Availability date. 
Validation Description
The earliest hire date cannot be before the availability date.   
 
Job_Family_Reference  Job_FamilyObject  [0..*]  Reference(s) to the job families that a worker being hired/contracted using this opening can use. On an edit, if not submitted the existing value(s) will be retained. If submitted with an empty value, the existing value(s) will be removed.   
Job_Profile_Reference  Job_ProfileObject  [0..*]  Reference(s) to the job profiles that a worker being hired/contracted using this opening can use. On an edit, if not submitted the existing value(s) will be retained. If submitted with an empty value, the existing value(s) will be removed.   
Location_Reference  LocationObject  [0..*]  Reference(s) to the location that a worker being hired/contracted using this opening can use. On an edit, if not submitted the existing value(s) will be retained. If submitted with an empty value, the existing value(s) will be removed.   
Worker_Type_Reference  Worker_TypeObject  [0..1]  Reference to the worker type that a worker being hired/contracted using this opening can use. On an edit, if not submitted the existing value will be retained. If submitted with an empty value, the existing value will be removed.   
Time_Type_Reference  Position_Time_TypeObject  [0..1]  Reference to the time type that a worker being hired/contracted using this opening can use. On an edit, if not submitted the existing value will be retained. If submitted with an empty value, the existing value will be removed.   
Position_Worker_Type_Reference  Position_Worker_TypeObject  [0..*]  Reference(s) to the Employee or Contingent Worker types that a worker being hired/contracted using this opening can use. Employee Type values are only valid if the Worker Type is Employee. Contingent Worker Types are only valid if Worker Type is Contingent Worker. On an edit, if not submitted the existing value(s) will be retained. If submitted with an empty value, the existing value(s) will be removed. 
Validation Description
Position Worker Type is only valid if Worker Type is entered.   
Only Contingent Worker Types are valid when the worker type is Contingent Worker.   
Only Employee Types are valid when the worker type is Employee.   
 
Validation Description
Availability Date is required for an opening or hiring restriction.   
Earliest hire date is required for an opening or hiring restriction.   
top
 

Job_FamilyObject

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

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

LocationObject

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

LocationObjectID

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

Worker_TypeObject

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

Worker_TypeObjectID

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

Position_Time_TypeObject

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

Position_Time_TypeObjectID

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

Position_Worker_TypeObject

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

Position_Worker_TypeObjectID

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

Unique_IdentifierObject

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

Unique_IdentifierObjectID

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

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Event_Attachment_CategoryReferenceEnumeration

part of: Event_Attachment_CategoryObjectID
Base Type
string
top
 

Supervisory_OrganizationReferenceEnumeration

part of: Supervisory_OrganizationObjectID
Base Type
string
top
 

Event_Classification_SubcategoryReferenceEnumeration

part of: Event_Classification_SubcategoryObjectID
Base Type
string
top
 

Job_FamilyReferenceEnumeration

part of: Job_FamilyObjectID
Base Type
string
top
 

Job_ProfileReferenceEnumeration

part of: Job_ProfileObjectID
Base Type
string
top
 

LocationReferenceEnumeration

part of: LocationObjectID
Base Type
string
top
 

Worker_TypeReferenceEnumeration

part of: Worker_TypeObjectID
Base Type
string
top
 

Position_Time_TypeReferenceEnumeration

part of: Position_Time_TypeObjectID
Base Type
string
top
 

Position_Worker_TypeReferenceEnumeration

part of: Position_Worker_TypeObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top