all | String (Optional) Specifies whether to export all ActiveTransfer assets or only selected assets. The following values apply: true - Export all assets. This is the default. When this value is specified, exportData is ignored. false - Export only the assets identified in exportData. | ||
exportData | Document List (Optional) Specifies the assets, and their dependent assets where applicable, to export when all is set to false. Variables are: | ||
Variable | Description | ||
assetType | String (Optional) Specifies the type of ActiveTransfer asset to export. Valid values are port, serverInstance, serverPreference, user, userTemplate, postProcessEvent, scheduleAction, VFS, and partnerMapping. | ||
all | String (Optional) Specifies whether to export all assets of the type specified in assetType. The following values apply: true - Export all assets of the specified asset type. false - Export only assets of a specified asset type that match the internal IDs specified in ids. | ||
ids | String List (Optional) Specifies the internal IDs associated with the assets to export. For the user asset types, the internal ID is considered the name of the asset; for all other asset types, the internal ID is the individual asset ID. Administrators can obtain internal IDs from the ActiveTransfer database. | ||
names | String List (Optional) Specifies the name or path (for VFS hierarchy) of the assets to export. For the user asset type, the authentication ID (user ID) is considered the name of the asset; for all other asset types, the individual asset name is used. When there are multiple VFSes with the same name, it is useful to specify the exact path, so that ActiveTransfer exports only the specific VFS you require. Provide the complete VFS path in the asset hierarchy. For example: Number/Jim/jimL/day/Trigger. If you do not provide the complete hierarchical path, ActiveTransfer exports the first VFS that has the specified name, and ignores all others. | ||
exportFileName | String Specifies the path and name of the XML file in which to save the exported assets. |
output | Document Contains the results of the export. The document contains the following keys: | ||
Key | Description | ||
exportFilePath | String The path and name of the XML file that contains the exported assets. | ||
errorMessages | String List Any errors encountered during the export process. |