前のトピック: マネージャ パターン

次のトピック: API に関する詳細なドキュメント


操作パターン

CRUD (作成、読み取り、更新、削除)のマネージャ パターンに含まれない操作は、操作パターンによって処理されます。 操作の範囲には、リソースの状態の変更から、電源のパスワードのリセットなどの操作をリソースに実行させることなどが含まれます。

操作パターンを実装するには、operations/<operation name> で終了する URL に対し、オプションでペイロードを指定して POST を使用します。 以下の例では、govt_sales という名前のグリッドを開始します。

POST grids/govt_sales/operations/start

RESTful では、操作パターンにより、操作名によって識別される新しいリソースが作成されます。

操作パターンは、管理パターンやマネージャ パターンと組み合わせることができます。 管理対象の収集に対する操作は、管理パターンに従います。 ただし、管理対象のインスタンスに対する操作は、マネージャ パターンに従います。

次のセクションの表では、BFC クライアントがどのように API アプリケーションとやり取りするかについて、URI 構造、HTTP メソッドの使用、ペイロードおよび戻り値の構造について(総合的に)説明します。

ターゲットの例

次の操作について説明します。

BFC/admin/<resource_type>s/operations/<operation_name>, 
BFC/<resource_type>s/operations/<operation_name>, 
BFC/admin/<resource_type>/<resource_id>/operations/<operation_name>

GET

ペイロードなしで操作を呼び出します。 これを使用して呼び出された操作には、副作用がないことが必要です。

戻り値: 操作の結果。

POST

副作用があることを除き、GET と同じです。

ペイロード: 操作によって定義された変数。

戻り値: 操作の結果。