Service Directory > v32.1 > Integrations > Launch_EIB
 

Operation: Launch_EIB

This operation will Launch an EIB Integration. The request has the ability to accept override Runtime Parameters that should be used within the integration processing. If no override is provided within the request, the System Default, which has been defined on the EIB Definition, will be used. The result of this operation will be the creation of an Integration Event along with the processing of the integration itself.


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

Launch EIB Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Integration_System_Reference  Integration_System__Audited_Object  [1..1]  EIB Definition   
Service_Component_Data  Integration_Service_Component_Override_Data  [0..*]  Integration Service Component Override Data element   
Validation Description
The current System User does not have access to Launch this Integration System.  The current System User should have access to Launch the EIB Integration System. If there are any Report Data Sources and/or Web Service Transports within the EIB definition, then the System User needs security access to those as well. 
top
 

Response Element: Launch_EIB_Response

Launch EIB Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Application_Instance_Exceptions  Application_Instance_Exceptions_Data  [0..*]  Element containing application related exceptions data   
Integration_Event  Integration_Event  [0..1]  Integration Event   
top
 

Integration_System__Audited_Object

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

Integration_System__Audited_ObjectID

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

part of: Launch_EIB_Request
Integration Service Component Override Data element
 
Parameter name Type/Value Cardinality Description Validations
Data_Source [Choice]   boolean  [1..1]  If the Override Fields below pertain to the EIB's Data Source, mark this boolean TRUE.   
Transformation [Choice]   boolean  [1..1]  If the Override Fields below pertain to the EIB's Transformation, mark this boolean TRUE.   
File_Utility [Choice]   boolean  [1..1]  If the Override Fields below pertain to the EIB's File Utility (e.g. transport Payload), mark this boolean TRUE.   
Transport_Protocol [Choice]   boolean  [1..1]  If the Override Fields below pertain to the EIB's Transport Protocol, mark this boolean TRUE.   
Field_Override_Data  Integration_Service_Component_Field_Override_Data  [1..*]  Service Component Field Override Data element 
Validation Description
Use the Next Sequence for Integration File Utility field for File Name when launching or scheduling the EIB.   
 
top
 

Integration_Service_Component_Field_Override_Data

part of: Integration_Service_Component_Override_Data
Service Component Field Override Data element
 
Parameter name Type/Value Cardinality Description Validations
Field_Name  string  [1..1]  The Name of the Field for corresponding Service Component. This will be a unique identifier for looking up the appropriate Field. 
Validation Description
The Field Name "[field]" is not valid for [int system] and this section of the Launch EIB request. Valid Fields for [section] section are: [field labels]  Field Name must be valid for EIB and this section (e.g. Data Source, Transformation, File Utility, Transport Protocol) of the Launch EIB request. 
The Override Field "[field]", whose return type is "[work data att][work data inst][enum class]", expects the appropriate attribute/instance element to be populated within the Field Override Data subelement.  The Override Field expects the appropriate attribute/instance element to be populated within the Field Override Data subelement. 
Attachment Data subelement is only allowed within the request when the Override Field accepts an Integration Attachment (e.g. within a Data Source service component).  Attachment Data subelement is only allowed within the request when the Override Field accepts an Integration Attachment (e.g. within a Data Source service component). 
The Override Field "[field]", whose return type is "[work data att][work data inst]", expects the appropriate return type from the External Field Reference. The External Field "[ext field]" returns a data type of "[ext field data type att][ext field data type inst]" instead.  External Field reference must return a data type that is comparable to the Override Field's data type. 
The External Field reference "[ext field]" is valid for the "[bus object]" business object. It must be executable off of the Integration System business object, or it must be a Global, static field. Also, it must be accessible by the processing user.  External Field reference must be executable off of the Integration System business object, or it must be a Global, static field. Also, it must be accessible by the processing user. 
 
Specify_Value_Data [Choice]   Integration_Abstract_Value_Data  [1..1]  To specify a specific value, populate this element.   
Attachment_Data [Choice]   Integration_Attachment_Data  [1..1]  To create and assign an Attachment to the Field, populate this element.   
External_Field_Reference [Choice]   External_FieldObject  [1..1]  To determine a value using an External Field, populate this element.   
Validation Description
Use the Next Sequence for Integration File Utility field for File Name when launching or scheduling the EIB.   
top
 

Integration_Abstract_Value_Data

part of: Integration_Service_Component_Field_Override_Data
Container element for an Abstract Value.
 
Parameter name Type/Value Cardinality Description Validations
Text  string  [0..1]  Text   
Date  date  [0..1]  Date   
DateTime  dateTime  [0..1]  DateTime   
Numeric  decimal (26, 6)   [0..1]  Numeric   
Boolean  boolean  [0..1]  Boolean   
Instance_Reference  InstanceObject  [0..*]  Instance Reference   
top
 

InstanceObject

part of: Integration_Repository_Document_Data, Integration_Runtime_Parameter_Data, Integration_Abstract_Value_Data, Integration_Message_Detail_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_Attachment_Data

part of: Integration_Service_Component_Field_Override_Data
Encapsulating element containing all Integration Attachment data.
 
Parameter name Type/Value Cardinality Description Validations
@Content_Type  string (80)   [1..1]  Text attribute identifying Content Type of the Attachment.   
@Filename  string (255)   [1..1]  Text attribute identifying Filename of the Attachment.   
@Encoding  string  [1..1]  Text attribute identifying Encoding of the Attachment.   
@Compressed  boolean  [1..1]  Boolean attribute identifying whether the Attachment is compressed.   
File_ID  string  [0..1]  Text attribute identifying a unique ID for Attachment.   
File_Content  base64Binary  [0..1]  File content in binary format.   
Content_Type_Reference  Mime_TypeObject  [0..1]  Reference element identifying a unique instance of Content Type of the Attachment.   
Comments  string  [0..1]  Comment   
top
 

Mime_TypeObject

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

Mime_TypeObjectID

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

External_FieldObject

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

External_FieldObjectID

part of: External_FieldObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Calculated_Field_ID, Computed_Data_Source_Field_ID, Custom_Field_Data_Set_ID, Extension_Computed_Data_Field_Reference_ID, External_Analytics_Data_Source_Field_ID, WCP_Component_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
 

Application_Instance_Exceptions_Data

part of: Launch_EIB_Response
Element containing application related exceptions data
 
Parameter name Type/Value Cardinality Description Validations
Exception_Data  Exception_Data  [0..*]  Exception Data   
top
 

Exception_Data

part of: Application_Instance_Exceptions_Data
Exception (Errors and Warning) associated with the transaction.
 
Parameter name Type/Value Cardinality Description Validations
Classification  string  [0..1]  Exception Classification (Error or Warning)   
Message  string  [0..1]  Exception Detail   
top
 

Integration_Event

part of: Launch_EIB_Response
Integration Event
 
Parameter name Type/Value Cardinality Description Validations
Integration_Event_Reference  Integration_ESB_Invocation__Abstract_Object  [0..1]  Integration Event Reference   
Integration_Event_Data  Integration_Event_Data_WWS  [0..1]  Integration Event Data   
Background_Process_Instance_Data  Integration_Event_Reporting_Details_Data  [0..1]  Element for derived information regarding a Background Process Instance   
top
 

Integration_ESB_Invocation__Abstract_Object

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

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_Event_Reporting_Details_Data

part of: Integration_Event
Element for derived information regarding a Background Process Instance
 
Parameter name Type/Value Cardinality Description Validations
Background_Process_Instance_Status_Reference  Background_Process_Runtime_StatusObject  [0..1]  Background Process Instance Status   
Parent_Event_Reference  EventObject  [0..1]  This Integration Event is part of a parent Business Process event.   
Background_Process_Message_Data  Integration_Message_Detail_Data  [0..*]  Element for Messages related to Background Process Instances   
Output_Document_Data  Integration_Repository_Document  [0..*]  Integration Repository Document   
Consolidated_Report_Reference  Repository_DocumentObject  [0..1]  Consolidated Report from ESB Server   
Log_File_Reference  Repository_DocumentObject  [0..*]  Log File from ESB Server   
top
 

Background_Process_Runtime_StatusObject

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

Background_Process_Runtime_StatusObjectID

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

EventObject

part of: Integration_Event_Reporting_Details_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, Assign_Pay_Group_Event_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, Quick_Issue_Reference_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_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_Message_Detail_Data

part of: Integration_Event_Reporting_Details_Data
Element for Messages related to Background Process Instances
 
Parameter name Type/Value Cardinality Description Validations
Timestamp  dateTime  [0..1]  Timestamp of Message   
Severity_Level_Reference  Background_Process_Message_Severity_LevelObject  [0..1]  Reference element representing a unique instance of Integration Message Severity Level.   
Message_Summary  string  [0..1]  Text attribute identifying the Summary of the Integration Message.   
Message_Detail  RichText  [0..1]  Text attribute identifying the Detail of the Integration Message.   
Message_Target_Reference  InstanceObject  [0..*]  A Reference to an instance within the Workday system that is related to this message.   
top
 

Background_Process_Message_Severity_LevelObject

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

Background_Process_Message_Severity_LevelObjectID

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

part of: Integration_Event_Reporting_Details_Data
Integration Repository Document
 
Parameter name Type/Value Cardinality Description Validations
Integration_Repository_Document_Reference  Integration_Repository_DocumentObject  [0..1]  Integration Repository Document Reference   
Integration_Repository_Document_Data  Integration_Repository_Document_Data  [0..1]  Encapsulating element containing all Integration Repository Document data.   
top
 

Integration_Repository_DocumentObject

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

Integration_Repository_DocumentObjectID

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

part of: Integration_Repository_Document
Encapsulating element containing all Integration Repository Document data.
 
Parameter name Type/Value Cardinality Description Validations
@Document_ID  string (513)   [1..1]  A unique ID for Repository document.   
@File_Name  string  [1..1]  Text attribute for Repository document.   
File_Size  decimal (12, 0) >0   [0..1]  Numeric attribute representing the Size (in Bytes) of the Repository document.   
Content_Type_Reference [Choice]   Mime_TypeObject  [0..1]  Reference element identifying a unique instance of Content Type of the Attachment.   
Content_Type [Choice]   string (80)   [0..1]  The Content Type of the document. Valid values defined in RFC 822, including type, subtype, and parameter.   
Document_Type_Reference  Document_TypeObject  [0..1]  Reference element identifying a unique instance of Document Type of the Repository document.   
Expiration_Timestamp  dateTime  [1..1]  DateTime attribute representing the Expiration Timestamp of the Repository document.   
Owner_Reference  System_AccountObject  [0..1]  Unique identifier for a System User reference   
Document_Tag_Reference  Document_TagObject  [0..*]  Document Tag(s) associated with Repository Document   
Custom_Document_Tag  string  [0..*]  Custom Document Tag   
Secured_Instance_Reference  InstanceObject  [0..*]  For Documents attached to an Integration Template utilizing Document Security, this Instance Reference identifies the secured instace(s) to be evaluated against the Document Security task.   
top
 

Document_TypeObject

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

Document_TypeObjectID

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

System_AccountObject

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

System_AccountObjectID

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

Document_TagObject

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

Document_TagObjectID

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

Repository_DocumentObject

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

Repository_DocumentObjectID

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

part of: Integration_System__Audited_ObjectID
Base Type
string
top
 

Mime_TypeReferenceEnumeration

part of: Mime_TypeObjectID
Base Type
string
top
 

External_FieldReferenceEnumeration

part of: External_FieldObjectID
Base Type
string
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
 

Background_Process_Runtime_StatusReferenceEnumeration

part of: Background_Process_Runtime_StatusObjectID
Base Type
string
top
 

EventReferenceEnumeration

part of: EventObjectID
Base Type
string
top
 

Background_Process_Message_Severity_LevelReferenceEnumeration

part of: Background_Process_Message_Severity_LevelObjectID
Base Type
string
top
 

RichText

part of: Integration_Message_Detail_Data
Base Type
string
top
 

Integration_Repository_DocumentReferenceEnumeration

part of: Integration_Repository_DocumentObjectID
Base Type
string
top
 

Document_TypeReferenceEnumeration

part of: Document_TypeObjectID
Base Type
string
top
 

System_AccountReferenceEnumeration

part of: System_AccountObjectID
Base Type
string
top
 

Document_TagReferenceEnumeration

part of: Document_TagObjectID
Base Type
string
top
 

Repository_DocumentReferenceEnumeration

part of: Repository_DocumentObjectID
Base Type
string
top