MFT REST Calls

MFT supports REST calls for the most common administrative functions.

API Specification Files And Schema Used For REST Calls

The REST OpenAPI specification files in MFT-Install/server/webapps/cfcc/public/docs are as follows:

  • admin.json - The JSON schema is used for all Admin REST calls supported by Command Center, and Internet Server when the Admin service is enabled.
  • admincc.json - The JSON schema is used for Command Center REST calls. Internet Server does not support these REST calls.
  • ft.json - The JSON schema is used for Internet Server File Transfer Rest calls. Command Center does not support these REST calls.
Note: These OpenAPI specification files can be imported in Postman, TIBCO ActiveMatrix BusinessWorks™ 6.4, and Swagger UI. For information on how to configure and run the REST calls, see TIBCO ActiveMatrix BusinessWorks™ REST Reference.

Before you use the JSON schemas, update the following line in the JSON files:

host : "localhost: 8443"

localhost must be changed to the host name of where the calls are run.

8443 must be changed to the HTTP or HTTPS port of where the calls are run.

Redoc Used for API Documentation

MFT uses Redoc for API documentation.

Documentation for Command Center and Internet Server Administrative (Admin) REST calls can be accessed by clicking the Redoc link, which is at the upper-right corner of each Internet Server or Command Center admin page.