ActiveTransfer Server 10.15 | webMethods ActiveTransfer Documentation | Administering ActiveTransfer Server | API Support for HTTP file operations | Introduction
 
Introduction
ActiveTransfer supports file operations on HTTP listeners using the webClient. You can now perform file operations in ActiveTransfer using Application Programming Interfaces (APIs) without any dependency on the webClient. To use this API feature, you must create a listener in ActiveTransfer and then log in to that listener port using the same user previously used in the webClient.
Pre-requsites:
*Create an HTTP listener in ActiveTransfer.
*Log in to the listener port using your webClient user credentials. Use the same user with basic authentication when using the APIs.
*Remove any unnecessary headers apart from the headers in the tables below.
*Use only single value inputs in the API requests.
*Check your user access permissions in the VFS configuration. APIs work based on these permissions.
*Check for validations for the API URL, payload parameters, payload and list of supported commands.
The supported APIs are listed below:
*Supported formats: Form-data, JSON
*HTTP Method: POST
Note:
The API for uploading a file only supports the Form-data format.
Supported APIs
URL End-point
Creating a folder
http://<serverhost>:<port number>/api/createFolder
Deleting a file or a folder
http://<serverhost>:<port number>/api/delete
Renaming a file or a folder
http://<serverhost>:<port number>/api/rename
Uploading a file
http://<serverhost>:<port number>/api/upload
Listing of files in a specified path
http://<serverhost>:<port number>/api/list
Verifying if a given input is a file or a folder
http://<server host>:<port number>/api/isFile
Downloading a file
http://<server host>:<port number>/api/download