ユーザーのコンテンツまたは会社全体でファイル、フォルダ、ウェブリンク、および共有ファイルを検索します。
file
このタイプの項目に検索結果を絞り込みます。このパラメータが受け取る値は1つだけです。デフォルトでは、このAPIによって、以下のいずれかのタイプと一致する項目が返されます。
file
- 検索結果をファイルに絞り込みます。folder
- 検索結果をフォルダに絞り込みます。web_link
- 検索結果をウェブリンク (ブックマークとも呼ばれます) に絞り込みます。次の値のいずれか1つ: file
,folder
,web_link
4535234,234123235,2654345
フォルダIDのコンマ区切りリストとして定義された、指定したフォルダリスト内の項目のみに検索結果を絞り込みます。
検索結果には、これらの先祖フォルダのサブフォルダ内の項目も含まれます。
フォルダは現在認証されているユーザーによって所有または共有されている必要もあります。このユーザーがフォルダにアクセスできない場合、またはフォルダがない場合は、代わりにHTTP 404
エラーコードが返されます。
会社全体で検索するには、サポートチームにリクエスト可能なenterprise_content
スコープパラメータを使用することをお勧めします。
name,description
ファイルの説明など、ファイルの特定の部分に対する検索クエリと一致する項目のみに検索結果を絞り込みます。
コンテンツタイプの定義には、Boxで認識されるコンテンツタイプのコンマ区切りリストを使用します。許可されるコンテンツタイプは以下のとおりです。
name
- name
フィールドで定義されている、項目の名前。description
- description
フィールドで定義されている、項目の説明。file_content
- ファイルの実際のコンテンツ。comments
- ファイルまたはフォルダに対するコメントのコンテンツ。tags
- tags
フィールドで定義されている、項目に適用されるタグ。2014-05-15T13:35:01-07:00,2014-05-17T13:35:01-07:00
指定した日付範囲内に作成されたすべての項目に検索結果を絞り込みます。
日付範囲はコンマ区切りのRFC3339タイムスタンプとして定義されます。
開始日が省略されている場合 (,2014-05-17T13:35:01-07:00
)、終了日より前に作成された項目がすべて返されます。
終了日が省略されている場合 (2014-05-15T13:35:01-07:00,
)、代わりに現在の日付が終了日として使用されます。
["2014-05-15T13:35:01-07:00","2014-05-17T13:35:01-07:00"]
指定した日付範囲内に削除されたすべての項目に検索結果を絞り込みます。
日付範囲はコンマ区切りのRFC3339タイムスタンプとして定義されます。
開始日が省略されている場合 (2014-05-17T13:35:01-07:00
)、終了日より前に削除された項目がすべて返されます。
終了日が省略されている場合 (2014-05-15T13:35:01-07:00
)、代わりに現在の日付が終了日として使 用されます。
trash_content
パラメータはtrashed_only
に設定する必要があります。
ごみ箱内検索が実行されていない場合は、空の結果が返されます。
2023年2月1日以降利用できるデータです。
["123422","23532","3241212"]
指定したユーザーリスト (ユーザーIDのコンマ区切りリストとして定義) によって削除された項目に検索結果を絞り込みます。
trash_content
パラメータはtrashed_only
に設定する必要があります。
ごみ箱内検索が実行されていない場合は、空の結果セットが返されます。検索結果に項目が表示されるように、項目は現在認証されているユーザーによって所有または共有されている必要があります。
いずれかのユーザーが所有するファイルにユーザーがアクセスできない場合は、空の結果セットが返されます。
2023年2月1日以降利用できるデータです。
ASC
"DESC"
検索結果の並べ替えの方向を定義します。このパラメータが明示的に指定されていない限り、このAPIはデフォルトで、降順 (DESC
) で項目を返します。
結果がrelevance
を基準にして並べ替えられると、関連度の降順で項目が返されるよう並べ替えはロックされ、このパラメータは無視されます。
次の値のいずれか1つ: DESC
,ASC
id,type,name
レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。
このパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。
pdf,png,gif
指定したファイル拡張子のいずれかと一致するファイルのみに検索結果を絞り込みます。このリストは、ドットなしのファイル拡張子のコンマ区切りリストです。