Version 23.4.8843

• ジョブ管理API
• 接続管理API
• ユーザー管理API

CData Sync は、OData 4.0 標準に準拠するREST API を提供します。このAPI を使用すると、RESTful API 呼び出しを使用して、Sync 管理コンソールで行うのと同じタスクを実行できます。例えば、このAPI を使用して、設定された接続、ジョブ、およびジョブ履歴をクエリできます。ジョブを開始またはキャンセルすることもできます。

API にアクセスするには、Sync 管理コンソールのメニューバーからAPI タブをクリックします。

REST API ページでは、リソース、アクション、認証、サポートされているフォーマットに関する情報を提供しています。ウィンドウの左ペインには、API 呼び出しの詳細とJavaScript およびcURL のコード例を提供するAPI リファレンスセクションがあります。

ジョブ管理API

エンドポイント	サポートされているメソッド	説明
Jobs	GET, POST, PUT, DELETE	既存のジョブの設定を取得または更新、もしくは新しいジョブを作成します。
Transformations	GET, POST, PUT, DELETE	既存の変換の設定を取得または更新、もしくは新しい変換を作成します。
Tasks	GET, POST, PUT, DELETE	ジョブの既存のタスクを取得または更新、もしくはジョブに新しいタスクを追加します。
GetJobStatus	POST	すべてのジョブのステータス、または特定のジョブ内の各クエリのステータスを取得します。
ExecuteJob	POST	特定のジョブを開始します。
ExecuteQuery	POST	ジョブ内でクエリのサブセットを実行します。ジョブとクエリの両方を指定する必要があります。
CancelJob	POST	実行中のジョブをキャンセルします。
History	GET	以前のジョブ実行の履歴を取得します。
GetJobLog	POST	以前のジョブ実行のログを取得します。

接続管理API

エンドポイント	サポートされているメソッド	説明
Connections	GET, POST, PUT, DELETE	既存の接続の設定を取得または更新、もしくはアプリケーションに新しい接続を追加します。
TestConnection	POST	以前に作成した接続をテストします。
GetConnectionTables	POST	接続のテーブルのリストを取得します。
GetConnectionTableColumns	POST	テーブルのカラムのリストを取得します。

ユーザー管理API

エンドポイント	サポートされているメソッド	説明
Users	GET, POST, PUT	Sync ユーザーを作成、取得、または更新します。
CreateUsers	POST	複数のSync ユーザーを作成します。