In the Case of Send File

You can update the specified Browser Transfer Settings information (for Send File).

Request Interface

HTTP Request

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

Parameter

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

Request Parameter	Value	Required	Description	Default Value
description	string	false	Description of the transfer settings	No update
fileId	string	false	File ID of HULFT on the remote machine	No update
memo	string	false	Note for the settings	No update
browser	object	false	Browser Definition	No update
connectionId	string	false	Connection ID of the browser side	No update
agentId	string	false	ID to identify the browser	No update
hulft	object	false	Agent / HULFT Definition	No update
connectionId	string	false	Connection ID of the remote machine	No update
agentId	string	false	Agent ID of the remote machine	No update
hostName	string	false	Host information of HULFT on the remote machine	No update
hulftReceivingPort	integer	false	Receive Port No. of HULFT on the remote machine	No update
msg0	string	false	Message sent as 'msg0' to HULFT on the remote machine	No update
msg1	string	false	Message sent as 'msg1' to HULFT on the remote machine	No update
msg2	string	false	Message sent as 'msg2' to HULFT on the remote machine	No update
msg3	string	false	Message sent as 'msg3' to HULFT on the remote machine	No update
msg4	string	false	Message sent as 'msg4' to HULFT on the remote machine	No update
msg5	string	false	Message sent as 'msg5' to HULFT on the remote machine	No update
msgl0	string	false	Message sent as 'msgl0' to HULFT on the remote machine	No update
msgl1	string	false	Message sent as 'msgl1' to HULFT on the remote machine	No update

Authorization

In the API Key Management screen in Management Console, 'Browser Send Request' under the 'Scopes' field must be selected as 'Create'.

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 to be updated
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";
    try {
        String browserToHulftDefinitionId = "xxxxxxxx";
        URL url = new URL(host + "/api/v2/browser-transfer/definition/browser-to-hulft/" + browserToHulftDefinitionId);
        HttpURLConnection connection = (HttpURLConnection) url.openConnection();
        String putData = "{ \"description\":\"xxxxxxxx\",\"fileId\":\"TEST\",\"memo\":\"xxxxxxxx\","
                + "\"browser\":{\"connectionId\":\"xxxxxxxx\",\"agentId\":\"xxxxxxxx\"},"
                + "\"hulft\":{\"connectionId\":\"xxxxxxxx\",\"agentId\":\"xxxxxxxx\",\"hostName\":\"xxxxxxxx\",\"hulftReceivingPort\":30000,"
                + "\"msg0\":\"xxxxxxxx\",\"msg1\":\"xxxxxxxx\",\"msg2\":\"xxxxxxxx\",\"msg3\":\"xxxxxxxx\",\"msg4\":\"xxxxxxxx\",\"msg5\":\"xxxxxxxx\","
                + "\"msgl0\":\"xxxxxxxx\",\"msgl1\":\"xxxxxxxx\"} }";
        connection.setRequestMethod("PUT");
        connection.setDoOutput(true);
        connection.setDoInput(true);
        connection.setRequestProperty("Authorization", "Bearer " + apiKey);
        connection.setRequestProperty("Content-Type", "application/json");
        connection.setRequestProperty("Content-Length", Integer.toString(putData.length()));
        try (BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(connection.getOutputStream()))) {
            writer.write(putData);
        }
        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: 'PUT',
  url: host + '/api/v2/browser-transfer/definition/browser-to-hulft/' + browserToHulftDefinitionId ,
  headers: {
    Authorization: 'Bearer ' + apiKey
  },
  contentType: 'application/json',
  data: JSON.stringify({
    "description":"xxxxxxxx","fileId":"TEST","memo":"xxxxxxxx",
    "browser":{"connectionId":"xxxxxxxx","agentId":"xxxxxxxx"},
    "hulft":{
      "connectionId":"xxxxxxxx","agentId":"xxxxxxxx","hostName":"xxxxxxxx","hulftReceivingPort":30000,
      "msg0":"xxxxxxxx","msg1":"xxxxxxxx","msg2":"xxxxxxxx","msg3":"xxxxxxxx","msg4":"xxxxxxxx","msg5":"xxxxxxxx",
      "msgl0":"xxxxxxxx","msgl1":"xxxxxxxx"
    }
  })
}).done(function(data, status, xhr) {
  console.log(data);
}).fail(function(data, status, xhr) {
  console.log(data);
});