Box開発者向けドキュメントポータル
ログイン

インデックス

ガイド メタデータ メタデータクエリ インデックス

インデックス

規模を考慮したことにより、メタデータテンプレートが10,000を超えるファイルまたはフォルダに適用されている場合、メタデータクエリによってHTTP 403エラーが返される可能性があります。検索インデックスを作成すると、特定の検索クエリでこのエラーを解決することができます。

Boxは、将来この制限を廃止するのではなく、引き上げる予定です。

制限

すべての顧客に対してメタデータサービスの一貫性と可用性を維持するために、クエリの規模に関していくつかの制限を設けています。

  • テンプレートあたりのインデックス数: テンプレートあたり最大5個のインデックスを作成できます
  • 各インデックスのフィールド数: 各テンプレートには、フィルタ用にインデックスを作成したフィールドを最大5つ含めることができます

インデックスのリクエスト

現時点では、検索インデックスを作成するには、Boxメタデータクエリチームにお問い合わせいただく必要があります。

インデックスを作成するには、リクエストのfrom​、​query​、および​order_by​パラメータに適した値を含め、実行対象のクエリについてBoxに知らせる必要があります。

その後、インデックスが作成されると、このインデックスの名前が渡されます。インデックスの名前を指定したい場合は、インデックスをリクエストする際にその名前を指定してください。

検索対象となるファイルまたはフォルダが10,000を超える場合は、メタデータクエリの処理中にインデックスが自動的に適用されます。インデックスの作成以外に何もしなくても、インデックスは適用されます。

LIKE、ILIKE、NOT LIKE、およびNOT ILIKE演算子は、インデックスのクエリでは使用できません。

インデックスリクエストの例

以下は、インデックスのリクエストの例です。​from、queryおよびorder_by​パラメータに関するすべての情報を含める必要があります。

クエリの説明特定のアカウント番号に関連付けられ、ステータスが保留中になっている、「顧客による送信」というタイプのファイルを返します。レスポンスは送信日で並べられます。
fromenterprise_123456.customerInfo
queryaccountNumber = :argAccountNum AND status = :argStatus
order_by[{ "field_key": "submissionDate","direction": "desc" }]

作成されたインデックスのリストの取得

特定のメタデータテンプレートおよびスコープに対して作成されたインデックスのリストを取得するには、メタデータクエリインデックスのリストを取得エンドポイントを使用します。

エンドポイントにリクエストを送信する際は、テンプレートのスコープ (globalまたはenterprise) のほか、テンプレートキーを指定します。

cURL
curl -i -X GET "https://api.box.com/2.0/metadata_query_indices?scope=enterprise&template_key=properties" \
     -H "Authorization: Bearer <ACCESS_TOKEN>"