In the Case of Send File

You can get one piece of Browser Transfer Settings information (for Send File) by specifying Transfer Settings ID.

Request Interface

HTTP Request

GET /browser-transfer/definition/browser-to-hulft/{browserToHulftDefinitionId}

Parameter

Path Parameter	Value	Required	Description	Default Value
browserToHulftDefinitionId	string	true	Transfer Settings ID

Authorization

In the API Key Management screen in Management Console, 'Browser Send File' 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.

{
    "browserToHulftDefinitionId":"browser1",
    "description":"xxxxxxxxxxxxx",
    "fileId":"FILEID1",
    "memo":"memo1",
    "browser":{
            "connectionId":"id1",
            "agentId":"agent1",
            "hostName":"HWC-BROWSER"
    },
    "hulft":{
            "connectionId":"id2",
            "agentId":"agent2",
            "hostName":"host",
            "hulftReceivingPort":30000,
            "msg0":"xxxxxxxxxxxxx",
            "msg1":"xxxxxxxxxxxxx",
            "msg2":"xxxxxxxxxxxxx",
            "msg3":"xxxxxxxxxxxxx",
            "msg4":"xxxxxxxxxxxxx",
            "msg5":"xxxxxxxxxxxxx",
            "msgl0":"xxxxxxxxxxxxx",
            "msgl1":"xxxxxxxxxxxxx"
    }
}

Property Name	Value	Description
browserToHulftDefinitionId	string	Transfer Settings ID
description	string	Description of the transfer settings
fileId	string	File ID of HULFT on the remote machine
memo	string	Note for the settings
browser	object	Browser Definition
connectionId	string	Connection ID of the browser side
agentId	string	ID to identify the browser
hostName	string	Host information of the browser side (fixed value)
hulft	object	Agent / HULFT Definition
connectionId	string	Connection ID of the remote machine
agentId	string	Agent ID of the remote machine
hostName	string	Host information of HULFT on the remote machine
hulftReceivingPort	integer	Receive Port No. of HULFT on the remote machine
msg0	string	Message sent as 'msg0' to HULFT on the remote machine
msg1	string	Message sent as 'msg1' to HULFT on the remote machine
msg2	string	Message sent as 'msg2' to HULFT on the remote machine
msg3	string	Message sent as 'msg3' to HULFT on the remote machine
msg4	string	Message sent as 'msg4' to HULFT on the remote machine
msg5	string	Message sent as 'msg5' to HULFT on the remote machine
msgl0	string	Message sent as 'msgl0' to HULFT on the remote machine
msgl1	string	Message sent as 'msgl1' to HULFT on the remote machine

Examples

Java JavaScript

public static void main(String[] args) {
    String host = "https://www.webconnect.hulft.com";
    String apiKey = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
    String browserToHulftDefinitionId = "xxxxxxxx";
    try {
        URL url = new URL(host + "/api/v2/browser-transfer/definition/browser-to-hulft/" + browserToHulftDefinitionId);
        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';
var browserToHulftDefinitionId = 'xxxxxxxx';
$.ajax({
  type: 'GET',
  url: host + '/api/v2/browser-transfer/definition/browser-to-hulft/' + browserToHulftDefinitionId,
  headers: {
    Authorization: 'Bearer ' + apiKey
  }
}).done(function(data, status, xhr) {
  console.log(data);
}).fail(function(data, status, xhr) {
  console.log(data);
});