Registering Information

You can register a Browser Transfer Group.

Request Interface

HTTP Request

POST /browser-transfer-groups

Parameter

Request Parameter	Value	Required	Description	Default Value
name	string	true	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.)	-
accountId	string	false	Account ID of a HULFT-WebConne Ver.3 account that uses the corresponding Browser Transfer Group. If you omit this parameter, the item is not set. (String of 32 characters in UUID format (no hyphens) or an empty string ( "" ))	null
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.)	empty
hulftToBrowserDefinitionIds	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.)	empty
enabled	string	false	Specify availability of the settings. "true" enables the settings. ("true" or " "false")	false
memo	string	false	Note for the Browser Transfer Group. (String within 256 characters)	Blank

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": "xxxxxxxxxxxxxxxxxxxxxxx"
}

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";
	try {
	URL url = new URL(host + "/api/v2/browser-transfer-groups");
	HttpURLConnection connection = (HttpURLConnection) url.openConnection();
	String postData = "{\"name\": \"sample\","
		 +  "\"accountId\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\","
		 +  "\"browserToHulftDefinitionIds\": [\"browserToHulftDefinitionId\"],"
		 +  "\"hulftToBrowserDefinitionIds\": [\"hulftToBrowserDefinitionId\"],"
		 +  "\"enabled\": true,"
		 +  "\"memo\": \"memo\"}";
	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-groups',
	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);
});