Updating Information

You can update a Browser Transfer Group.

Request Interface

HTTP Request

PUT /browser-transfer-groups/{browserTransferGroupId}

Parameter

Path Parameter	Value	Required	Description	Default Value
browserTransferGroupId	string	true	ID of the Browser Transfer Group to update. (32 alphanumeric characters)	-

Request Parameter	Value	Required	Description	Default Value
name	string	false	Name of the Browser Transfer Group. It must be unique under the contractor account. (String of 1 to 32 alphabet characters, "." (dots), and "-" (hyphens). Names consisting of only "." (one dot) or ".." (two dots) are not allowed.)	No update
accountId	string	false	Account ID of a HULFT-WebConnect Ver.3 account that uses the corresponding Browser Transfer Group. If you specify an empty string, the setting of the item is cleared. (String of 32 characters in UUID format (no hyphens) or an empty string ( "" ))	No update
browserToHulftDefinitionIds	string	false	Browser Send File settings to group together. If you do not want to group them, specify an empty array or null. (Array that can contain strings of 1 to 32 alphabet characters, "." (dots), and "-" (hyphens). Up to 30 elements. Names consisting of only "." (one dot) or ".." (two dots) are not allowed.)	No update
hulftToBrowserDefinitionId	number	false	Browser Send Request settings to group together. If you do not want to group them, specify an empty array or null. (Array that can contain strings of 1 to 32 alphabet characters, "." (dots), and "-" (hyphens). Up to 30 elements. Names consisting of only "." (one dot) or ".." (two dots) are not allowed.)	No update
enable	string	false	Specify availability of the settings. "true" enables the settings. ("true" or " "false")	No update
memo	string	false	Note for the Browser Transfer Group. (String within 256 characters)	No update

Response Interface

If the request is processed successfully, the following response is returned in JSON format.

{
	"id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
	"name": "xxxxxxxx",
	"account": {
		"id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
		"mailAddress": "sample@example.com"
	},
	"browserToHulftDefinitions":[{"id":"xxxxxxxx","description":null}],
	"hulftToBrowserDefinitions":[{"id":"xxxxxxxx","description":null}],
	"enabled": true,
	"memo": "xxxxxxxxxxxxxxxxxxxxxx"
}

Property Name	Value	Description
id	string	ID of the registered Browser Transfer Group.
name	string	Name of the Browser Transfer Group.
account	object	Account that is assigned to the group.
id	string	Account ID.
mailAddress	string	Email address of the account.
browserToHulftDefinitions	array	Object array of the grouped Browser Send File settings.
hulftToBrowserDefinitions	array	Object array of the grouped Browser Send Request settings.
enabled	boolean	Availability of the Browser Transfer Group.
memo	string	Note for the Browser Transfer Group.

Examples

Java JavaScript

public static void main(String[] args) {
String host = "https://www.webconnect.hulft.com";
String apiKey = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
String browserTransferGroupId = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
try {
  URL url = new URL(host + "/api/v2/browser-transfer-groups/" + browserTransferGroupId);
  HttpURLConnection connection = (HttpURLConnection) url.openConnection();
  String putData = "{\"name\": \"sample\","
     + "\"accountId\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\","
     + "\"browserToHulftDefinitionIds\": [\"browserToHulftDefinitionId\"],"
     + "\"hulftToBrowserDefinitionIds\": [\"hulftToBrowserDefinitionId\"],"
     + "\"enabled\": true,"
     + "\"memo\": \"memo\"}";
  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 browserTransferGroupId = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx';
$.ajax({
	type: 'PUT',
	url: host + '/api/v2/browser-transfer-groups/' + browserTransferGroupId,
	headers: {
		Authorization: 'Bearer ' + apiKey
	},
	contentType: 'application/json',
	data: JSON.stringify({
		"name": "sample",
		"accountId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
		"browserToHulftDefinitionIds": ["browserToHulftDefinitionId"],
		"hulftToBrowserDefinitionIds": ["hulftToBrowserDefinitionId"],
		"enabled": true,
		"memo": "memo"
	})
}).done(function(data, status, xhr) {
 console.log(data);
}).fail(function(data, status, xhr) {
 console.log(data);
});