wm.mft.assets.port:add
Creates a new port in ActiveTransfer Server or ActiveTransfer Gateway.
Input Parameters
portInfo | Document Reference A document reference to the wm.mft.assets.rec.port:PortInfo document type, which specifies the details of the ActiveTransfer Server or ActiveTransfer Gateway port. |
Output Parameters
success | String If the service was successful in creating a new ActiveTransfer Server or ActiveTransfer Gateway port. true The service was successful. false The service was not able to create a new ActiveTransfer Server or ActiveTransfer Gateway port. |
portId | String The internal identifier for the ActiveTransfer Server or ActiveTransfer Gateway port. |
message | String A message that is logged after the service execution is complete. |
validationErrors | String List An array of all the error messages logged during validation of portInfo. |
Usage Notes
ActiveTransfer Server generates a unique ID for the new port. Hence, it overrides the
portId input parameter specified in
portInfo for this service.
![*](bullet.gif)
The
instanceId and
instanceName in the
wm.mft.assets.rec.port:PortInfo document type in the input parameter,
portInfo determines if the port is a server port or a gateway port.
![*](bullet.gif)
The port is active as soon as it is created.