管理API

Version 24.2.9039


管理API

Version 24.2.9039


CData Arc のビルトイン管理API を使用すると、アプリケーションを柔軟に管理できます。管理コンソールUI 内で実行可能なことは、RESTful API 呼び出しでも実行が可能です。

管理API は、一連のAPI リソースとAPI アクションで構成されます。これらのリソースとアクションへのAPI 呼び出しを組み合わせて、外部のスクリプト、サーバー、アプリケーションからアプリケーションを管理できます:

  • アプリケーションワークフローでファイルを取得
  • アプリケーションによって処理されたファイルに関するメタデータまたはログデータを取得
  • 処理用にアプリケーションワークフローにファイルを挿入
  • コネクタまたはプロファイルのコンフィグ設定を更新
  • コネクタの送受信機能をトリガー

管理API は、デフォルトのREST プロトコルとしてJSON 形式のOData をサポートします。サポートされている追加のWeb サービス形式には、OData(Atom)、SOAP、HTML、CSV が含まれます。

API ブラウザ

リソースおよびアクションセクションには、API で利用可能なリソースとアクションの概要が含まれています。各リソースとアクションの詳細については、API ブラウザを参照してください。

API ブラウザにアクセスするには、ナビゲーションバーのAPI メニューから管理API オプションを選択します:

API ブラウザには、各リソースとアクションで利用可能なプロパティとAPI を利用するためのコードサンプル(JQuery およびcURL)が含まれています。

必須としてマークされた一部の’ID’ プロパティは、他のプロパティとの組み合わせで指定できることに注意してください。例えば、ファイルが’ConnectorId’、’Folder’、および’Filename’ の組み合わせによって識別される場合、特定のファイルを取得するために Files リソースの’MessageId’ プロパティは必要ありません。同様にLog リソース( LogsTransactions 、 および Requests )のID は、事前に不明な場合は省略できます。