Service Directory > v31.2 > Integrations > Cancel_Business_Process
 

Operation: Cancel_Business_Process

This operation cancels a business process, if cancelable, by the user


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

Cancel Business Process Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Event_Reference  Action_EventObject  [1..1]  Event Reference 
Validation Description
Business Process cannot be canceled via Web Service.  The provided event cannot be canceled via Web Service. 
Business Process awaiting participation step cannot be canceled via Web Service, use Mass Cancel Business Processes task or Cancel related action off of the Event.   
 
Cancel_Business_Process_Data  Cancel_Business_Process_Data  [0..1]  Cancel Business Process Data 
Validation Description
The field Comment is required and must have a value.   
 
top
 

Response Element: Cancel_Business_Process_Response

Cancel Business Process Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Event_Reference  Action_EventObject  [0..1]  Event Reference   
top
 

Action_EventObject

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

Action_EventObjectID

part of: Action_EventObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Absence_Case_ID, Assignable_Payroll_ID, Background_Check_ID, Background_Process_Instance_ID, Backorder_Event_ID, Budget_Amendment_ID, Change_Order_Reference_ID, Compensation_Review_Event_ID, Customer_Request_ID, Customer_Request_Reference_ID, Eligibility_Override_Event_ID, Employee_Review_ID, Employee_Severance_Worksheet_Event_ID, Goods_Delivery_Group_ID, Goods_Delivery_Run_ID, Historical_Student_Charge_ID, Invite_Committee_Candidate_Event_ID, IRS_1099_MISC_Adjustment_ID, Mass_Change_Requisition_Requester_ID, Medicare_Information_Event_ID, Position_Budget_Group_ID, Procurement_Mass_Close_ID, Procurement_Mass_ReOpen_ID, Procurement_Roll_Forward_ID, Receipt_Number, Request_Leave_of_Absence_ID, Requisition_Sourcing_Event_ID, Spend_Authorization_ID, Spend_Authorization_Mass_Close_ID, Student_Charge_Adjustment_ID, Student_Charge_Document_ID, Student_Charge_ID, Student_Dismissal_Event_ID, Student_Employment_Eligibility_Event_ID, Student_Hold_Assignment_Override_Event_ID, Student_Institutional_Withdrawal_Event_ID, Student_Leave_of_Absence_Event_ID, Supplier_Contract_Amendment_ID, Supplier_Contract_History_ID, Supplier_Contract_ID, Supplier_Invoice_Contract_ID, Workday_Project_ID, Worker_Time_Card_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
 

Cancel_Business_Process_Data

part of: Cancel_Business_Process_Request
Provide additional details for the Business Process cancelation.
 
Parameter name Type/Value Cardinality Description Validations
Comment  string  [0..1]  Comment   
Suppress_Notifications  boolean  [0..1]  Suppress Notifications   
Validation Description
The field Comment is required and must have a value.   
top
 

Action_EventReferenceEnumeration

part of: Action_EventObjectID
Base Type
string
top