Service Directory > v31.2 > Absence_Management > Adjust_Time_Off
 

Operation: Adjust_Time_Off

This operation will adjust an existing time off entry. The adjusted units must be passed in (and not the corrected units). This operation uses the Correct Time Off business process event.


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

The purpose of this spreadsheet is to provide a facility to upload data from Microsoft Excel into your Workday system. By performing this upload process, the customer acknowledges that they have already performed the required business process tasks and approvals to confirm the worker's new data values. This spreadsheet contains a worksheet for Correct Time Off business process. Fill out this worksheet with the data to match your business processes. It is understood that different supervisory organizations may have a different business processes and therefore not every worker will necessarily go through all the optional related processes. When doing the Correct Time Off business process via the user interface, you enter the 'correction' to requested units (example - if original request was for 8 hours and it should have been 6, you would enter 6 as entering 'corrected' units). However, when using this spreadsheet you need to enter the 'adjustment' to the requested units (example - you would enter -2 as 'adjustment' to requested units).
 
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. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.   
Adjust_Time_Off_Data  Adjust_Time_Off_Data  [1..1]  Contains adjustment data for the Adjust Time Off business process 
Validation Description
[unpaid critical error]   
 
top
 

Response Element: Time_Off_Event_Response

Root Response Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Time_Off_Event_Reference  Unique_IdentifierObject  [0..1]  A reference to an existing Time Off Event in the system   
Time_Off_Entry_References  Time_Off_Entry_References  [0..*]  A list of references to Time Off Entries in the system   
top
 

Business_Process_Parameters

part of: Adjust_Time_Off_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, Adjust_Time_Off_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
 

Adjust_Time_Off_Data

part of: Adjust_Time_Off_Request
Contains adjustment data for the Adjust Time Off business process
 
Parameter name Type/Value Cardinality Description Validations
Run_Time_Off_Validations  boolean  [0..1]  Turn on this flag if you want to validate Time Off Entries for this Time Off Request. If this flag is turned on and any Time Off Entries fail validation for a Time Off Request, the entire Time Off Request will be rejected.   
Worker_Reference  WorkerObject  [1..1]  Reference to an existing Worker   
Adjust_Time_Off_Entry_Data  Adjust_Time_Off_Entry_Data  [1..*]  Contains the detailed time off entry data 
Validation Description
The Time Off Entry you are trying to adjust has already been corrected. Please use the corrected entry to make further adjustments.  The Time Off Entry you are trying to adjust has already been corrected. Please use the corrected entry to make further adjustments. 
Corrections cannot be made to system generated Time Off Entries. You must correct the entered Time Off Entry that is associated with the system generated entry.  Corrections cannot be made to system generated Time Off Entries. You must correct the entered Time Off Entry that is associated with the system generated entry. 
[min warning time off error message adjust time off ws]   
[increments warning time off error message adjust time off ws]   
[maximum critical error message]   
You do not have a sufficient balance/or are not eligible to satisfy the request for [type] as of [date]. Other Time Off Adjustments may impact this Adjustment.   
 
Validation Description
[unpaid critical error]   
top
 

Adjust_Time_Off_Entry_Data

part of: Adjust_Time_Off_Data
Contains data for adjusting time off
 
Parameter name Type/Value Cardinality Description Validations
Time_Off_Entry_ID  string  [0..1]  This value can be used to reference this Time Off Entry record in the future. For example, if you need to adjust this Time Off Entry in the future, then this "ID" could be used to reference it. 
Validation Description
Duplicate ID values are not allowed.   
 
Time_Off_Entry_Reference  Time_Off_EntryObject  [1..1]  Reference to an existing Time Off Entry 
Validation Description
The "Time Off Entry Reference" must be for the worker specified in "Worker_Referenceā€   
Time Off Corrections can only be made to "Successfully Completed" Time Off Events.   
 
Adjustment_to_Requested  decimal (9, 6)   [1..1]  The adjustment to units of time requested. Enter a positive number for an increase (e.g. 8) or a negative number for a decrease (e.g. -4). For example, if the original request was 8 but should have been 6, enter a -2. 
Validation Description
Total Time Off for Time Off Entry summing original requested time, previously adjusted time and current adjustment cannot be negative.   
 
Comment  string  [0..1]  Enter a comment for the adjustment.   
Validation Description
The Time Off Entry you are trying to adjust has already been corrected. Please use the corrected entry to make further adjustments.  The Time Off Entry you are trying to adjust has already been corrected. Please use the corrected entry to make further adjustments. 
Corrections cannot be made to system generated Time Off Entries. You must correct the entered Time Off Entry that is associated with the system generated entry.  Corrections cannot be made to system generated Time Off Entries. You must correct the entered Time Off Entry that is associated with the system generated entry. 
[min warning time off error message adjust time off ws]   
[increments warning time off error message adjust time off ws]   
[maximum critical error message]   
You do not have a sufficient balance/or are not eligible to satisfy the request for [type] as of [date]. Other Time Off Adjustments may impact this Adjustment.   
top
 

Time_Off_EntryObject

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

Time_Off_EntryObjectID

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

Time_Off_Entry_References

part of: Time_Off_Event_Response
Time Off Entry References
 
Parameter name Type/Value Cardinality Description Validations
Time_Off_Entry_Reference  Time_Off_EntryObject  [0..*]  A reference to a Time Off Entry   
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Event_Attachment_CategoryReferenceEnumeration

part of: Event_Attachment_CategoryObjectID
Base Type
string
top
 

Time_Off_EntryReferenceEnumeration

part of: Time_Off_EntryObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top