削除

指定した接続設定を削除します。

注意

コネクション ID が削除された場合、関連する中継許可設定およびブラウザ転送設定も同時に削除されますのでご注意ください。

Request Interface

HTTP Request

DELETE /connections/definition/{connectionId}

Parameter

Path Parameter

Value

Required

Description

connectionId

string

true

Connection ID to be deleted

Authorization

Management Console の [API キー管理] 画面の「スコープ」で、「接続設定」の「削除」を選択する必要があります。

Response Interface

リクエストが正常に処理された場合、レスポンスボディは返却されません。

Examples

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();

        connection.setRequestMethod("DELETE");
        connection.setRequestProperty("Authorization", "Bearer " + apiKey);
        System.out.println(connection.getResponseMessage()); // The response does not contain the response body. 
    } catch (IOException ex) {
        // error
    }
}

// load jquery 
var host = 'https://www.webconnect.hulft.com';
var apiKey = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx';
var connectionId = 'xxxxxxxx';
$.ajax({
  type: 'DELETE',
  url: host + '/api/v2/connections/definition/' + connectionId,
  headers: {
    Authorization: 'Bearer ' + apiKey
  }
}).done(function(data, status, xhr) {
  console.log(data);
}).fail(function(data, status, xhr) {
  console.log(data);
});