refToMessageId | String Optional. Identifier used in Two-Way MEPs where the responding MSH user message refers to the initiating MSH user message. | ||
messageId | String Optional. Unique identifier of the user message. If no value is specified, Module for AS4 generates a unique messageId. When the message is generated, the value of this parameter maps to Messaging/UserMessage/MessageInfo/MessageId. | ||
toPartyId | String. External ID of the party receiving the message, as defined in the trading partner profile. | ||
toPartyIdType | String. External ID type of the party receiving the message, as defined in the trading partner profile. | ||
toPartyIdRole | String Optional. The initiator or responder role of the party in the message exchange. | ||
fromPartyId | String. External ID of the party sending the message, as defined in the trading partner profile. | ||
fromPartyIdType | String. External ID type of the party sending the message, as defined in the trading partner profile. | ||
fromPartyIdRole | String Optional. The initiator or responder role of the party in the message exchange. | ||
conversationId | String Optional. Identifier of the set of related messages that make up a conversation between two parties. If no value is specified, Module for AS4 generates a unique ID. The value of this property maps to Messaging/UserMessage/CollaborationInfo/ConversationId. | ||
pmodeId | String Optional. TPA agreement ID to use for the submit request. Note: If pmodeId is empty, then a tuple of From/PartyId, From/Role, To/PartyId, To/Role, Service, Action, and AgreementRef is used to identify the TPA agreement. | ||
agreementRef | String Optional. AgreementRef value to use for the submit request. | ||
property | Document List Optional. List of name-value pairs that are sent along with the message. These pairs map to the zero or more Property child elements within Messaging/UserMessage/MessageProperties. | ||
Parameter | Description | ||
name | String. Name of property. | ||
value | String. Value of property. | ||
partInfo | Document List Optional. Metadata for the partContent parameter. The values specified map to the Messaging/UserMessage/PayloadInfo/PartInfo element. | ||
Parameter | Description | ||
type | String. Way in which the partContent needs to be packaged. Valid values are:  MIME PART—partContent is packaged as MIME attachment.SOAP BODY—partContent is packaged in the SOAP body.EXTERNAL REFERENCE—partContent is an external reference. | ||
id | String. ID of the partContent. | ||
schemaLocation | String. URI of the schema. The value of this parameter maps to the location attribute of the Messaging/UserMessage/PayloadInfo/PartInfo/Schema element. | ||
schemaVersion | String. Version identifier of the schema. The value of this parameter maps to the version attribute of the Messaging/UserMessage/PayloadInfo/PartInfo/Schema element. | ||
schemaNamespace | String Optional. Target namespace of the schema. The value of this parameter maps to the namespace attribute of the Messaging/UserMessage/PayloadInfo/PartInfo/Schema element. | ||
description | String. Description of the partContent. The value of this parameter maps to the Messaging/UserMessage/PayloadInfo/PartInfo/Description element. | ||
property | Document List. List of name value pairs that are sent along with the message. The value of this parameter maps to the Messaging/UserMessage/PayloadInfo/PartInfo/PartProperties element. Note: If you want the final AS4 payload of MIME type application/octet-stream, then add the property name to be of MIME type and value as application/octet-stream. | ||
Parameter | Description | ||
name | String. Name of the property. The value of this parameter maps to the name attribute of the Messaging/UserMessage/PayloadInfo/PartInfo/PartProperties/Property element. | ||
value | String. Value of the property. The value of this parameter maps to the Messaging/UserMessage/PayloadInfo/PartInfo/PartProperties/Property element. | ||
partContent | InputStream. Array of all the MIME attachments. Each element within the array must have a corresponding partInfo. Note: If partInfo is not specified for partContent, then SOAP BODY is considered as the default partInfo type. | ||
soapAction | String Optional. Value of the action parameter in the MIME type. | ||
service | String Optional. Name of service used to identify the RequestUM leg to be used for the current transaction. The module uses the service and action parameters to determine which RequestUM leg to use for the current transaction. The module compares the value of this parameter to the value of leg/businessInfo/service that is configured in all RequestUM legs of the TPA. The RequestUM leg that contains a match for both the service and action parameters is the leg that will be used for the current transaction. When there is only one RequestUM leg configured in the TPA, the service parameter does not have to be defined. | ||
action | String Optional. Name of action used to identify the RequestUM leg to be used for the current transaction. The module uses the service and action parameters to determine which RequestUM leg to use for the current transaction. The module compares the value of this parameter to the value of leg/businessInfo/action that is configured in all RequestUM legs of the TPA. The RequestUM leg that contains a match for both service and action is the leg that will be used for the current transaction. When there is only one RequestUM leg configured in the TPA, the action parameter does not have to be defined. | ||
endpointUrl | String. Endpoint address of the recipient partner. The endpointUrl input field validates only in Peppol bound document. Therefore, the originalSender and finalRecipient properties must be specified when you submit the message in Peppol network. | ||