追加フィールドのリクエスト

ガイド 検索 追加フィールドのリクエスト

追加フィールドのリクエスト

デフォルトでは、検索APIによって標準形式のファイルフォルダ、またはウェブリンクが返されます。これらの各リソースでは、fieldsクエリパラメータを使用してリクエストできる追加のフィールドがサポートされています。

cURL
curl -i -X GET "https://api.box.com/2.0/search?query=sales&fields=name,tags" \
     -H "Authorization: Bearer <ACCESS_TOKEN>"
Java
long offsetValue = 0;
long limitValue = 10;

BoxSearch boxSearch = new BoxSearch(api);
BoxSearchParameters searchParams = new BoxSearchParameters();
searchParams.setQuery("sales");

final List<String> fields = new ArrayList<String>();
fields.add("name");
fields.add("tags");
searchParams.setFields(fields)

PartialCollection<BoxItem.Info> searchResults = boxSearch.searchRange(offsetValue, limitValue, searchParams);
.NET
IEnumerable<string> fields = new List<string>() { "name", "tags"};
BoxCollection<BoxItem> results = await client.SearchManager
    .QueryAsync("sales", fields: fields);
Python
client.search().query("sales", metadata_filters=metadata_search_filters, fields=["name", "tags"])
Node
client.search.query(
  'sales',
  {
    fields: "name,tags"
  })
  .then(results => {
    // ...
  });

これらのフィールドの詳細については、ファイル (詳細)フォルダ (詳細)、およびウェブリンク (詳細)のリソースを確認してください。

fieldsパラメータを使用して、項目の追加情報をクエリで照会すると、これらのフィールドといくつかの基本フィールド (idtypenameなど) のみが返されます。応答に最初から含まれていたフィールドは、明示的にリクエストする必要があります。