Updating Information

You can update the specified Connection Settings information.

Request Interface

HTTP Request

PUT /connections/definition/{connectionId}

Parameter

Path Parameter	Value	Required	Description	Default Value
connectionId	string	true	Connection ID to be updated

Request Parameter	Value	Required	Description	Default Value
passwd	string	false	Connection Password (8 characters or more and 256 characters or less)	No update
connectableClientType	array	false	Connectable client type (Specifiable value: hulft, data_transfer_api, hwc_browser, dclient)	No update
ipFilterGroupName(1)(2)	string	false	IP Filter Group Name that is linked to the account (32 characters or less. Use alphanumeric characters and symbols (. -). You cannot specify only '.' or '..' for this value) When you release the IP Filter Group being specified, specify null for this parameter.	No update
memo	string	false	Note for the settings (256 characters or less)	No update

*1: When only 'hwc_browser' is specified for 'connectableClientType', you cannot set 'ipFilterGroupName'.

*2: When 'ipFilterGroupName' is already set, 'ipFilterGroupName' becomes invalid if you change the setting value of 'connectableClientType' into only 'hwc_browser'.

Authorization

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

Response Interface

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

{
    "connectionId":"id1",
    "connectableClientType":["hulft"],
    "ipFilterGroupName":"group1",
    "memo":"memo1"
}

Property Name	Value	Description
connectionId	string	Connection ID to be updated
connectableClientType	array	Connectable client type
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

Java JavaScript

public static void main(String[] args) {
    String host = "https://www.webconnect.hulft.com";
    String apiKey = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
    try {
        String connectionId = "xxxxxxxx";
        URL url = new URL(host + "/api/v2/connections/definition/" + connectionId);
        HttpURLConnection connection = (HttpURLConnection) url.openConnection();
        String putData = "{\"passwd\":\"xxxxxxxx\", \"connectableClientType\":[\"hulft\"], \"ipFilterGroupName\":\"group1\", \"memo\":\"xxxxxxx\"}";

        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 connectionId = 'xxxxxxxx';
$.ajax({
  type: 'PUT',
  url: host + '/api/v2/connections/definition/' + connectionId,
  headers: {
    Authorization: 'Bearer ' + apiKey
  },
  contentType: 'application/json',
  data: JSON.stringify({passwd: 'xxxxxxxx', connectableClientType: ["hulft"], ipFilterGroupName: 'group1', memo: 'xxxxxxx'})
}).done(function(data, status, xhr) {
  console.log(data);
}).fail(function(data, status, xhr) {
  console.log(data);
});