SQLに似た構文で特定のメタデータと一致する項目を返す検索を作成します。
デフォルトでは、このエンドポイントによって、クエリに一致する項目に関する最も基本的な情報のみが返されます。各項目のその他のフィールド (メタデータのいずれかを含む) を取得するには、クエリでfields
属性を使用します。
"0"
クエリを制限しているフォルダのID。値が0の場合は、アクセスできるすべてのフォルダから結果が返されます。値が0以外の場合は、IDに対応するフォルダまたはそのサブフォルダで見つかった結果のみが返されます。
["extension","created_at","item_status","metadata.enterprise_1234.contracts","metadata.enterprise_1234.regions.location"]
デフォルトでは、このエンドポイントによって、クエリに一致する項目に関する最も基本的な情報のみが返されます。この属性を使用すると、任意の項目に対して返す追加の属性 (メタデータなど) のリストを指定できます。
この属性は、項目フィールド、メタデータテンプレート識別子、またはメタデータテンプレートフィールド識別子のリストを取得します。
例:
created_by
では、項目を作成したユーザーの詳細がレスポンスに追加されます。metadata.<scope>.<templateKey>
では、scope
とtemplateKey
によって識別されたメタデータインスタンスのMini版の表示が返されます。metadata.<scope>.<templateKey>.<field>
では、scope
とtemplateKey
によって識別されたメタデータインスタンスのMini版の表示に加え、field
名で指定されたフィールドがすべて返されます。同じscope
およびtemplateKey
の複数のフィールドを定義できます。"enterprise_123456.someTemplate"
クエリで使用されるテンプレートを指定します。scope.templateKey
形式にする必要があります。このフィールドですべてのテンプレートを使用できるとは限りません。最も注目すべきは、Boxが提供する組み込みの分類テンプレートはクエリで使用できないことです。
50
100
0
100
単一のリクエストに対して返す結果の最大数を示す0~100の値。これは、上限を示すだけで、返される結果の最小数を保証しません。