WBI-C 管理 API によって、Community Console GUI を使用することなく、特定の共通管理機能を実行できます。
注: API 呼び出しを処理するには Console それ自身が稼動していなければならず、呼び出しを行う前に GUI で API 機能をオンにしておく必要があります。 GUI を使用して API をオンにする際の詳細については、「WBI-C ハブ構成ガイド」を参照してください。
メソッドは、本文として該当する XML 文書を持つ HTTP POST 要求を送信することによって呼び出されます。この要求は、Console インスタンス (相対 URL /console/bcgpublicapi) で実行されているサーブレットに送信されます。
一般に、XML 要求文書には以下のデータが入っています。
現在、以下の 11 のメソッドがサポートされています。
システムは要求を処理し、応答 (または例外) XML を同時に (つまり、同じ HTTP 接続で) 戻します。各メソッドには、対応する応答があります。 API を使用すると、コンソールを使用して作成するものと同じ内部プロセスが作成されます。コンソールを介して実行される特定の操作がイベントを生成する場合、API を介して実行される同じ操作も同じイベントを生成します。
管理 APIに、これらの API について詳しく記述されています。提供されている以下の 2 つのスキーマにある $(WBICINSTALLROOT)/publicapi ディレクトリーを調べることによって、さらに詳しい情報を収集できます。
実際の応答に加え、サーブレットそれ自身も 表 1に示されている標準 HTTP 状況コードを提供します。
HTTP 状況コード | このコードが戻される状態 |
---|---|
500 |
|
405 |
|
200 |
|
501 |
|
セキュリティーは SSL の使用によって、また場合によってはクライアント許可によって提供されています。文字エンコードが、予期されている標準エンコードの UTF-8 に設定されているかぎり、ユーザーのロケールに基づいてデータ (API それ自身のエレメントではない) をローカライズすることができます。