Service Directory > v31.2 > External_Integrations > Receive_Launch_Integration_Event
 

Operation: Receive_Launch_Integration_Event

Receives launched Integration Event data from Workday


@ - A parameter name with this symbol denotes an XML attribute within the document instead of an XML element.


Contents

 

Web Service

 

Request

 

Element(s)

 

Request Element: Launch_Integration_Event_Data

 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@WIN_Integration  boolean  [1..1]  WIN Integration that runs on the Cloud ESB server   
Integration_Event_Reference  Integration_ESB_Invocation__Abstract_Object  [0..1]  Integration Event Reference   
Integration_System_Reference  Integration_SystemObject  [0..1]  Integration System Reference   
Document_ID  string  [0..1]  Document ID (Entry ID) from Repository Document   
Event_Initialization_Document_ID  string  [0..1]  Document ID (Entry ID) for Repository Document representing Event Initialization   
Integration_Template_Reference  Integration_TemplateObject  [0..1]  Integration Template Reference   
Sent_On  dateTime  [0..1]  Sent On   
System_User_Reference  System_UserObject  [0..1]  System User Reference   
Resend_from_Integration_Event_Reference  Integration_Event__Abstract_Object  [0..1]  Resend from Integration Event Reference   
Integration_Runtime_Parameter_Data  Integration_Runtime_Parameter_Data  [0..*]  Integration Runtime Parameter Data   
Integration_Service_Generated_Sequence_Data  Integration_Service_Generated_Sequence_Data  [0..*]  Integration Service Generated Sequence Data   
Parent_Event_Reference  EventObject  [0..1]  This Integration Event is part of a parent Business Process event.   
top
 

Launch_Integration_Event_Data

Launch Integration Event Data
 
Parameter name Type/Value Cardinality Description Validations
@WIN_Integration  boolean  [1..1]  WIN Integration that runs on the Cloud ESB server   
Integration_Event_Reference  Integration_ESB_Invocation__Abstract_Object  [0..1]  Integration Event Reference   
Integration_System_Reference  Integration_SystemObject  [0..1]  Integration System Reference   
Document_ID  string  [0..1]  Document ID (Entry ID) from Repository Document   
Event_Initialization_Document_ID  string  [0..1]  Document ID (Entry ID) for Repository Document representing Event Initialization   
Integration_Template_Reference  Integration_TemplateObject  [0..1]  Integration Template Reference   
Sent_On  dateTime  [0..1]  Sent On   
System_User_Reference  System_UserObject  [0..1]  System User Reference   
Resend_from_Integration_Event_Reference  Integration_Event__Abstract_Object  [0..1]  Resend from Integration Event Reference   
Integration_Runtime_Parameter_Data  Integration_Runtime_Parameter_Data  [0..*]  Integration Runtime Parameter Data   
Integration_Service_Generated_Sequence_Data  Integration_Service_Generated_Sequence_Data  [0..*]  Integration Service Generated Sequence Data   
Parent_Event_Reference  EventObject  [0..1]  This Integration Event is part of a parent Business Process event.   
top
 

Integration_ESB_Invocation__Abstract_Object

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

Integration_ESB_Invocation__Abstract_ObjectID

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

Integration_SystemObject

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

Integration_SystemObjectID

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

Integration_TemplateObject

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

Integration_TemplateObjectID

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

System_UserObject

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

System_UserObjectID

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

Integration_Event__Abstract_Object

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

Integration_Event__Abstract_ObjectID

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

Integration_Runtime_Parameter_Data

part of: Launch_Integration_Event_Data
Integration Runtime Parameter Data
 
Parameter name Type/Value Cardinality Description Validations
Launch_Configurable_Name  string  [0..1]  Launch Configurable Name   
Parameter_Name  Simple_Work_Data_Runtime_Parameter_Name  [0..*]  Parameter Name   
Text  Text_Attribute  [0..*]  Text   
Date  dateTime  [0..1]  Date   
Boolean  boolean  [0..1]  Boolean   
Instance_Set_Reference  InstanceObject  [0..*]  Instance Set Reference   
top
 

Simple_Work_Data_Runtime_Parameter_Name

part of: Integration_Runtime_Parameter_Data
Parameter Name
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@Label  string  [1..1]  Label   
top
 

Text_Attribute

part of: Integration_Runtime_Parameter_Data
Text
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@Sensitive  boolean  [1..1]  Sensitive   
top
 

InstanceObject

part of: Integration_Runtime_Parameter_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]     
ID  Instance_ID  [0..*]     
top
 

Instance_ID

part of: InstanceObject
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@parent_id  string  [1..1]     
@parent_type  string  [1..1]     
@type  string  [1..1]     
top
 

Integration_Service_Generated_Sequence_Data

part of: Launch_Integration_Event_Data
Integration Service Generated Sequence Data
 
Parameter name Type/Value Cardinality Description Validations
Integration_Service_Reference  Integration_Sequence_Generator_ServiceObject  [0..1]  Integration Service Reference   
Integration_Sequencer_Generated_Sequence_Data  Integration_Sequencer_Generated_Sequence_Data  [0..*]  Integration Sequencer Generated Sequence Data   
top
 

Integration_Sequence_Generator_ServiceObject

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

Integration_Sequence_Generator_ServiceObjectID

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

Integration_Sequencer_Generated_Sequence_Data

part of: Integration_Service_Generated_Sequence_Data
Integration Sequencer Generated Sequence Data
 
Parameter name Type/Value Cardinality Description Validations
Integration_Sequencer_Reference  Integration_SequencerObject  [0..1]  Integration Sequencer Reference   
Sequenced_Value  string  [0..1]  Sequenced Value   
top
 

Integration_SequencerObject

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

Integration_SequencerObjectID

part of: Integration_SequencerObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Integration_Sequencer_Name, Workday_Integration_Sequencer_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_Service_Name, Workday_Integration_Service_Name  [1..1]  The unique identifier type of a parent object   
top
 

EventObject

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

EventObjectID

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

Integration_ESB_Invocation__Abstract_ReferenceEnumeration

part of: Integration_ESB_Invocation__Abstract_ObjectID
Base Type
string
top
 

Integration_SystemReferenceEnumeration

part of: Integration_SystemObjectID
Base Type
string
top
 

Integration_TemplateReferenceEnumeration

part of: Integration_TemplateObjectID
Base Type
string
top
 

System_UserReferenceEnumeration

part of: System_UserObjectID
Base Type
string
top
 

Integration_Event__Abstract_ReferenceEnumeration

part of: Integration_Event__Abstract_ObjectID
Base Type
string
top
 

Integration_Sequence_Generator_ServiceReferenceEnumeration

part of: Integration_Sequence_Generator_ServiceObjectID
Base Type
string
top
 

Integration_SequencerReferenceEnumeration

part of: Integration_SequencerObjectID
Base Type
string
top
 

Base Type
string

top
 

EventReferenceEnumeration

part of: EventObjectID
Base Type
string
top