Obtaining an MFT list of transfers, or transfer status

How you obtain the Managed File Transfer list of transfers, using the REST API

For more information, see Administration using the REST API.

To obtain a list of transfers you:
  1. Send a GET request to the server that is hosting the MFT andMFT web application. You need to consider the format of the URL while sending a request.

    See admin/mft/transfer for more information.

  2. When a request is received, a check is performed on the request to see if the request is valid.

    See Configure MFT REST API security for more information.

  3. If the request is valid, you receive a successful response along with the response body. Otherwise, an appropriate error code and response code is generated.

    See Response status codes for a list of responses.

To obtain the status of a transfer you:
  1. Send a GET request to the server that is hosting the MFT andMFT web application. You need to consider the format of the URL while sending a request.

    See admin/mft/transfer for more information.

  2. When a request is received, a check is performed on the request to see if the request is valid.

    See Configure MFT REST API security for more information.

  3. If the request is valid, you receive a successful response along with the response body. Otherwise, an appropriate error code and response code is generated.

    See Response status codes for a list of responses.


Example response body

The transfer list is retrieved from the internal storage, and a response body is generated in JSON format for each of the transfers. The response body for a transfer looks something like:
 
{"transfer": [
  {
    "destinationAgent": {"name": "AGENT.TRI.BANK"},
    "originator": {
      "host": "192.168.99.1",
      "userId": "johndoe"
    },
    "sourceAgent": {"name": "TESTAGENT"},
    "statistics": {
      "endTime": "2018-01-08T16:22:15.569Z",
      "numberOfFileFailures": 0,
      "numberOfFileSuccesses": 2,
      "numberOfFileWarnings": 0,
      "numberOfFiles": 2,
      "startTime": "2018-01-08T16:22:15.242Z"
    },
    "status": {
      "state": "successful"
    },
    "id": "414D51204D465444454D4F3320202020513E525A21109908"
  },
  {
    "destinationAgent": {"name": "AGENT.TRI.BANK"},
    "originator": {
      "host": "192.168.99.1",
      "userId": "ramsubbarao"
    },
    "sourceAgent": {"name": "TESTAGENT"},
    "statistics": {
      "endTime": "2018-01-08T16:22:13.573Z",
      "numberOfFileFailures": 0,
      "numberOfFileSuccesses": 2,
      "numberOfFileWarnings": 0,
      "numberOfFiles": 2,
      "startTime": "2018-01-08T16:22:13.167Z"
    },
    "status": {
      "state": "successful"
    },
    "id": "414D51204D465444454D4F3320202020513E525A21109702"
  }
]}

See REST API JSON response body attributes for further information on the attributes.