Service Directory > v32.1 > Human_Resources > Manage_Employee_Probation_Periods_Event
 

Operation: Manage_Employee_Probation_Periods_Event

Creates or Updates Probation Periods for a Worker.


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

Probation Period Request Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Business_Process_Parameters  Business_Process_Parameters  [0..1]  Business Process Parameters   
Manage_Employee_Probation_Periods_Event_Data  Manage_Employee_Probation_Periods_Event_Data  [0..*]  Details of the Probation Period that is being added to the Worker   
top
 

Response Element: Manage_Employee_Probation_Periods_Event_Response

Manage Employee Probation Period Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Employee_Probation_Period_Event_Reference  Unique_IdentifierObject  [0..1]  The Probation Period Event that is created for the Woker   
top
 

Business_Process_Parameters

part of: Manage_Employee_Probation_Periods_Event_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. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.
 
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, Manage_Employee_Probation_Periods_Event_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
 

Manage_Employee_Probation_Periods_Event_Data

part of: Manage_Employee_Probation_Periods_Event_Request
Details of the Probation Period being added to the Worker
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [0..1]  Employee for the probation period 
Validation Description
Either the Worker or the Position is required in the Manage Probation Period Event Request.   
 
Position_Reference  Position_ElementObject  [0..1]  Position for which the Probation Period is being added / modified 
Validation Description
Position must be submitted. If you submitted only a Worker reference, then this worker has more than one position you have access to. If you submitted a Position Management Position ID, and more than one worker is filling that position (it has been overlapped) - please submit the worker reference as well so we can identify which worker to process.   
Position is not valid for this Worker as of the effective date. Worker: [worker] Position: [position] Date: [date]   
Position submitted is not filled as of the effective date.   
 
Probation_Period_Reference  Employee_Probation_PeriodObject  [0..1]  Probation Period that needs to be updated 
Validation Description
Probation Period is not valid for the Worker.   
You can't edit an extended probation period. Correct or extend the probation period instead.   
 
Start_Date  date  [1..1]  Probation Period Start Date 
Validation Description
Enter a Start Date that is on or between the Worker's relevant Hire Date and Termination Date.   
You can't change the start date or the end date when you are extending the probation period. Change the extended end date instead.   
 
End_Date  date  [0..1]  Probation Period End Date 
Validation Description
The Probation Start Date and End Date range overlaps with another probation period. Change the dates so that the ranges do not overlap.   
The Probation End Date overlaps with another employment period. Change the Probation End Date so it doesn't overlap with the employment period date range.   
You can't change the start date or the end date when you are extending the probation period. Change the extended end date instead.   
Enter a Probation Period End Date that is not before the Start Date   
 
Probation_Type_Reference  Employee_Probation_Period_TypeObject  [0..1]  Probation Period Type 
Validation Description
Probation Period Type may not be valid for the Country of the Worker's Position or may be Inactive   
You can't change the probation period type when you are extending the probation period.   
 
Derive_Probation_Period_from_Rule  boolean  [0..1]  Specifies if Workday derives the default probation period from the worker's probation period rule. If a probation period rule applies, any values in End Date or Length will not apply. 
Validation Description
The Probation Periods localization isn't active for [country]. Activate the Probation Periods localization in the Maintain Localization Settings task for [country] to enable probation period rules.   
There is no probation period rule that applies to [worker].   
You can't derive a probation period extension from probation period rules. Enter either an Extended End Date or a Duration and Unit instead.   
 
Length  Probation_Period_Length_Data  [0..1]  Probation Period Length   
Extended_Length  Probation_Period_Extended_Length_Data  [0..1]  Probation Period Extended Length   
Probation_Reason_Reference  Employee_Probation_Period_ReasonObject  [0..1]  Probation Period Reason 
Validation Description
Probation Period Reason may not be valid for the Country of the Worker's Position or may be Inactive or Probation Reason is not a Manager Reason if Processing User is Manager.   
The probation period reason doesn't apply to this probation period action in the Maintain Employee Probation Period Reasons task.   
 
Extended_End_Date  date  [0..1]  Extended End Date of the Probation Period 
Validation Description
The Probation Start Date and Extended End Date range overlaps with another probation period. Change the dates so that the ranges do not overlap.   
Enter an Extended End Date that is after the End Date.   
Extended End Date cannot be entered without an End Date   
The Probation Extended End Date overlaps with another employment period. Change the Probation Extended End Date so it doesn't overlap with the employment period date range.   
You can't add an Extended End Date because you're adding a probation period and the Probation Periods localization is active for [country]. Extend the probation period after you add the probation period.   
 
Probation_Review  Probation_Review_Data  [0..1]  Details of Probation Period Review 
Validation Description
The Probation Period: Review localization isn't active for [country]. Activate the Probation Period: Review and the Probation Periods localized fields in the Maintain Localization Settings task for [country] to enable Probation Review Date.  Probation Period Review localization error message 
 
Note  string  [0..1]  Comments / Note   
top
 

Position_ElementObject

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

Position_ElementObjectID

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

Employee_Probation_PeriodObject

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

Employee_Probation_PeriodObjectID

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

Employee_Probation_Period_TypeObject

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

Employee_Probation_Period_TypeObjectID

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

Probation_Period_Length_Data

part of: Manage_Employee_Probation_Periods_Event_Data
Probation Period Length
 
Parameter name Type/Value Cardinality Description Validations
Duration  decimal (20, 0) >0   [1..1]  Duration 
Validation Description
You can't change the start date or the end date when you are extending the probation period. Change the extended end date instead.   
The Probation Periods localization isn't active for [country]. Activate the Probation Periods localization in the Maintain Localization Settings task for [country] to enable probation period rules.   
 
Unit_Reference  Date_And_Time_UnitObject  [1..1]  Unit 
Validation Description
You can't change the start date or the end date when you are extending the probation period. Change the extended end date instead.   
The Probation Periods localization isn't active for [country]. Activate the Probation Periods localization in the Maintain Localization Settings task for [country] to enable probation period rules.   
 
top
 

Date_And_Time_UnitObject

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

Date_And_Time_UnitObjectID

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

Probation_Period_Extended_Length_Data

part of: Manage_Employee_Probation_Periods_Event_Data
Probation Period Extended Length
 
Parameter name Type/Value Cardinality Description Validations
Duration  decimal (20, 0) >0   [1..1]  Duration   
Unit_Reference  Date_And_Time_UnitObject  [1..1]  Unit   
top
 

Employee_Probation_Period_ReasonObject

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

Employee_Probation_Period_ReasonObjectID

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

Probation_Review_Data

part of: Manage_Employee_Probation_Periods_Event_Data
Details of Probation Period Review
 
Parameter name Type/Value Cardinality Description Validations
Probation_Review_Date  date  [0..1]  Review Date of Probation Period 
Validation Description
Enter a Probation Review Date that's on or before the Extended End Date.   
Enter a Probation Review Date that's on or before the Probation End Date.   
 
Validation Description
The Probation Period: Review localization isn't active for [country]. Activate the Probation Period: Review and the Probation Periods localized fields in the Maintain Localization Settings task for [country] to enable Probation Review Date.  Probation Period Review localization error message 
top
 

Unique_IdentifierObject

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

Position_ElementReferenceEnumeration

part of: Position_ElementObjectID
Base Type
string
top
 

Employee_Probation_PeriodReferenceEnumeration

part of: Employee_Probation_PeriodObjectID
Base Type
string
top
 

Employee_Probation_Period_TypeReferenceEnumeration

part of: Employee_Probation_Period_TypeObjectID
Base Type
string
top
 

Date_And_Time_UnitReferenceEnumeration

part of: Date_And_Time_UnitObjectID
Base Type
string
top
 

Employee_Probation_Period_ReasonReferenceEnumeration

part of: Employee_Probation_Period_ReasonObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top