Service Directory > v32.1 > Integrations > Put_Integration_Event
 

Operation: Put_Integration_Event

This operation will create and/or update data related to an Integration Event. Data included will be Integration System, Launch datetime, Triggering User, Status and Runtime Parameters.


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

Integration event request element.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Integration_Event_Reference  Integration_ESB_Invocation__Abstract_Object  [0..1]  Reference element representing a unique instance of Integration Event.   
Integration_Event_Data  Integration_Event_Data_WWS  [1..1]  Integration Event Data   
top
 

Response Element: Put_Integration_Event_Response

Integration Event response element.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Integration_Event_Reference  Integration_ESB_Invocation__Abstract_Object  [0..1]  Reference element representing a unique instance of Integration Event.   
top
 

Integration_ESB_Invocation__Abstract_Object

part of: Put_Integration_Event_Request, Put_Integration_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  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_Event_Data_WWS

part of: Put_Integration_Event_Request
Encapsulating element containing all Integration Event data.
 
Parameter name Type/Value Cardinality Description Validations
Integration_System_Reference  Integration_SystemObject  [0..1]  Reference element representing a unique instance of Integration System. 
Validation Description
Integration Event must be valid for Integration System if both are provided.  Integration Event must be valid for Integration System if both are provided. 
Integration System is required when creating an instance of Integration Event.  Integration System is required when creating an instance of Integration Event. 
 
Process_Description  string  [0..1]  Text attribute identifying the Summary of the Integration Event. 
Validation Description
Process Description is required when creating an instance of Integration Event.  Process Description is required when creating an instance of Integration Event. 
 
Initiated_DateTime  dateTime  [0..1]  A date/time representing the moment the Integration Event was Initiated (e.g. Launched).   
Integration_Response_Message  string  [0..1]  Text attribute identifying the most recent message associated with the Integration Event.   
Completed_DateTime  dateTime  [0..1]  A date/time representing the moment that the Integration Event completed.   
Integration_Event_Member_Reference  IntegratableObject  [0..*]  A unique reference for each member of this Integration Event. This can be a valid instance for any subclass of Integratable (e.g. Employee, Organization, etc.). Note that the references listed here will replace those already persisted on the Integration Event.   
Initiated_By_System_Account_Reference  System_UserObject  [0..1]  System Account Reference for the User that Initiated the process.   
Percent_Complete  decimal (7, 4) >0   [0..1]  Only use for Integrations that allow for a manual update of Percent Complete. 
Validation Description
Percent Complete is only allowed to be updated through a web service request when the corresponding Integration Template allows for this.  Percent Complete is only allowed to be updated through a web service request when the corresponding Integration Template allows for this. 
% Complete cannot be greater than 100%.  % Complete cannot be greater than 100%. 
 
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   
Integration_Enterprise_Event_Records_Data  Integration_Enterprise_Event_Records_Data  [0..*]  Integration Enterprise Event Records Data   
top
 

Integration_SystemObject

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

IntegratableObject

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

IntegratableObjectID

part of: IntegratableObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Additional_Benefits_Plan_ID, Applicant_ID, Beneficiary_ID, Business_Entity_Contact_ID, Company_Reference_ID, Contingent_Worker_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Customer_Invoice_Reference_ID, Defined_Contribution_Plan_ID, Dependent_ID, Document_Number, Emergency_Contact_ID, Employee_ID, Expense_Report_Reference_ID, Health_Care_Coverage_Plan_ID, Health_Savings_Account_Plan_ID, Insurance_Coverage_Plan_ID, Job_Application_ID, Job_Profile_ID, Location_ID, Organization_Reference_ID, Position_ID, Purchase_Order_Reference_ID, Recruiting_Prospect_ID, Region_Reference_ID, Spending_Account_Plan_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
 

System_UserObject

part of: Integration_Event_Data_WWS
 
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_Runtime_Parameter_Data

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

Integration_Enterprise_Event_Records_Data

part of: Integration_Event_Data_WWS
Element containing records counts for the Integration Enterprise Event
 
Parameter name Type/Value Cardinality Description Validations
Total_Records  decimal (6, 0) >0   [0..1]  Total Records   
Total_Records_Uploaded  decimal (6, 0) >0   [0..1]  Total Records Uploaded   
Total_Failed_Records  decimal (6, 0) >0   [0..1]  Total Failed Records   
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
 

IntegratableReferenceEnumeration

part of: IntegratableObjectID
Base Type
string
top
 

System_UserReferenceEnumeration

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