メタデータフィルタ

検索結果のフィルタに使用するメタデータテンプレート。

例{"category":"online","contractValue":1000000}

検索結果のフィルタに使用するテンプレートのフィールドを指定します。複数のフィールドを指定すると、クエリでは論理ANDが実行され、指定された各フィールドに一致するテンプレートのインスタンスが取得されます。

scope string

例"enterprise"

検索結果のフィルタに使用する、テンプレートのスコープを指定します。

これは、この会社で使用するために定義されたテンプレートの場合はenterprise_{enterprise_id}、Boxを使用するすべての会社が利用できる一般的なテンプレートの場合はglobalになります。

次の値のいずれか1つ: global,enterprise,enterprise_{enterprise_id}

例"contract"

検索結果のフィルタに使用するテンプレートのキー。

多くの場合、テンプレートキーはその表示名から自動的に派生します。たとえば、Contract Templateの場合はcontractTemplateとなります。場合によっては、テンプレートの作成者が独自のテンプレートキーを指定することもあります。

テンプレートのキーを調べるには、会社のテンプレートのリストを取得するか、ファイルまたはフォルダ上のすべてのインスタンスを取得してください。

レスポンスの例

{
  "filters": {
    "category": "online",
    "contractValue": 1000000
  },
  "scope": "enterprise",
  "templateKey": "contract"
}