Service Directory > v25.1 > Integrations > Put_Integration_System
 

Operation: Put_Integration_System

This operation will create and/or update data related to an Integration System. Data returned within the response includes Services associated and enabled, Attribute/Map values, Service configurations and Custom Services Attributes, Maps and Launch 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_System_Request

Integration System request element.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only   
Integration_System_Reference  Integration_System__Audited_Object  [0..1]  Integration System Reference   
Integration_System_Data  Integration_System_Data_WWS  [1..1]  Integration System Data 
Validation Description
Only 1 Launch Parameter may be marked with each of the "Date" Options: - As Of Effective Date - As Of Entry DateTime - Begin Effective Date - Begin Entry DateTime   
Custom Launch Parameters may only be added to an Integration System using an Integration Template that allows for the Custom Integration Feature of "Generic Service".  Custom Launch Parameters may only be added to an Integration System using an Integration Template that allows for the Custom Integration Feature of "Generic Service". 
Custom Integration Attributes may only be added to an Integration System using an Integration Template that allows the Custom Integration Feature of "Generic Service".  Custom Integration Attributes may only be added to an Integration System using an Integration Template that allows the Custom Integration Feature of "Generic Service". 
Custom Integration Maps may only be added to an Integration System using an Integration Template that allows the Custom Integration Feature of "Generic Service".  Custom Integration Maps may only be added to an Integration System using an Integration Template that allows the Custom Integration Feature of "Generic Service". 
 
Validation Description
Integration System can not already exist for System ID if the "Add Only" element is true.   
top
 

Response Element: Put_Integration_System_Response

Integration System Response element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Integration_System_Reference  Integration_System__Audited_Object  [0..1]  Integration System Reference   
Exceptions_Response_Data  Application_Instance_Related_Exceptions_Data  [0..*]  Element containing Exceptions Data   
top
 

Integration_System__Audited_Object

part of: Put_Integration_System_Request, Put_Integration_System_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_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_System_Data_WWS

part of: Put_Integration_System_Request
Element containing data for an Integration System, including Template reference, Attributes and Maps.
 
Parameter name Type/Value Cardinality Description Validations
Integration_System_ID  string  [0..1]  Text attribute representing external System ID. 
Validation Description
Enter only uppercase characters, lowercase characters, numbers (0-9), underscores (_), and en dashes (–) for your ID.   
 
Integration_System_Name  string  [0..1]  Text attribute representing external System Name.   
Integration_Template_Reference  Integration_TemplateObject  [0..1]  Reference element representing a unique Integration Template.   
Integration_Service_Data  Integration_Service_Data_WWS  [0..*]  Integration Service Data   
Integration_Attributes_Data  Integration_Tool_Provider_Integration_Attribute_Values_Data_WWS  [0..*]  Integration Attributes Data 
Validation Description
Attribute Provider Reference is required unless adding Attributes for a new Integration System.  Attribute Provider Reference is required unless adding Attributes for a new Integration System. 
 
Integration_Maps_Data  Integration_Tool_Provider_Integration_Map_Values_Data_WWS  [0..*]  Integration Maps Data 
Validation Description
Map Provider Reference is required unless adding Maps for a new Integration System.  Map Provider Reference is required unless adding Maps for a new Integration System. 
 
Custom_Attribute_Data  Integration_Attribute_Data  [0..*]  Custom Attribute Data 
Validation Description
Only Enumeration Definition Is Valid For Multi-Select   
 
Custom_Map_Data  Integration_Map_Data  [0..*]  Custom Map Data   
Custom_Launch_Parameter_Data  Launch_Parameter_Data  [0..*]  Custom Launch Parameter Data   
Integration_Notification_Data  Integration_Notification_Data  [0..*]  Integration Notification Data 
Validation Description
Either Security Group Reference or Notification Email Address must be specified.   
 
Validation Description
Only 1 Launch Parameter may be marked with each of the "Date" Options: - As Of Effective Date - As Of Entry DateTime - Begin Effective Date - Begin Entry DateTime   
Custom Launch Parameters may only be added to an Integration System using an Integration Template that allows for the Custom Integration Feature of "Generic Service".  Custom Launch Parameters may only be added to an Integration System using an Integration Template that allows for the Custom Integration Feature of "Generic Service". 
Custom Integration Attributes may only be added to an Integration System using an Integration Template that allows the Custom Integration Feature of "Generic Service".  Custom Integration Attributes may only be added to an Integration System using an Integration Template that allows the Custom Integration Feature of "Generic Service". 
Custom Integration Maps may only be added to an Integration System using an Integration Template that allows the Custom Integration Feature of "Generic Service".  Custom Integration Maps may only be added to an Integration System using an Integration Template that allows the Custom Integration Feature of "Generic Service". 
top
 

Integration_TemplateObject

part of: Integration_System_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_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
 

Integration_Service_Data_WWS

part of: Integration_System_Data_WWS
Container element for data related to an Integration Service and its use within an Integration System.
 
Parameter name Type/Value Cardinality Description Validations
@WID  string (36)   [1..1]  Workday ID of instance of Integration System Service. Note that this value is ignored on the inbound request.   
@Enabled  boolean  [1..1]  Boolean attribute representing whether the Integration Service is enabled for the Integration System. Only enabled Integration Services are allowed to have values/defaults for Integration Attributes and Maps.   
Integration_Service_Reference  Integration_ServiceObject  [1..1]  Reference element representing an object within the Workday system. The sub-elements and attributes within this element are used to return one and only one instance of the identifying object.   
Integration_Transaction_Log_Service_Data  Integration_Transaction_Log_Configuration_Data  [0..1]  Integration Transaction Log Service Data   
Integration_Sequence_Generator_Service_Data  Integration_Sequence_Generator_Configuration_Data  [0..*]  Integration Sequence Generator Service Data   
Integration_Data_Change_Service_Data  Integration_Data_Change_Configuration_Data  [0..1]  Integration Data Change Service Data   
Integration_Field_Override_Service_Data  Integration_Field_Override_Configuration_Data  [0..1]  Integration Field Override Service Data   
Integration_Data_Initialization_Override_Configuration_Data  Integration_Data_Initialization_Override_Configuration_Data  [0..1]  Integration Data Initialization Override Configuration Data   
Integration_Field_Attributes_Service_Data  Integration_Field_Attributes_Configuration_Data  [0..1]  Integration Field Attributes Service Data   
Integration_Delivery_Configuration_Data  Integration_Delivery_Configuration_Data  [0..1]  Integration Delivery Configuration Data   
Integration_Retrieval_Configuration_Data  Integration_Retrieval_Configuration_Data  [0..1]  Integration Retrieval Configuration Data element   
Integration_Attachment_Service_Data  Integration_Attachment_Configuration_Data  [0..1]  Integration Attachment Configuration Data Element   
Integration_Report_Service_Configuration_Data  Integration_Report_Service_Configuration_Data  [0..1]  Integration Report Service Configuration Data   
Integration_Custom_Object_Configuration_Data  Integration_Custom_Object_Configuration_Data  [0..1]  Integration Custom Object Configuration Data   
Integration_Connector_Configuration_Data  Integration_Connector_Configuration_Data  [0..1]  Connector Configuration   
Integration_Data_Initialization_Service_Data  Integration_Data_Initialization_Configuration_Data  [0..1]  Integration Data Initialization Configuration Data   
top
 

Integration_ServiceObject

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

Integration_ServiceObjectID

part of: Integration_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_Transaction_Log_Configuration_Data

part of: Integration_Service_Data_WWS
Container element for data related to a Transaction Log Service and its use within an Integration System.
 
Parameter name Type/Value Cardinality Description Validations
All_Business_Processes [Choice]   boolean  [1..1]  Subscribe to all Business Processes   
Excluded_Business_Process_Type_Reference [Choice]   Business_Process_TypeObject  [1..*]  Subscribe to all Business Processes except for the specified Business Processes   
All_Transaction_Types [Choice]   boolean  [1..1]  Subscribe to all Transaction Types (e.g. both Business Processes and Event Lites)   
Excluded_Transaction_Log_Type_Reference [Choice]   Transaction_Log_TypeObject  [1..*]  Subscribe to all Transaction Types except for the specified Transaction Types   
Included_Transaction_Log_Type_Reference [Choice]   Transaction_Log_TypeObject  [1..*]  Subscribe to specific Transaction Log Type   
top
 

Business_Process_TypeObject

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

Business_Process_TypeObjectID

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

Transaction_Log_TypeObject

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

Transaction_Log_TypeObjectID

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

part of: Integration_Service_Data_WWS
Container element for data related to a Sequence Generator Service and its use within an Integration System.
 
Parameter name Type/Value Cardinality Description Validations
Integration_Sequencer_Reference  Integration_SequencerObject  [1..1]  Integration Sequencer reference. 
Validation Description
Integration Sequencer ([sequencer]) must be valid for Integration Sequence Generator Service ([service]).  Integration Sequencer must be valid for Integration Sequence Generator Service. 
 
Sequence_Generator_Reference  Sequence_GeneratorObject  [1..1]  Sequence Generator reference.   
top
 

Integration_SequencerObject

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

Sequence_GeneratorObject

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

Sequence_GeneratorObjectID

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

part of: Integration_Service_Data_WWS
Container element for data related to a Data Change Service and its use within an Integration System.
 
Parameter name Type/Value Cardinality Description Validations
External_Field_Reference  External_FieldObject  [0..*]  The External Fields (e.g. Calculated Field or Class Report Field) that are needed to determine if a Data Change has occurred.   
top
 

External_FieldObject

part of: Notification_Message_Component_Data, Integration_Data_Change_Configuration_Data, Launch_Parameter_Data, Launch_Parameter_Default_Data, Integration_Attribute_Data, Integration_Map_Data, Integration_Map_Data, Integration_Field_Override_Field_Configuration_Data, Integration_Notification_Data, Parameter_Initialization_WWS_Data, Notification_Notifies_Data, Notification_Attachment_Data, Extra_Integration_Document_Field_Data, Overridden_Integration_Document_Field_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, Custom_Field_Data_Set_ID, Custom_Field_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_Field_Override_Configuration_Data

part of: Integration_Service_Data_WWS
Integration Field Override Configuration Data
 
Parameter name Type/Value Cardinality Description Validations
Integration_Business_Object_Reference  Unique_IdentifierObject  [0..1]  Integration Business Object Reference for DFO Services   
Integration_Document_Field_Override_Configuration_Data  Integration_Field_Override_Field_Configuration_Data  [1..*]  Integration Document Field Override Configuration Data   
top
 

Unique_IdentifierObject

part of: Integration_Field_Override_Configuration_Data, Integration_Field_Override_Parameter_Initialization_Data, Integration_Custom_Object_Alias_Configuration_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  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
 

Integration_Field_Override_Field_Configuration_Data

part of: Integration_Field_Override_Configuration_Data
Integration Document Field Override Configuration Data
 
Parameter name Type/Value Cardinality Description Validations
Field_Reference  Integration_Document_FieldObject  [1..1]  Document Field Reference   
External_Field_Reference  External_FieldObject  [0..1]  External Field Content   
External_Parameter_Assignment_Data  Integration_Field_Override_Parameter_Initialization_Data  [0..*]  External Parameter Assignment Data 
Validation Description
External Parameter ([parm]) not valid for External Field ([field]). Valid External Parameters for this field are: [valid parms]  External Parameter must be valid for External Field. 
 
Required_Field  boolean  [0..1]  If this field is to be included in the Output document, denotes whether there must be a value supplied for this field. If there is not a value, then error handling should occur. 
Validation Description
Field may only be denoted as "Required" if the Document Field Service allows for this option.  Field may only be denoted as "Required" if the Document Field Service allows for this option. 
 
Maximum_Length  decimal (6, 0) >0   [0..1]  If this field is to be included in the Output document, denotes whether there should be a maximum length enforced for this field. If the value, exceeds the maximum length then special handling should occur. 
Validation Description
Field may only be denoted with a "Maximum Length" if the Document Field Service allows for this option.  Field may only be denoted with a "Maximum Length" if the Document Field Service allows for this option. 
 
top
 

Integration_Document_FieldObject

part of: Integration_Field_Override_Field_Configuration_Data, Integration_Field_Attributes_Field_Configuration_Data, Integration_Report_Field_Configuration_Data, Integration_Custom_Object_Alias_Configuration_Data, Integration_Document_Stacks_for_Integration_Document_Field_Configuration_Data, Overridden_Integration_Document_Field_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_Document_FieldObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Integration_Document_FieldObjectID

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

Integration_Field_Override_Parameter_Initialization_Data

part of: Integration_Field_Override_Field_Configuration_Data, Extra_Integration_Document_Field_Data, Overridden_Integration_Document_Field_Data
For each parameter, assignment details.
 
Parameter name Type/Value Cardinality Description Validations
External_Parameter_Reference  Unique_IdentifierObject  [1..1]  External Parameter Reference   
Parameter_Initialization_Data  Parameter_Initialization_WWS_Data  [1..1]  Parameter Initialization Data   
Validation Description
External Parameter ([parm]) not valid for External Field ([field]). Valid External Parameters for this field are: [valid parms]  External Parameter must be valid for External Field. 
top
 

Parameter_Initialization_WWS_Data

part of: Integration_Field_Override_Parameter_Initialization_Data
Defines the value to be used for parameter assignment.
 
Parameter name Type/Value Cardinality Description Validations
Boolean [Choice]   boolean  [0..1]  Boolean   
Currency [Choice]   decimal (26, 6)   [0..1]  Currency   
Date [Choice]   date  [0..1]  Date   
DateTime [Choice]   dateTime  [0..1]  DateTime   
Numeric [Choice]   decimal (26, 6)   [0..1]  Numeric   
Text [Choice]   string  [0..1]  Text   
Business_Object_Instance_Reference [Choice]   InstanceObject  [0..*]  Business Object Instance Reference   
External_Field_Reference [Choice]   External_FieldObject  [0..1]  If Parameter Initialization Operator is "Determine Value at Runtime", then specify an External Field to be resolved at runtime.   
Parameter_Initialization_Operator_Reference  Parameter_Initialization_OperatorObject  [1..1]  Parameter Initialization Operator Reference   
Currency_Reference  CurrencyObject  [0..1]  Currency Reference   
top
 

InstanceObject

part of: Integration_Attribute_Value_Data_WWS, Launch_Parameter_Default_Data, Integration_Abstract_Value_Data, Copy_of_Integration_Abstract_Value_Data, Parameter_Initialization_WWS_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
 

Parameter_Initialization_OperatorObject

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

Parameter_Initialization_OperatorObjectID

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

CurrencyObject

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

CurrencyObjectID

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

part of: Integration_Service_Data_WWS
Integration Data Initialization Override Configuration Data
 
Parameter name Type/Value Cardinality Description Validations
Integration_Document_Field_for_Field_Override_Data  Overridden_Integration_Document_Field_Data  [0..*]  Integration Document Field for Override Data   
Integration_Document_Field_for_Document_Extension_Data  Extra_Integration_Document_Field_Data  [0..*]  Integration Document Field for Document Extension Data   
top
 

Overridden_Integration_Document_Field_Data

part of: Integration_Data_Initialization_Override_Configuration_Data
Integration Document Field for Override Data
 
Parameter name Type/Value Cardinality Description Validations
Integration_Document_Field_Reference  Integration_Document_FieldObject  [1..1]  Document Field Reference   
External_Field_Reference  External_FieldObject  [0..1]  External Field Content   
Integration_Field_Override_Parameter_Initialization_Data  Integration_Field_Override_Parameter_Initialization_Data  [0..*]  For each parameter, assignment details. 
Validation Description
External Parameter ([parm]) not valid for External Field ([field]). Valid External Parameters for this field are: [valid parms]  External Parameter must be valid for External Field. 
 
Integration_Document_Stacks_for_Integration_Document_Field_Configuration_Data  Integration_Document_Stacks_for_Integration_Document_Field_Configuration_Data  [0..*]  Integration Document Stacks for Integration Document Field Configuration Data   
top
 

Integration_Document_Stacks_for_Integration_Document_Field_Configuration_Data

part of: Extra_Integration_Document_Field_Data, Overridden_Integration_Document_Field_Data
Integration Document Stacks for Integration Document Field Configuration Data
 
Parameter name Type/Value Cardinality Description Validations
Stack_Level  decimal (12, 0) >0   [1..1]  This represents the depth for this Integration Document Stack   
Integration_Document_Field_Reference  Integration_Document_FieldObject  [1..1]  This represents the field that is directly above the current field   
top
 

Extra_Integration_Document_Field_Data

part of: Integration_Data_Initialization_Override_Configuration_Data
Integration Document Field for Document Extension Data
 
Parameter name Type/Value Cardinality Description Validations
Field_Name  string  [1..1]  Field Name   
External_Field_Reference  External_FieldObject  [0..1]  External Field Content   
Integration_Field_Override_Parameter_Initialization_Data  Integration_Field_Override_Parameter_Initialization_Data  [0..*]  For each parameter, assignment details. 
Validation Description
External Parameter ([parm]) not valid for External Field ([field]). Valid External Parameters for this field are: [valid parms]  External Parameter must be valid for External Field. 
 
Integration_Document_Stacks_for_Integration_Document_Field_Configuration_Data  Integration_Document_Stacks_for_Integration_Document_Field_Configuration_Data  [0..*]  Integration Document Stacks for Integration Document Field Configuration Data   
top
 

Integration_Field_Attributes_Configuration_Data

part of: Integration_Service_Data_WWS
Integration Field Attributes Configuration Data
 
Parameter name Type/Value Cardinality Description Validations
Integration_Field_Attributes_Field_Configuration_Data  Integration_Field_Attributes_Field_Configuration_Data  [1..*]  Integration Field Attributes Field Configuration Data   
top
 

Integration_Field_Attributes_Field_Configuration_Data

part of: Integration_Field_Attributes_Configuration_Data, Integration_Field_Attributes_Field_Configuration_Data, Integration_Data_Initialization_Configuration_Data
Integration Field Attributes Field Configuration Data
 
Parameter name Type/Value Cardinality Description Validations
Field_Reference  Integration_Document_FieldObject  [1..1]  Document Field Reference   
Web_Service_Alias  string  [0..1]  Web Service Alias for Field   
Include_in_Output  boolean  [0..1]  Denotes whether this field should be included within the Output document.   
Required_Field  boolean  [0..1]  If this field is to be included in the Output document, denotes whether there must be a value supplied for this field. If there is not a value, then error handling should occur. 
Validation Description
Field may only be denoted as "Required" if the Field Attributes Service allows for this option and "Include in Output" is TRUE.  Field may only be denoted as "Required" if the Field Attributes Service allows for this option and "Include in Output" is TRUE. 
 
Maximum_Length  decimal (6, 0) >0   [0..1]  If this field is to be included in the Output document, denotes whether there should be a maximum length enforced for this field. If the value, exceeds the maximum length then special handling should occur. 
Validation Description
Field may only be denoted with a "Maximum Length" if the Field Attributes Service allows for this option and "Include in Output" is TRUE.  Field may only be denoted with a "Maximum Length" if the Field Attributes Service allows for this option and "Include in Output" is TRUE. 
 
Integration_Field_Attributes_Field_Configuration_Data  Integration_Field_Attributes_Field_Configuration_Data  [0..*]  Integration Field Attributes Field Configuration Data   
top
 

Integration_Delivery_Configuration_Data

part of: Integration_Service_Data_WWS
Integration Delivery Configuration Data element
 
Parameter name Type/Value Cardinality Description Validations
top
 

Integration_Retrieval_Configuration_Data

part of: Integration_Service_Data_WWS
Integration Retrieval Configuration Data element
 
Parameter name Type/Value Cardinality Description Validations
top
 

Integration_Attachment_Configuration_Data

part of: Integration_Service_Data_WWS
Integration Attachment Configuration Data Element
 
Parameter name Type/Value Cardinality Description Validations
Attachment_Data  Attachment_Data_WWS  [0..*]  The details of a resume (resume, name, comments).   
top
 

Attachment_Data_WWS

part of: Integration_Attachment_Configuration_Data
The details of a resume (resume, name, comments).
 
Parameter name Type/Value Cardinality Description Validations
File_ID  string  [0..1]  The Reference ID for the resume.   
File  base64Binary  [0..1]  A comment about the resume.   
FileName  string (255)   [0..1]  The name of the resume.   
Comments  string  [0..1]  The resume that was attached for the applicant.   
top
 

Integration_Report_Service_Configuration_Data

part of: Integration_Service_Data_WWS
Integration Report Service Configuration Data
 
Parameter name Type/Value Cardinality Description Validations
Integration_Report_Field_Configuration_Data  Integration_Report_Field_Configuration_Data  [1..*]  Integration Report Field Configuration Data   
top
 

Integration_Report_Field_Configuration_Data

part of: Integration_Report_Service_Configuration_Data
Integration Report Field Configuration Data
 
Parameter name Type/Value Cardinality Description Validations
Report_Alias_Reference  Integration_Document_FieldObject  [1..1]  Document Field Reference   
Custom_Report_Definition_Reference  Custom_Report_DefinitionObject  [0..1]  Custom Report Definition to assign to Report Service Configuration   
REST_Endpoint  string  [0..1]  Base REST Endpoint for Custom Report. This attribute is for view purposes only based on the Custom Report Definition.   
top
 

Custom_Report_DefinitionObject

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

Custom_Report_DefinitionObjectID

part of: Custom_Report_DefinitionObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Custom_Report_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".   
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_type  WID, System_User_ID, System_User_OpenID, System_User_OpenID_Connect_Internal, System_User_OpenID_Internal  [1..1]  The unique identifier type of a parent object   
top
 

Integration_Custom_Object_Configuration_Data

part of: Integration_Service_Data_WWS
Integration Custom Object Configuration Data
 
Parameter name Type/Value Cardinality Description Validations
Integration_Custom_Object_Alias_Configuration_Data  Integration_Custom_Object_Alias_Configuration_Data  [1..*]  Integration Custom Object Field Configuration Data   
top
 

Integration_Custom_Object_Alias_Configuration_Data

part of: Integration_Custom_Object_Configuration_Data
Integration Custom Object Field Configuration Data
 
Parameter name Type/Value Cardinality Description Validations
Custom_Object_Alias_Reference  Integration_Document_FieldObject  [1..1]  Field Extension Alias Reference   
Custom_Object_Reference  Unique_IdentifierObject  [0..1]  Custom Field Reference   
Capture_Multiple_Values  boolean  [0..1]  Capture Multiple Values   
Custom_Object_REST_URL  string  [0..1]  Custom Object REST URL Endpoint   
Multiple_Custom_Object_REST_URL  string  [0..1]  Multiple Custom Object REST URL Endpoint   
top
 

Integration_Connector_Configuration_Data

part of: Integration_Service_Data_WWS
Connector Configuration
 
Parameter name Type/Value Cardinality Description Validations
Local-In_Endpoint  string  [0..1]  Address of the local-in component used to invoke a connector sub-assembly   
top
 

Integration_Data_Initialization_Configuration_Data

part of: Integration_Service_Data_WWS
Integration Data Initialization Configuration Data
 
Parameter name Type/Value Cardinality Description Validations
Integration_Field_Attributes_Field_Configuration_Data  Integration_Field_Attributes_Field_Configuration_Data  [0..*]  Integration Field Attributes Field Configuration Data 
Validation Description
Configuration of Field Attributes are only available when the Data Initialization Service is marked as participating in Field Attributes Service.  Configuration of Field Attributes are only available when the Data Initialization Service is marked as participating in Field Attributes Service. 
 
top
 

Integration_Tool_Provider_Integration_Attribute_Values_Data_WWS

part of: Integration_System_Data_WWS
Container element for all the Integration Attributes associated with a specific Attributable instance (e.g. Integration Template, Integration Service).
 
Parameter name Type/Value Cardinality Description Validations
Integration_Attribute_Provider_Reference  External_Instance_Object  [0..1]  Unique identifier for an Integration Attribute Provider reference   
Integration_Attribute_Data  Integration_Attribute_Integration_Attribute_Value_Data_WWS  [1..*]  Contains Integration Attributes Name and Values associated to above Attributable instance. 
Validation Description
Attribute Name is required when Integration Attribute Reference is omitted.  Attribute Name is required when Integration Attribute Reference is omitted. 
Integration Attribute ([attribute]) is not valid for the Integration Attribute Provider ([system][provider]).  Integration Attribute must be valid for Integration Attribute Provider. 
 
Validation Description
Attribute Provider Reference is required unless adding Attributes for a new Integration System.  Attribute Provider Reference is required unless adding Attributes for a new Integration System. 
top
 

External_Instance_Object

part of: Integration_Tool_Provider_Integration_Attribute_Values_Data_WWS, Integration_Attribute_Integration_Attribute_Value_Data_WWS, Integration_Tool_Provider_Integration_Map_Values_Data_WWS, Integration_Map_Integration_Map_Value_Data_WWS
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  The "Descriptor" provides a human-readable, descriptive name for the business object. This "Descriptor" attribute should only be used as an informational description and not as data, an index or an identifier for integrations since descriptors can change from time to time in both format and value   
ID  External_Instance_ID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

External_Instance_ID

part of: External_Instance_Object
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_type  string  [1..1]  The unique identifier type of a parent object   
@type  string  [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_Attribute_Integration_Attribute_Value_Data_WWS

part of: Integration_Tool_Provider_Integration_Attribute_Values_Data_WWS
Contains Integration Attributes Name and Values associated to above Attributable instance.
 
Parameter name Type/Value Cardinality Description Validations
Integration_Attribute_Reference  External_Instance_Object  [0..1]  Unique identifier for an Integration Constant (e.g. Attribute) reference   
Integration_Attribute_Name  string  [0..1]  Constant Name   
Integration_Attribute_Value_Data  Integration_Attribute_Value_Data_WWS  [0..*]  Contains Integration Attributes Value and OMS Environment restriction for above Attribute and Integration System.   
Validation Description
Attribute Name is required when Integration Attribute Reference is omitted.  Attribute Name is required when Integration Attribute Reference is omitted. 
Integration Attribute ([attribute]) is not valid for the Integration Attribute Provider ([system][provider]).  Integration Attribute must be valid for Integration Attribute Provider. 
top
 

Integration_Attribute_Value_Data_WWS

part of: Integration_Attribute_Integration_Attribute_Value_Data_WWS
Contains Integration Attributes Value and OMS Environment restriction for above Attribute and Integration System.
 
Parameter name Type/Value Cardinality Description Validations
Text  string  [0..1]  If Attribute is defined as a Text attribute, this will contain the Value assigned to it for appropriate Integration System.   
Date  date  [0..1]  If Attribute is defined as a Date attribute, this will contain the Value assigned to it for appropriate Integration System.   
DateTime  dateTime  [0..1]  If Attribute is defined as a DateTime attribute, this will contain the Value assigned to it for appropriate Integration System.   
Numeric  decimal (26, 6)   [0..1]  If Attribute is defined as a Numeric or Currency attribute, this will contain the Value assigned to it for appropriate Integration System.   
Boolean  boolean  [0..1]  If Attribute is defined as a Boolean attribute, this will contain the Value assigned to it for appropriate Integration System.   
Instance_Reference  InstanceObject  [0..*]  If Attribute is defined as an Instance Set, this will contain the Instance assigned to it for appropriate Integration System.   
Environment_Reference  OMS_EnvironmentObject  [0..*]  Unique identifier for an OMS Environment reference   
top
 

OMS_EnvironmentObject

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

OMS_EnvironmentObjectID

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

part of: Integration_System_Data_WWS
Container element for all the Integration Maps associated with a specific Attributable instance (e.g. Integration Template, Integration Service).
 
Parameter name Type/Value Cardinality Description Validations
Integration_Map_Provider_Reference  External_Instance_Object  [0..1]  Unique identifier for an Integration Map Consumer reference   
Integration_Map_Data  Integration_Map_Integration_Map_Value_Data_WWS  [0..*]  Container element for Integration Map value. 
Validation Description
Map Name is required when Integration Map Reference is omitted.  Map Name is required when Integration Map Reference is omitted. 
Integration Map ([map]) is not valid for the Integration Map Provider ([system][provider]).  Integration Map must be valid for Integration Map Provider. 
 
Validation Description
Map Provider Reference is required unless adding Maps for a new Integration System.  Map Provider Reference is required unless adding Maps for a new Integration System. 
top
 

Integration_Map_Integration_Map_Value_Data_WWS

part of: Integration_Tool_Provider_Integration_Map_Values_Data_WWS
Container element for Integration Map value.
 
Parameter name Type/Value Cardinality Description Validations
Integration_Map_Reference  External_Instance_Object  [0..1]  Unique identifier for an Integration Map reference   
Integration_Map_Name  string  [0..1]  Map Name   
Default_Value_Data  Integration_Abstract_Value_Data  [0..1]  Default Value   
Integration_Map_Value_Data  Integration_Map_Value_Data_WWS  [0..*]  Container element for each row of data within an Integration Map value.   
Validation Description
Map Name is required when Integration Map Reference is omitted.  Map Name is required when Integration Map Reference is omitted. 
Integration Map ([map]) is not valid for the Integration Map Provider ([system][provider]).  Integration Map must be valid for Integration Map Provider. 
top
 

Integration_Abstract_Value_Data

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

Integration_Map_Value_Data_WWS

part of: Integration_Map_Integration_Map_Value_Data_WWS
Container element for each row of data within an Integration Map value.
 
Parameter name Type/Value Cardinality Description Validations
Internal_Value_Data  Integration_Abstract_Value_Data  [0..1]  Internal Value   
External_Value_Data  Copy_of_Integration_Abstract_Value_Data  [0..1]  External Value   
top
 

Copy_of_Integration_Abstract_Value_Data

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

Integration_Attribute_Data

part of: Integration_System_Data_WWS
Container element for definitions of custom Integration Attributes associated to this System
 
Parameter name Type/Value Cardinality Description Validations
Order  string (6)   [1..1]  Order   
Name  string  [1..1]  Attribute Name   
Description  string  [0..1]  Description   
Data_Type_External_Field_Reference [Choice]   External_FieldObject  [1..1]  Data Type defining Attribute   
Data_Type_Enumeration_Definition_Reference [Choice]   Integration_Enumeration_DefinitionObject  [1..1]  Data Type of Attribute (e.g. structure) defined by an Integration Enumeration Definition.   
Multi-Select  boolean  [0..1]  This option allows enumerations to have multiple instances associated with it. It only works for enumeration data types.   
Display_Option_Reference  Display_OptionObject  [0..*]  Display Option Reference   
Validation Description
Only Enumeration Definition Is Valid For Multi-Select   
top
 

Integration_Enumeration_DefinitionObject

part of: Launch_Parameter_Data, Integration_Attribute_Data, Integration_Map_Data, Integration_Map_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_Enumeration_DefinitionObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Integration_Enumeration_DefinitionObjectID

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

Display_OptionObject

part of: Integration_Attribute_Data, Integration_Map_Data, Integration_Map_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  Display_OptionObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Display_OptionObjectID

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

part of: Integration_System_Data_WWS
Container element for definitions of custom Integration Maps associated to this System
 
Parameter name Type/Value Cardinality Description Validations
Order  string (6)   [1..1]  Order   
Name  string  [1..1]  Map Name   
Description  string  [0..1]  Description   
Internal_Value_Data_Type_External_Field_Reference [Choice]   External_FieldObject  [1..1]  Data Type defining Internal Value   
Internal_Value_Data_Type_Integration_Enumeration_Reference [Choice]   Integration_Enumeration_DefinitionObject  [1..1]  Data Type defining Internal Value   
Internal_Value_Display_Option_Reference  Display_OptionObject  [0..*]  Display Option Reference   
External_Value_Data_Type_External_Field_Reference [Choice]   External_FieldObject  [1..1]  Data Type defining External Value   
External_Value_Data_Type_Integration_Enumeration_Reference [Choice]   Integration_Enumeration_DefinitionObject  [1..1]  Data Type defining External Value   
External_Value_Display_Option_Reference  Display_OptionObject  [0..*]  Display Option Reference   
top
 

Launch_Parameter_Data

part of: Integration_System_Data_WWS
Container element for all the Integration Launch Parameters for this Integration System.
 
Parameter name Type/Value Cardinality Description Validations
Order  string  [1..1]  Order Priority   
Name  string  [1..1]  Launch Parameter Name   
Description  string  [0..1]  Launch Parameter Description   
Data_Type_Enumeration_Definition_Reference [Choice]   Integration_Enumeration_DefinitionObject  [1..1]  Data Type of Launch Parameter (e.g. structure) defined by an Integration Enumeration Definition.   
Data_Type_External_Field_Reference [Choice]   External_FieldObject  [1..1]  Data Type of Launch Parameter (e.g. structure) defined by an External Field.   
Launch_Option_Reference  Integration_Launch_OptionObject  [0..*]  Unique reference to Launch Options 
Validation Description
A Launch Parameter may not have both the "Do Not Show" and "Display Only" Options assigned.  A Launch Parameter may not have both the "Do Not Show" and "Display Only" Options assigned. 
 
Launch_Parameter_Default_Data  Launch_Parameter_Default_Data  [0..1]  Element to define Default processing for Launch Parameter 
Validation Description
When specifying a Value Type of "Determine Value at Runtime", an External Field must be provided.  When specifying a Value Type of "Determine Value at Runtime", an External Field must be provided. 
When specifying a Value Type of "Specify Instance", one of the following must have a value as well: - Boolean - Currency - Date / DateTime - Numeric - Text - Instance Reference  When specifying a Value Type of "Specify Instance", one of the following must have a value as well: - Boolean - Currency - Date / DateTime - Numeric - Text - Instance Reference 
Currency Reference is required when supplying a value for Currency.  Currency Reference is required when supplying a value for Currency. 
 
top
 

Integration_Launch_OptionObject

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

Integration_Launch_OptionObjectID

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

Launch_Parameter_Default_Data

part of: Launch_Parameter_Data
Element to define Default processing for Launch Parameter
 
Parameter name Type/Value Cardinality Description Validations
Value_Type_Reference  Parameter_Initialization_OperatorObject  [1..1]  Unique reference to Value Type (Parameter Initialization Operator).   
External_Field_Reference  External_FieldObject  [0..1]  When specifying a Value Type of "Determine Value at Runtime", an External Field must be provided.   
Boolean  boolean  [0..1]  Boolean value.   
Currency  decimal (26, 6)   [0..1]  Currency value.   
Currency_Reference  CurrencyObject  [0..1]  Currency Reference   
Date  date  [0..1]  Date value.   
DateTime  dateTime  [0..1]  DateTime value.   
Numeric  decimal (26, 6)   [0..1]  Numeric value.   
Text  string  [0..1]  Text value.   
Instance_Reference  InstanceObject  [0..*]  Unique reference to specific instance that matches Launch Parameter data type.   
Enumeration_Reference  Integration_EnumerationObject  [0..1]  Unique reference to specific instance of an Enumeration defined by the Launch Parameter.   
Validation Description
When specifying a Value Type of "Determine Value at Runtime", an External Field must be provided.  When specifying a Value Type of "Determine Value at Runtime", an External Field must be provided. 
When specifying a Value Type of "Specify Instance", one of the following must have a value as well: - Boolean - Currency - Date / DateTime - Numeric - Text - Instance Reference  When specifying a Value Type of "Specify Instance", one of the following must have a value as well: - Boolean - Currency - Date / DateTime - Numeric - Text - Instance Reference 
Currency Reference is required when supplying a value for Currency.  Currency Reference is required when supplying a value for Currency. 
top
 

Integration_EnumerationObject

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

Integration_EnumerationObjectID

part of: Integration_EnumerationObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Integration_Enumeration_ID, Workday_Integration_Enumeration_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".   
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_type  WID, Integration_Enumeration_Definition_ID, Workday_Integration_Enumeration_Definition_ID  [1..1]  The unique identifier type of a parent object   
top
 

Integration_Notification_Data

part of: Integration_System_Data_WWS
Element containing configuration of Notifications.
 
Parameter name Type/Value Cardinality Description Validations
Trigger_on_Launch [Choice]   boolean  [1..1]  Trigger on Launch   
Trigger_on_Status_Reference [Choice]   Background_Process_Runtime_StatusObject  [1..*]  Trigger on Status Reference (e.g. Completed, Failed)   
Notification_Condition_Data  Integration_Notification_Integration_Condition_Data  [0..*]  Notification Condition Data   
Loops_On_External_Field_Reference  External_FieldObject  [0..1]  Loops On External Field Reference defines 1 or more related instances to iterate over before creating context for the Notification.   
Notification_Notifies_Data  Notification_Notifies_Data  [0..1]  Notification Notifies Data   
Security_Group_Reference  Security_GroupObject  [0..*]  Security Group Reference that defines a list of users within the Workday system.   
Email_Address_Data  Internet_Email_Address_Data_for_Notifications  [0..*]  Wraps notification email addresses. 
Validation Description
Invalid email address entered. Email addresses must be in the format of 'xxx@yy.com'. Valid examples: john.doe@example.com, jane@example.com. Note that only one email address is allowed.  Email addresses entered must be in a correct format. 
 
Notification_Subject_Data  Notification_Subject_Data  [0..1]  Workflow Notification Subject Data   
Notification_Body_Data  Notification_Body_Data  [0..1]  Workflow Notification Body Data   
Notification_Attachment_Data  Notification_Attachment_Data  [0..1]  Notification Attachment Data   
Validation Description
Either Security Group Reference or Notification Email Address must be specified.   
top
 

Background_Process_Runtime_StatusObject

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

Integration_Notification_Integration_Condition_Data

part of: Integration_Notification_Data
Element containing the conditions to be evaluated for a Notification
 
Parameter name Type/Value Cardinality Description Validations
Condition_Rule_Reference  Condition_RuleObject  [1..1]  Condition Rule Reference   
top
 

Condition_RuleObject

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

Condition_RuleObjectID

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

Notification_Notifies_Data

part of: Integration_Notification_Data
Notification Notifies Data
 
Parameter name Type/Value Cardinality Description Validations
Notifies_Recipient_External_Field_Reference  External_FieldObject  [1..*]  Notifies Person External Field Reference defines a list of Persons within the Workday system.   
top
 

Security_GroupObject

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

Security_GroupObjectID

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

Internet_Email_Address_Data_for_Notifications

part of: Integration_Notification_Data
Wraps notification email addresses.
 
Parameter name Type/Value Cardinality Description Validations
Email_Address  string  [1..1]  Email Address   
Validation Description
Invalid email address entered. Email addresses must be in the format of 'xxx@yy.com'. Valid examples: john.doe@example.com, jane@example.com. Note that only one email address is allowed.  Email addresses entered must be in a correct format. 
top
 

Notification_Subject_Data

part of: Integration_Notification_Data
Element containing the components that make up the Subject of the email message.
 
Parameter name Type/Value Cardinality Description Validations
Notification_Message_Component_Data  Notification_Message_Component_Data  [0..*]  Notification Message Component Data   
top
 

Notification_Message_Component_Data

part of: Notification_Subject_Data, Notification_Body_Data
Element defining a component to be used in composing a message.
 
Parameter name Type/Value Cardinality Description Validations
Order  string (6)   [1..1]  Order   
Text [Choice]   string  [1..1]  Static Text   
External_Field_Reference [Choice]   External_FieldObject  [1..1]  Dynamic content from External Field   
top
 

Notification_Body_Data

part of: Integration_Notification_Data
Element containing the components that make up the Body of the email message.
 
Parameter name Type/Value Cardinality Description Validations
Notification_Body_Data  Notification_Message_Component_Data  [0..*]  Notification Body Data   
top
 

Notification_Attachment_Data

part of: Integration_Notification_Data
Notification Attachment Data
 
Parameter name Type/Value Cardinality Description Validations
Attachment_External_Field_Reference  External_FieldObject  [1..*]  Attachment External Field Reference defines a list of Attachments within the Workday system that may be included within the Notification.   
top
 

Application_Instance_Related_Exceptions_Data

part of: Put_Integration_System_Response
Element containing Exceptions Data
 
Parameter name Type/Value Cardinality Description Validations
Exceptions_Data  Application_Instance_Exceptions_Data  [0..*]  Exceptions Data   
top
 

Application_Instance_Exceptions_Data

part of: Application_Instance_Related_Exceptions_Data
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_System__Audited_ReferenceEnumeration

part of: Integration_System__Audited_ObjectID
Base Type
string
top
 

Integration_TemplateReferenceEnumeration

part of: Integration_TemplateObjectID
Base Type
string
top
 

Integration_ServiceReferenceEnumeration

part of: Integration_ServiceObjectID
Base Type
string
top
 

Business_Process_TypeReferenceEnumeration

part of: Business_Process_TypeObjectID
Base Type
string
top
 

Transaction_Log_TypeReferenceEnumeration

part of: Transaction_Log_TypeObjectID
Base Type
string
top
 

Integration_SequencerReferenceEnumeration

part of: Integration_SequencerObjectID
Base Type
string
top
 

Base Type
string

top
 

Sequence_GeneratorReferenceEnumeration

part of: Sequence_GeneratorObjectID
Base Type
string
top
 

External_FieldReferenceEnumeration

part of: External_FieldObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Integration_Document_FieldReferenceEnumeration

part of: Integration_Document_FieldObjectID
Base Type
string
top
 

Base Type
string

top
 

Parameter_Initialization_OperatorReferenceEnumeration

part of: Parameter_Initialization_OperatorObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Custom_Report_DefinitionReferenceEnumeration

part of: Custom_Report_DefinitionObjectID
Base Type
string
top
 

Base Type
string

top
 

OMS_EnvironmentReferenceEnumeration

part of: OMS_EnvironmentObjectID
Base Type
string
top
 

Integration_Enumeration_DefinitionReferenceEnumeration

part of: Integration_Enumeration_DefinitionObjectID
Base Type
string
top
 

Display_OptionReferenceEnumeration

part of: Display_OptionObjectID
Base Type
string
top
 

Integration_Launch_OptionReferenceEnumeration

part of: Integration_Launch_OptionObjectID
Base Type
string
top
 

Integration_EnumerationReferenceEnumeration

part of: Integration_EnumerationObjectID
Base Type
string
top
 

Base Type
string

top
 

Background_Process_Runtime_StatusReferenceEnumeration

part of: Background_Process_Runtime_StatusObjectID
Base Type
string
top
 

Condition_RuleReferenceEnumeration

part of: Condition_RuleObjectID
Base Type
string
top
 

Security_GroupReferenceEnumeration

part of: Security_GroupObjectID
Base Type
string
top