Getting All Logs

You can get all relay logs.

By specifying a query parameter, you can get the relay log satisfying the search condition you set.

Request Interface

HTTP Request

GET /relay/log

Parameter

Query Parameter	Value	Required	Description	Default Value
senderConnectionId	string	false	Connection ID of the sending side	Blank
receiverConnectionId	string	false	Connection ID of the receiving side	Blank
senderSecondaryAccount	string	false	Previous secondary account for Browser Transfer of the sending side (email address) in the Relay Log to retrieve	Blank
receiverSecondaryAccount	string	false	Previous secondary account for Browser Transfer of the receiving side (email address) in the Relay Log to retrieve	Blank

For details on common request parameters for Site API, refer to Common Parameter.

Authorization

In the API Key Management screen in Management Console, 'Relay Log' under the 'Scopes' field must be selected as 'Get'.

Response Interface

If the request is processed successfully, the following response is returned in JSON format. The data is returned in descending order of startTime, beginning with the newest.

{
    "totalSize":50,
    "fetchSize":1,
    "startIndex":0,
    "maxResults":1,
    "logs":[
        {
            "status":"1",
            "startTime":"2016-06-30 12:13:01.226",
            "endTime":"2016-06-30 12:13:02.226",
            "senderConnectionId":"id1",
            "senderAgentId":"agent1",
            "senderHostName":"host1",
            "receiverConnectionId":"id2",
            "receiverAgentId":"agent2",
            "receiverHostName":"host2",
            "fileId":"FILEID1",
            "fileName":"example",
            "processingId":"CCC3D6B33DF4F42EA4734BD88519525A32",
            "dataSize":"60",
            "dataSizeOnRoute":"60",
            "transferRate":"60",
            "senderClientType":"hulft",
            "receiverClientType":"data_transfer_api"
            "senderSecondaryAccount":"sender@hulft.com",
            "receiverSecondaryAccount":"receiver@hulft.com"
        }
    ]
}

Property Name	Value	Description
totalSize	integer	The total number of data
fetchSize	integer	The number of the obtained data
startIndex	integer	Index of the first row of a data to retrieve
maxResults	integer	The maximum number of indexes included in a response data
logs	array	Array of the elements described below
status	string	Status code (1: Normal end, 2: Error)
startTime	string	Transfer start date and time
endTime	string	Transfer end date and time
senderConnectionId	string	Connection ID of the sending side
senderAgentId	string	Agent ID of the sending side
senderHostName	string	Host name of Agent on the sending side
receiverConnectionId	string	Connection ID of the receiving side
receiverAgentId	string	Agent ID of the receiving side
receiverHostName	string	Host name of Agent on the receiving side
fileId	string	File ID of HULFT
fileName	string	File name to be transferred
processingId	string	Processing identifier
dataSize	string	Actual data size (Unit: bytes)
dataSizeOnRoute	string	Data size on transfer route (Unit: bytes)
transferRate	string	Transfer rate (bytes/second)
senderClientType	string	Client type of the sending side
receiverClientType	string	Client type of the receiving side
senderSecondaryAccount	string	Previous secondary account for Browser Transfer of the sending side (email address) in the Relay Log to retrieve
receiverSecondaryAccount	string	Previous secondary account for Browser Transfer of the receiving side (email address) in the Relay Log to retrieve

Examples

Java JavaScript

public static void main(String[] args) {
    String host = "https://www.webconnect.hulft.com";
    String apiKey = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
    try {
        URL url = new URL(host + "/api/v2/relay/log");
        HttpURLConnection connection = (HttpURLConnection) url.openConnection();
        connection.setRequestMethod("GET");
        connection.setRequestProperty("Authorization", "Bearer " + apiKey);
        try (BufferedReader reader = new BufferedReader(new InputStreamReader(connection.getInputStream()))) {
            String line;
            while((line = reader.readLine()) != null) {
                System.out.println(line);
            }
        }
    } catch (IOException ex) {
        // error
    }
}

// load jquery 
var host = 'https://www.webconnect.hulft.com';
var apiKey = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx';
$.ajax({
  type: 'GET',
  url: host + '/api/v2/relay/log',
  headers: {
    Authorization: 'Bearer ' + apiKey
  }
}).done(function(data, status, xhr) {
  console.log(data);
}).fail(function(data, status, xhr) {
  console.log(data);
});