リスト取得

D-Client設定のリストを取得します。

Request Interface

HTTP Request

GET /dclient/definition

Parameter

個別のパラメータはありません。

Site API 共通のリクエストパラメータについては、「共通パラメータ」を参照してください。

Response Interface

リクエストが正常に処理された場合、以下の JSON フォーマットでレスポンスを返却します。

{
	"totalSize": 10,
	"fetchSize": 10,
	"startIndex": 0,
	"maxResults": 30,
	"limit": 10000,
	"dclients": [
		{
			"id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
			"dclientId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
			"connectionId": "xxxxxxxxxxxxxxxx",
			"account":
				{
				"id":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
				"mailAddress":"sample@example.com\"
				},
			"memo": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
			"useable": true,
			"clientVersion": "1,0,0",
			"connectionStatus": "online"
			},
		{
			"id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
			"dclientId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
			"connectionId": "xxxxxxxxxxxxxxxx",
			"account":
				{
				"id":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
				"mailAddress":"sample@example.com\"
				},
			"memo": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
			"useable": true,
			"clientVersion": "1,0,0",
			"connectionStatus": "online"
		},
	]
}

Property Name

Value

Description

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.

limit

integer

The maximum number of D-Client settings that can be registered. (Fixed to 10000)
dclients array Object array of D-Client Transfer Settings

id

string

D-Client UUID (UUID)

dclientId

string

D-Client ID

connectionId string Connection ID
account object Accounts that is assigned to the D-Client settings.
memo string Note (Character string)
useable boolean Availability (true/false)
clientVersion string Client version (Version information in x.y.z. format)
connectionStatus string Connection status (online/offline)

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/dclient/definition");
	   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/dclient/definition',
  headers: {
    Authorization: 'Bearer ' + apiKey
  }
}).done(function(data, status, xhr) {
  console.log(data);
}).fail(function(data, status, xhr) {
  console.log(data);
});