すべてのリソース タイプにマネージャ パターン インターフェースがあります。 このインターフェイスは、このタイプのインスタンスの CRUD (作成、読み取り、更新、削除)を行います。 この URL パターンはリソース タイプ名の複数形を作成するためのものです。 たとえば、grids や networks などです。
タイプのインスタンスを作成するには POST アクションを使用します。 POST はマネージャ URL に対して使用し、リソース タイプのペイロードを定義します。 たとえばグリッドを作成するには、グリッド レコードで構成されるペイロードを持つ /grids に対して POST を実行します。
リソース タイプのインスタンスを削除するには、DELETE アクションを使用します。 削除の対象となる URL には、リソース タイプの一意の識別子(ID、名前など)を含めます。 たとえば、DELETE /grids/govt_sales では、govt_sales という名前のグリッドを削除します。
リソース タイプのインスタンスは GET を使用して読み取ることができます。 このアクションでは、インスタンスが含まれるリストが返されます。
インスタンスの更新は、上記の管理パターンについて説明したのと同様の方法で、変更された属性およびリソース タイプを表すインスタンス識別子やペイロードが含まれる URL に対して PUT を使用して行います。
更新でリスト全体を指定したくない場合は、タイプ内のリスト属性にマネージャ パターンも適用できます。 たとえば、PUT grids/admin と利用可能なグリッド ID のリスト全体が書き込まれたグリッド レコードが含まれるペイロードを使用する代わりに、以下の URL を使用して、個々のグリッド パラメータに対して CRUD のいずれかを発行してマネージャ パターンを使用します。
admin/grids/availableGridIds
この URL パターンはタイプ インスタンスの関係に影響を与えるためにも使用できます。 たとえば、グリッド レコードのサーバ属性に対する POST は、グリッドにサーバ(サーバ レコード ペイロードによって指定)を追加します。また、これを削除するには、同じ対象に対して DELETE を使用します。
ターゲットの例 1
BFC/<resource_type>s
このマネージャによって管理されているインスタンスを取得します。
戻り値: リソース レコードのリスト。
マネージャによって管理されるインスタンスを作成します。
ペイロード: リソース レコード。
戻り値: インスタンス名。
結果: 作成されたインスタンスが、既存の管理対象リソースに追加されます。
ターゲットの例 2
BFC/<resource_type>s/<instance id>
URL によって識別されるインスタンスを取得します。
戻り値: リソース レコードのリスト。
更新: インスタンスを更新します。
ペイロード: 設定する属性フィールドが含まれる密度の低いレコード。
戻り値: ok。
結果: リソースが更新されます。
リソースへの接続、またはリソースのサブリソースを作成します。
ペイロード: リソース レコード(ID のみなどの密度の低いもの、または完全に値が入力されたサブコンポーネント定義)。
戻り値: インスタンス識別子。
結果: リソース インスタンスに対して、リソースが接続される、または作成される。
リソースを削除するか、または URL 内のリソースによって識別される関係を元に戻します。
ペイロード: N/A。
戻り値: ok。
結果: 既存の管理対象リソースまたはリソース関係からインスタンスが削除されます。
Copyright © 2012 CA. All rights reserved. |
|