接続の管理API


接続の管理API


接続の管理

すべての接続をリスト

Sync アプリケーション内のすべての接続のリストを返します。

GET http://mydomain.com:8001/api.rsc/connections(Name)

クエリパラメータ

名前 説明
Name 取得する接続の名前。

接続を作成

Sync アプリケーションで新しい接続を作成します。

POST http://mydomain.com:8001/api.rsc/connections

ボディパラメータ

名前 説明
Name(必須) 作成する接続の名前。
ProviderName 接続を作成するコネクタの名前。例:CDataSalesforce。
ConnectionString データ接続のための接続文字列。
{ 
  "Name":"MyNewConnection", 
  "ProviderName":"CData Salesforce",
  "ConnectionString": "user=MyUser;Password=MyPassword;SecurityToken=MyToken"
}

接続を編集

既存の接続を編集します。実行中のジョブで使用されている接続を編集することはできません。

PUT http://mydomain.com:8001/api.rsc/connections(Name)

クエリパラメータ

名前 説明
Name(必須) 編集する接続の名前。

ボディパラメータ

名前 説明
ConnectionString データ接続のための接続文字列。
{ 
  "ConnectionString": "user=MyUser;Password=MyPassword;SecurityToken=MyNewToken"
}

接続を削除

Sync アプリケーションから接続を削除します。ジョブで使用されている接続を削除することはできません。

DELETE http://mydomain.com:8001/api.rsc/connections(Name)

クエリパラメータ

名前 説明
Name 削除する接続の名前。

接続をテスト

以前に作成した接続をテストします。レスポンスには、成功またはエラーメッセージが含まれます。

POST http://mydomain.com:8001/api.rsc/testConnection

ボディパラメータ

名前 説明
ConnectionName テストする接続の名前。
{ 
  "ConnectionName":"MyConnection"
}

テーブルをリスト

接続の利用可能なテーブルのリストを取得します。

POST http://mydomain.com:8001/api.rsc/getConnectionTables

ボディパラメータ

名前 説明
ConnectionName テーブルを取得する接続の名前。
TableOrView リストする種類(テーブルまたはビュー)。Values: TABLES,VIEWS,ALL
Schema このスキーマのみにテーブルを制限。
IncludeSchema [Schema].[Table] 形式のテーブル名を持つスキーマを含めるかどうか。
IncludeSchema [Catalog].[Schema].[Table] 形式のテーブル名を持つカタログを含めるかどうか。
{ 
  "ConnectionName":"MyConnection",
  "TableOrView":"ALL",
  "IncludeSchema":"True"
}

カラムをリスト

テーブルの利用可能なカラムのリストを取得します。

POST http://mydomain.com:8001/api.rsc/getConnectionTableColumns

ボディパラメータ

名前 説明
ConnectionName テーブルを取得する接続の名前。
Table カラムを取得するテーブルの名前。
{ 
  "ConnectionName":"MyConnection",
  "Table":"Accounts"
}