管理パターン

BFC API のタイプには、設定データを設定するためのオプションの管理インターフェースがあります。 URL のパターンは admin/<resource_type>s です（たとえば admin/grids）。

この URL パターンは、指定したタイプのすべてのインスタンスに設定を適用するときに使用します。特定のグリッドなど、より細かい設定が必要な場合は、管理パターンもリソースインスタンスに適用できます。スコープを指定するには、次のように URL にターゲットリソースの ID を追加します。

admin/<resource_type>/<resource_id>

例：

admin/grids/mygrid

一連の設定データが修正されれば、レコードを返す GET を使用できます。

管理対象に多数の設定値がある場合は、クエリ文字列を使用して設定値の動的なリストを得ることができます。これによって、サーバから取得するデータを判断するときのクライアントの柔軟性が大幅に向上します。 URL の例を以下に示します。

admin/grids?keys=backboneid,licensekey

設定値を設定するには、PUT を使用します。

さらに管理インターフェースでは、含めるキー（admin/grids/backboneControllerId または /admin/discovery など）や更新された値のペイロードと一緒に URL に対して PUT を使用して、特定の設定値を設定することができます。

設定値をクリアするには、PUT および対応するレコードの null 値を使用します。オプションで、URL でキーと一緒に DELETE を使用することもできます（admin/grids/licensekey や admin/backboneId など）。

ターゲットの例 1

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

GET

resource_type またはリソースに関係のある設定を取得します。

戻り値： 設定レコード。

PUT

設定を置換します。

ペイロード： 設定するフィールドが含まれる密度の低いレコード。

戻り値： ok。

結果： 密度の低いレコードの値が更新されます。

ターゲットの例 2

BFC/admin/<resource_type>s/<parameter>,
BFC/admin/<resource_type>/<resource_id>/<parameter>

GET

指定したパラメータに対する設定値を取得します。

クエリ文字列： N/A。

戻り値： 設定値。

PUT

設定値を置換します。

ペイロード： 新しい設定値。

戻り値： ok。

結果： 指定した設定パラメータの値が更新されます。

DELETE

削除： 指定した設定パラメータの値。

ペイロード： N/A。

戻り値： ok。

結果： 指定した設定パラメータの値が設定解除されます。