Skip to main content
CData Sync には、Sync の自動化と統合に使用できる2つのREST API バージョンがあります:
  • Sync API V2:再設計されたリソースモデルを備えた最新の完全REST ベースのAPI。
  • Sync API V1:元のOData スタイルのAPI。
これらのAPI はどちらも完全にサポートされています。

Sync API V2

Sync API V2 は、モダンなリソース指向のREST アーキテクチャと、現在のSync UI および内部プラットフォーム設計に沿った新しいオブジェクトモデルを導入します。 API V2 の機能には次のものが含まれます:
  • エンドポイントURL にAPI バージョンが埋め込まれたバージョン管理されたベースパス(例:/api.rsc/v2/...)
  • ワークスペース、ジョブ、接続、パイプライン、イベントなどのエンティティに対するリソースベースのURL
  • 関数スタイルのエンドポイントの代わりに標準的なREST 動詞(GET、POST、PUT、DELETE)を使用
  • 名前ベースまたはOData キーの代わりに、システム生成の識別子を使用した識別子ベースのアドレッシング
  • フラットなOData フィードの代わりに、ネストされたオブジェクトと構造化されたコレクションを含むより豊富なJSON レスポンスモデル。
このAPI は7つの個別のAPIで構成されています:
  • 接続管理API
  • イベント管理API
  • ジョブ管理API
  • パイプライン管理API
  • 変換管理API
  • ユーザー管理API
  • ワークスペース管理API
ナビゲーションのAPI V2 セクションを参照して、各エリアのエンドポイントの完全なリストを確認してください。

Sync API V1

Sync API V1 は元のREST API で、OData スタイルの設計に従います。このAPI は、主に以下の例のような関数スタイルのエンドポイントを通じてオペレーションを公開します:
  • /api.rsc/executeJob
  • /api.rsc/getJobs
  • api.rsc/getTables
このAPI は、フィルタリング、クエリ、ナビゲーションに名前ベースのキーとOData 規約を使用します。 このAPI は3つの個別のAPIで構成されています:
  • ジョブ管理API
  • 接続管理API
  • ユーザー管理API
ナビゲーションのAPI V1 セクションを参照して、各エリアのエンドポイントの完全なリストを確認してください。