In the Case of Send Request
You can register new Browser Transfer Settings information (for Send Request).
Request Interface
HTTP Request
POST /browser-transfer/definition/hulft-to-browser
Parameter
Request Parameter |
Value |
Required |
Description |
Default Value |
---|---|---|---|---|
hulftToBrowserDefinitionId |
string |
true |
Transfer Settings ID (32 characters or less) |
|
description |
string |
false |
Description of the transfer settings |
Blank |
fileId |
string |
true |
File ID of HULFT on the remote machine |
|
memo |
string |
false |
Note for the settings |
Blank |
browser |
object |
true |
Browser Definition |
|
connectionId |
string |
true |
Connection ID of the browser side that is registered in the Connection Settings |
|
agentId |
string |
true |
ID to identify the browser (25 characters or less) |
|
useReceiveFileName |
string |
true |
Whether to specify the Receive file name displayed on the browser side |
|
receiveFileName |
string |
false |
Receive file name displayed on the browser side (this field is mandatory if you specify the Receive file name) |
Send file name of HULFT |
hulft |
object |
true |
Agent / HULFT Definition |
|
connectionId |
string |
true |
Connection ID of the remote machine that is registered in the Connection Settings |
|
agentId |
string |
true |
Agent ID of the remote machine (25 characters or less) |
|
hostName |
string |
true |
Host information of HULFT on the remote machine |
|
hulftRequestAcknowledgePort |
integer |
false |
Request Acknowledge Port No. of HULFT on the remote machine |
31000 |
msg0 |
string |
false |
Message sent as 'msg0' to HULFT on the remote machine |
Blank |
msg1 |
string |
false |
Message sent as 'msg1' to HULFT on the remote machine |
Blank |
msg2 |
string |
false |
Message sent as 'msg2' to HULFT on the remote machine |
Blank |
msg3 |
string |
false |
Message sent as 'msg3' to HULFT on the remote machine |
Blank |
msg4 |
string |
false |
Message sent as 'msg4' to HULFT on the remote machine |
Blank |
msg5 |
string |
false |
Message sent as 'msg5' to HULFT on the remote machine |
Blank |
msgl0 |
string |
false |
Message sent as 'msgl0' to HULFT on the remote machine |
Blank |
msgl1 |
string |
false |
Message sent as 'msgl1' to HULFT on the remote machine |
Blank |
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.
Also, the URI of the registered resource is stored in the response header 'Location'.
{ "hulftToBrowserDefinitionId":"browser1", "description":"xxxxxxxxxxxxx", "fileId":"FILEID1", "memo":"memo1", "browser":{ "connectionId":"id1", "agentId":"agent1", "hostName":"HWC-BROWSER" "useReceiveFileName":"true", "receiveFileName":"file1" }, "hulft":{ "connectionId":"id2", "agentId":"agent2", "hostName":"host", "hulftRequestAcknowledgePort":31000, "msg0":"xxxxxxxxxxxxx", "msg1":"xxxxxxxxxxxxx", "msg2":"xxxxxxxxxxxxx", "msg3":"xxxxxxxxxxxxx", "msg4":"xxxxxxxxxxxxx", "msg5":"xxxxxxxxxxxxx", "msgl0":"xxxxxxxxxxxxx", "msgl1":"xxxxxxxxxxxxx" } }
Property Name |
Value |
Description |
---|---|---|
hulftToBrowserDefinitionId |
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 that is registered in the Connection Settings |
agentId |
string |
ID to identify the browser |
hostName |
string |
Host information of the browser side (fixed value) |
useReceiveFileName |
string |
Whether to specify the Receive file name displayed on the browser side |
receiveFileName |
string |
Receive file name displayed on the browser side |
hulft |
object |
Agent / HULFT Definition |
connectionId |
string |
Connection ID of the remote machine that is registered in the Connection Settings |
agentId |
string |
Agent ID of the remote machine |
hostName |
string |
Host information of HULFT on the remote machine |
hulftRequestAcknowledgePort |
integer |
Request Acknowledge 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
public static void main(String[] args) { String host = "https://www.webconnect.hulft.com"; String apiKey = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"; try { URL url = new URL(host + "/api/v2/browser-transfer/definition/hulft-to-browser"); HttpURLConnection connection = (HttpURLConnection) url.openConnection(); String postData = "{ \"hulftToBrowserDefinitionId\":\"xxxxxxxx\",\"description\":\"xxxxxxxx\",\"fileId\":\"TEST\",\"memo\":\"xxxxxxxx\"," + "\"browser\":{\"useReceiveFileName\":\"true\",\"connectionId\":\"xxxxxxxx\",\"agentId\":\"xxxxxxxx\",\"receiveFileName\":\"xxxxxxxx\"}," + "\"hulft\":{\"hulftRequestAcknowledgePort\":31000,\"connectionId\":\"xxxxxxxx\",\"agentId\":\"xxxxxxxx\",\"hostName\":\"xxxxxxxx\"," + "\"msg0\":\"xxxxxxxx\",\"msg1\":\"xxxxxxxx\",\"msg2\":\"xxxxxxxx\",\"msg3\":\"xxxxxxxx\",\"msg4\":\"xxxxxxxx\",\"msg5\":\"xxxxxxxx\"," + "\"msgl0\":\"xxxxxxxx\",\"msgl1\":\"xxxxxxxx\"} }"; connection.setRequestMethod("POST"); connection.setDoOutput(true); connection.setDoInput(true); connection.setRequestProperty("Authorization", "Bearer " + apiKey); connection.setRequestProperty("Content-Type", "application/json"); connection.setRequestProperty("Content-Length", Integer.toString(postData.length())); try (BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(connection.getOutputStream()))) { writer.write(postData); } 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: 'POST', url: host + '/api/v2/browser-transfer/definition/hulft-to-browser', headers: { Authorization: 'Bearer ' + apiKey }, contentType: 'application/json', data: JSON.stringify({ "hulftToBrowserDefinitionId":"xxxxxxxx","description":"xxxxxxxx","fileId":"TEST","memo":"xxxxxxxx", "browser":{"useReceiveFileName":"true","connectionId":"xxxxxxxx","agentId":"xxxxxxxx","receiveFileName":"xxxxxxxx"}, "hulft":{ "hulftRequestAcknowledgePort":31000,"connectionId":"xxxxxxxx","agentId":"xxxxxxxx","hostName":"xxxxxxxx", "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); });