Service Directory > v31.2 > Integrations > Put_Integration_Message
 

Operation: Put_Integration_Message

This operation adds a message to either an Integration System or Integration Event which allows for status, information and error details to be communicated back to Workday.


@ - 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_Message_Request

Integration Message request element.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Integration_Message_Data  Integration_Message_Data  [1..1]  Encapsulating element containing all Integration Message data. 
Validation Description
Repository Document can only be added to an active Integration Event (e.g. Processing status).  Repository Document can only be added to an active Integration Event (e.g. Processing status). 
 
top
 

Response Element: Put_Integration_Message_Response

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

Integration_Message_Data

part of: Put_Integration_Message_Request
Encapsulating element containing all Integration Message data.
 
Parameter name Type/Value Cardinality Description Validations
Integration_Event_Reference [Choice]   Integration_ESB_Invocation__Abstract_Object  [1..1]  Reference element representing a unique instance of Integration Event. 
Validation Description
When using Import Integration Message, all Message Data must be associated with an Integration Event and not an Integration System.   
When using Import Integration Message, all Message Data must be associated with an Integration Event that rolls up to the Integration Event on the header.   
 
Integration_System_Reference [Choice]   Integration_System__Audited_Object  [1..1]  Reference element representing a unique instance of Integration System.   
Message_Summary  string  [1..1]  Text attribute identifying the Summary of the Integration Message.   
Message_Detail  RichText  [0..1]  Text attribute identifying the Detail of the Integration Message.   
Severity_Level_Reference  Background_Process_Message_Severity_LevelObject  [1..1]  Reference element representing a unique instance of Integration Message Severity Level.   
Message_Target_Reference  InstanceObject  [0..*]  A Reference to an instance within the Workday system that is related to this message.   
Integration_Attachment_Data  Integration_Attachment_Data  [0..*]  Integration Attachment Data   
Repository_Document_Data  Integration_Repository_Document_Data  [0..*]  Repository Document Data   
Enqueue_Notification_Message  boolean  [0..1]  Add Inbox Notification to owner of Repository Document   
Validation Description
Repository Document can only be added to an active Integration Event (e.g. Processing status).  Repository Document can only be added to an active Integration Event (e.g. Processing status). 
top
 

Integration_ESB_Invocation__Abstract_Object

part of: Integration_Message_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Integration_ESB_Invocation__Abstract_ObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Integration_ESB_Invocation__Abstract_ObjectID

part of: Integration_ESB_Invocation__Abstract_Object
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Application_Fee_Payment_Session_ID, Background_Process_Instance_ID, Student_Payment_Session_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Integration_System__Audited_Object

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

Background_Process_Message_Severity_LevelObject

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

InstanceObject

part of: Integration_Message_Data, Integration_Repository_Document_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_Message_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
 

Integration_Repository_Document_Data

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

Unique_IdentifierObject

part of: Put_Integration_Message_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  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_ESB_Invocation__Abstract_ReferenceEnumeration

part of: Integration_ESB_Invocation__Abstract_ObjectID
Base Type
string
top
 

Integration_System__Audited_ReferenceEnumeration

part of: Integration_System__Audited_ObjectID
Base Type
string
top
 

RichText

part of: Integration_Message_Data
Base Type
string
top
 

Background_Process_Message_Severity_LevelReferenceEnumeration

part of: Background_Process_Message_Severity_LevelObjectID
Base Type
string
top
 

Mime_TypeReferenceEnumeration

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

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top