Getting All Information

You can get all information of Connection Settings.

By specifying a query parameter, you can get the Connection Settings information satisfying the search condition you set.

Request Interface

HTTP Request

GET /connections/definition

Parameter

There is no individual parameter for this request.

For details on common request parameters for Site API, refer to Common Parameter.

Authorization

In the API Key Management screen in Management Console, 'Connection Settings' under the 'Scopes' field must be selected as 'Get'.

Response Interface

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

{
    "totalSize":2,
    "fetchSize":2
    "startIndex":0,
    "maxResults":30,
    "limit":{"connectionIdLimit":10},
    "definitions":[
        {
            "connectionId":"id1",
            "connectableClientType":["hulft", "data_transfer_api"],
            "ipFilterGroupName":"group1",
            "memo":"memo1"
        },
        {
            "connectionId":"id2",
            "connectableClientType":["data_transfer_api"],
            "memo":"memo2"
        }
    ]
}

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

object

Object of connectionIdLimit

connectionIdLimit

integer

The maximum number of Connection IDs

definitions

array

Array of the elements described below

connectionId

string

Connection ID

connectableClientType

array

Client type that can be used with Connection ID

ipFilterGroupName

string

IP Filter Group Name that is linked to the account. This parameter contains null in this response if an IP Filter Group Name is not set to the Connection ID

memo

string

Note for the settings

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