Getting List Information

You can get a list of Browser Transfer Groups.

Request Interface

HTTP Request

GET /browser-transfer-groups

Parameter

There is no individual parameter for this request.

For details on common request parameters for Site API, refer toCommon Parameter

Response Interface

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

{
	"limit": 10000,
	"totalSize": 2,
	"fetchSize": 2,
	"startIndex": 0,
	"maxResults": 30,
	"browserTransferGroups": [
		{
		"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"
		},
		{
		"id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
		"name": "xxxxxxxx",
		"account": null,
		"browserToHulftDefinitions":[{"id":"xxxxxxxx","description":null}],
		"hulftToBrowserDefinitions":[{"id":"xxxxxxxx","description":null}],
		"enabled": false,
		"memo": "xxxxxxxxxxxxxxxxxxxxxx"
		}
	]
}

Property Name	Value	Description
limit	integer	The maximum number of Browser Transfer Group settings that can be registered. (Fixed to 10000)
totalSize	integer	The total number of data.
fetchSize	integer	The number of the obtained data.
startIndex	integer	Index of the first row of a data to retrieve.
maxResults	integer	The maximum number of indexes included in a response data.
browserTransferGroups	array	Object array of the Browser Transfer Groups.
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();
        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';
$.ajax({
  type: 'GET',
  url: host + '/api/v2/browser-transfer-groups',
  headers: {
    Authorization: 'Bearer ' + apiKey
  }
}).done(function(data, status, xhr) {
  console.log(data);
}).fail(function(data, status, xhr) {
  console.log(data);
});