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

メタデータによるファイル/フォルダに対するクエリ

post
https://api.box.com/2.0
/metadata_queries/execute_read/

SQLに似た構文で特定のメタデータと一致する項目を返す検索を作成します。

デフォルトでは、このエンドポイントによって、クエリに一致する項目に関する最も基本的な情報のみが返されます。各項目のその他のフィールド (メタデータのいずれかを含む) を取得するには、クエリでfields属性を使用します。

関連するガイド

リクエスト

Bearer [ACCESS_TOKEN]
application/json

リクエスト本文

string本文内必須
0

クエリを制限しているフォルダのID。値が0の場合は、アクセスできるすべてのフォルダから結果が返されます。値が0以外の場合は、IDに対応するフォルダまたはそのサブフォルダで見つかった結果のみが返されます。

string array本文内省略可能
["extension","created_at","item_status","metadata.enterprise_1234.contracts","metadata.enterprise_1234.regions.location"]

デフォルトでは、このエンドポイントによって、クエリに一致する項目に関する最も基本的な情報のみが返されます。この属性を使用すると、任意の項目に対して返す追加の属性 (メタデータなど) のリストを指定できます。

この属性は、項目フィールド、メタデータテンプレート識別子、またはメタデータテンプレートフィールド識別子のリストを取得します。

例:

  • created_by - 項目を作成したユーザーの詳細が応答に追加されます。
  • metadata.<scope>.<templateKey> - scopeとtemplateKeyによって識別されたメタデータインスタンスの簡易版レプリゼンテーションが返されます。
  • metadata.<scope>.<templateKey>.<field> - scopeとtemplateKeyによって識別されたメタデータインスタンスの簡易版レプリゼンテーションに加え、field名で指定されたフィールドがすべて返されます。同じscopeおよびtemplateKeyの複数のフィールドを定義できます。
string本文内必須
enterprise_123456.someTemplate

クエリで使用されるテンプレートを指定します。scope.templateKey形式にする必要があります。このフィールドですべてのテンプレートを使用できるとは限りません。最も注目すべきは、Boxが提供する組み込みの分類テンプレートはクエリで使用できないことです。

integer本文内省略可能
50100100

単一のリクエストに対して返す結果の最大数を示す0～100の値。これは、上限を示すだけで、返される結果の最小数を保証しません。

string本文内省略可能
AAAAAmVYB1FWec8GH6yWu2nwmanfMh07IyYInaa7DZDYjgO1H4KoLW29vPlLY173OKsci6h6xGh61gG73gnaxoS+o0BbI1/h6le6cikjlupVhASwJ2Cj0tOD9wlnrUMHHw3/ISf+uuACzrOMhN6d5fYrbidPzS6MdhJOejuYlvsg4tcBYzjauP3+VU51p77HFAIuObnJT0ff

次ページをリクエストするために使用するマーカー。

object array本文内省略可能

メタデータクエリの結果の並べ替えに使用するテンプレートフィールドと方向のリスト。

並べ替えのdirectionは、配列内の各項目で同じにする必要があります。

string本文内省略可能
asc

並べ替えの方向(昇順または降順)。

orderingの方向は、配列内の各項目で同じにする必要があります。

次の値のいずれか1つ: ASC,DESC,asc,desc

string本文内省略可能
amount

並べ替えに使用するメタデータテンプレートフィールド。

field_keyは、検索対象のメタデータテンプレートのフィールドのkey値を表します。

string本文内省略可能
value >= :amount

実行するクエリ。クエリは、SQLのSELECTステートメントによく似た論理式です。検索クエリの値は、query_param引数リストで指定されたパラメータに変換できるため、クエリ文字列に検索値を手動で挿入する必要がなくなります。

たとえば、:amountという値は、query_paramsオブジェクトのamount値を表します。

associative array本文内

queryで指定されたパラメータに対応する引数のセット。query_paramsで使用されている各パラメータのタイプは、対応するメタデータテンプレートフィールドのタイプと一致する必要があります。

string本文内省略可能
100

メタデータ検索で使用されている引数の値。

このパラメータのタイプは、対応するメタデータテンプレートフィールドのタイプと一致する必要があります。

string本文内省略可能
amountAsc

このクエリに使用する検索インデックスの名前。10,000個を超えるファイルとフォルダにメタデータテンプレートが割り当てられる場合は検索インデックスが必要です。

検索インデックスを作成する場合は、メタデータクエリチームまでお問い合わせください。

レスポンス

application/jsonメタデータクエリの検索結果

このメタデータクエリと一致するファイルおよびフォルダのリストを返します。

application/jsonクライアントエラー

リクエスト本文が無効な場合にエラーを返します。

  • invalid_query - 指定した本文パラメータのいずれかが正しくない可能性があります。これは、queryに誤りがあることと、from値が有効なテンプレートを表していない場合があることを意味します。
  • unexpected_json_type - query文字列からの引数がquery_paramに存在しません。たとえば、name = :nameのqueryでは、{ "name": "Box, Inc" }のように、query_paramにname引数の値を含める必要があります。
application/jsonクライアントエラー

指定されたscopeとtemplateKeyのメタデータテンプレートが見つからない場合にエラーを返します。エラー応答には追加の詳細が含まれます。

  • instance_not_found - テンプレートが見つからない場合に返されます。会社のID (enterprise_12345など)を含むテンプレートの完全なスコープを必ず使用してください。
application/jsonクライアントエラー

予期しないクライアントエラー。

post
メタデータによるファイル/フォルダに対するクエリ
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

cURL
curl -i -X POST "https://api.box.com/2.0/files/12345" \
     -H "Authorization: Bearer <ACCESS_TOKEN>" \
     -H "Content-Type: application/json" \
     -d '{
       "from": "enterprise_123456.contractTemplate",
       "query": "amount >= :value",
       "query_params": {
         "value": 100
       },
       "fields": [
         "created_at",
         "metadata.enterprise_123456.contractTemplate.amount",
         "metadata.enterprise_123456.contractTemplate.customerName"
       ],
       "ancestor_folder_id": "5555",
       "order_by": [
         {
           "field_key": "amount",
           "direction": "asc"
         }
       ],
       "limit": 100
     }'
Java
String from = "enterprise_341532.test";
String query = "testfield = :arg";
String ancestorFolderId = "0";
JsonObject queryParameters = new JsonObject().add("arg", "test");
JsonArray orderBy = new JsonArray();
JsonObject primaryOrderBy = new JsonObject().add("field_key", "primarySortKey").add("direction", "asc");
JsonObject secondaryOrderBy = new JsonObject().add("field_key", "secondarySortKey").add("direction",
    "asc");
orderBy.add(primaryOrderBy).add(secondaryOrderBy);

BoxResourceIterable<BoxMetadataQueryItem> results = MetadataTemplate.executeMetadataQuery(api, from, query, queryParameters, ancestorFolderId, null, orderBy);
for (BoxMetadataQueryItem r: results) {
  String customFieldValue = r.getMetadata().get("enterprise_341532").get(0).get("/customField");
  System.out.println(customFieldValue);
}
Node
var from = 'enterprise_12345.someTemplate',
	ancestorFolderId = '5555',
	options = {
		query: 'amount >= :arg',
		query_params: {
			arg: 100
		},
		use_index: 'amountAsc',
		order_by: [
			{
				field_key: 'amount',
				direction: 'asc'
			}
		],
		limit: 100,
		marker: 'AAAAAmVYB1FWec8GH6yWu2nwmanfMh07IyYInaa7DZDYjgO1H4KoLW29vPlLY173OKsci6h6xGh61gG73gnaxoS+o0BbI1/h6le6cikjlupVhASwJ2Cj0tOD9wlnrUMHHw3/ISf+uuACzrOMhN6d5fYrbidPzS6MdhJOejuYlvsg4tcBYzjauP3+VU51p77HFAIuObnJT0ff'
	};
client.metadata.query(from, ancestorFolderId, options)
	.then(items => {
		/* items -> {
			"entries": [
				{
					"item": {
						"type": "file",
						"id": "1617554169109",
						"file_version": {
							"type": "file_version",
							"id": "1451884469385",
							"sha1": "69888bb1bff455d1b2f8afea75ed1ff0b4879bf6"
						},
						"sequence_id": "0",
						"etag": "0",
						"sha1": "69888bb1bff455d1b2f8afea75ed1ff0b4879bf6",
						"name": "My Contract.docx",
						"description": "",
						"size": 25600,
						"path_collection": {
							"total_count": 4,
							"entries": [
								{
									"type": "folder",
									"id": "0",
									"sequence_id": null,
									"etag": null,
									"name": "All Files"
								},
								{
									"type": "folder",
									"id": "15017998644",
									"sequence_id": "0",
									"etag": "0",
									"name": "Contracts"
								},
								{
									"type": "folder",
									"id": "15286891196",
									"sequence_id": "1",
									"etag": "1",
									"name": "North America"
								},
								{
									"type": "folder",
									"id": "16125613433",
									"sequence_id": "0",
									"etag": "0",
									"name": "2017"
								}
							]
						},
						"created_at": "2017-04-20T12:55:27-07:00",
						"modified_at": "2017-04-20T12:55:27-07:00",
						"trashed_at": null,
						"purged_at": null,
						"content_created_at": "2017-01-06T17:59:01-08:00",
						"content_modified_at": "2017-01-06T17:59:01-08:00",
						"created_by": {
							"type": "user",
							"id": "193973366",
							"name": "Box Admin",
							"login": "admin@company.com"
						},
						"modified_by": {
							"type": "user",
							"id": "193973366",
							"name": "Box Admin",
							"login": "admin@company.com"
						},
						"owned_by": {
							"type": "user",
							"id": "193973366",
							"name": "Box Admin",
							"login": "admin@company.com"
						},
						"shared_link": null,
						"parent": {
							"type": "folder",
							"id": "16125613433",
							"sequence_id": "0",
							"etag": "0",
							"name": "2017"
						},
						"item_status": "active"
					},
					"metadata": {
						"enterprise_12345": {
							"someTemplate": {
								"$parent": "file_161753469109",
								"$version": 0,
								"customerName": "Phoenix Corp",
								"$type": "someTemplate-3d5fcaca-f496-4bb6-9046-d25c37bc5594",
								"$typeVersion": 0,
								"$id": "ba52e2cc-371d-4659-8d53-50f1ac642e35",
								"amount": 100,
								"claimDate": "2016-04-10T00:00:00Z",
								"region": "West",
								"$typeScope": "enterprise_123456"
							}
						}
					}
				}
			],
			"next_marker": ""
		}
		*/
	});

レスポンスの例

{
  "entries": [
    {
      "id": 12345,
      "etag": 1,
      "type": "file",
      "sequence_id": 3,
      "name": "Contract.pdf",
      "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
      "file_version": {
        "id": 12345,
        "type": "file_version",
        "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
      },
      "description": "Contract for Q1 renewal",
      "size": 629644,
      "path_collection": {
        "total_count": 1,
        "entries": [
          {
            "id": 12345,
            "etag": 1,
            "type": "folder",
            "sequence_id": 3,
            "name": "Contracts"
          }
        ]
      },
      "created_at": "2012-12-12T10:53:43-08:00",
      "modified_at": "2012-12-12T10:53:43-08:00",
      "trashed_at": "2012-12-12T10:53:43-08:00",
      "purged_at": "2012-12-12T10:53:43-08:00",
      "content_created_at": "2012-12-12T10:53:43-08:00",
      "content_modified_at": "2012-12-12T10:53:43-08:00",
      "created_by": {
        "id": 11446498,
        "type": "user",
        "name": "Aaron Levie",
        "login": "ceo@example.com"
      },
      "modified_by": {
        "id": 11446498,
        "type": "user",
        "name": "Aaron Levie",
        "login": "ceo@example.com"
      },
      "owned_by": {
        "id": 11446498,
        "type": "user",
        "name": "Aaron Levie",
        "login": "ceo@example.com"
      },
      "shared_link": {
        "url": "https://www.box.com/s/vspke7y05sb214wjokpk",
        "download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",
        "vanity_url": "https://acme.app.box.com/v/my_url/",
        "vanity_name": "my_url",
        "access": "open",
        "effective_access": "company",
        "effective_permission": "can_download",
        "unshared_at": "2018-04-13T13:53:23-07:00",
        "is_password_enabled": true,
        "permissions": {
          "can_download": true,
          "can_preview": true
        },
        "download_count": 3,
        "preview_count": 3
      },
      "parent": {
        "id": 12345,
        "etag": 1,
        "type": "folder",
        "sequence_id": 3,
        "name": "Contracts"
      },
      "item_status": "active"
    }
  ],
  "limit": 100,
  "next_marker": "0!-M7487OpVfBTNBV-XsQjU50gQFlbFFu5nArMWD7Ck61GH_Qo40M1S2xN5zWZPBzEjaQS1SOjJiQoo5BsXEl1bCVLRZ2pTqo4SKp9tyqzWQK2L51KR_nC1EgF5I_TJSFw7uO2Bx4HweGETOjh5_2oPSWw5iMkM-OvGApeR0lGFO48FDKoyzJyLgz5aogxoKd8VE09CesOOnTnmZvrW0puylDc-hFjY5YLmWFBKox3SOWiSDwKFkmZGNHyjEzza1nSwbZg6CYsAdGsDwGJhuCeTNsFzP5Mo5qx9wMloS0lSPuf2CcBInbIJzl2CKlXF3FvqhANttpm2nzdBTQRSoJyJnjVBpf4Q_HjV2eb4KIZBBlLy067UCVdv2AAWQFd5E2i6s1YiGRTtgMEZntOSUYD4IYLMWWm5Ra7ke_SP32SL3GSjbBQYIyCVQ.."
}