Trading Networks 10.3 | Administering and Monitoring B2B Transactions | Trading Networks Built-In Services Reference | TPA Folder | Summary of Elements in this Folder | wm.tn.tpa:createTPA
 
wm.tn.tpa:createTPA
Creates a TPA. If the specified senderID, receiverID, and agreementID are not unique, the service reports an error. If the service fails to create a TPA for other reasons, it throws an exception. If you specify initService but not tpaData, the service generates the default value for tpaData.
Input Parameters
senderID
String The internal ID of the trading partner that has the sender role in the transaction the TPA governs.
receiverID
String The internal ID of the trading partner that has the receiver role in the transaction the TPA governs.
agreementID
String The agreement ID of the TPA.
status
String The status of the TPA. It can have one of three values: proposed, disabled, or agreed.
controlNumber
String (optional) A placeholder for an integer. Its usage is application-specific.
exportService
String (optional) The fully-qualified service name of a service that you provide to convert TPA data to a format that can be exported to non-Trading Networks systems.
initService
String (optional) A fully-qualified service name of a service that you provide to populate the TPA data (tpaData) with default values.
dataStatus
String (optional) Whether the data in tpaData is modifiable. Valid values are:
*mutable - tpaData is modifiable.
*immutable - tpaData is not modifiable.
dataSchema
String (optional) A blueprint of the TPA that establishes the TPA parameters and values.
tpaData
Document (optional) TPA data.
Output Parameters
tpa
Document The TPA object.
error
Document (optional) The error reported by the service.