Box Developerドキュメント
ログイン
最新バージョン

メタデータカスケードポリシーのリストを取得

get
https://api.box.com/2.0
/metadata_cascade_policies

このエンドポイントはバージョン2024.0です。引き続き使用するために 変更は必要ありません。詳細については、 **Box APIのバージョン管理**を参照してください。

指定したフォルダに適用されているすべてのメタデータカスケードポリシーのリストを取得します。これは、IDが0のルートフォルダでは使用できません。

関連するガイド

リクエスト

bearer [ACCESS_TOKEN]
application/json

クエリパラメータ

stringクエリ内必須
31232

どのフォルダのポリシーを返すかを指定します。これは、IDが0のルートフォルダでは使用できません。

stringクエリ内省略可能
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。

これを使用するには、usemarkerをtrueに設定する必要があります。

integer (int64)クエリ内省略可能
1000
0

レスポンスが開始される項目のオフセット。

オフセットパラメータ値が10,000を超えているクエリは拒否され、400レスポンスが返されます。

stringクエリ内省略可能
31232

メタデータカスケードポリシーを検索するEnterprise ID。指定されていない場合は、デフォルトで現在のEnterpriseに設定されます。

レスポンス

application/jsonメタデータカスケードポリシー

メタデータカスケードポリシーのリストを返します

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

パラメータのいずれかが有効な形式でない場合はエラーを返します。

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

フォルダにアクセスできない場合にエラーを返します。このエラーは、IDが0のルートフォルダにアクセスした場合によく発生します。

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

フォルダが見つからないか、ユーザーがフォルダにアクセスできない場合はエラーを返します。

  • not_found - フォルダが見つからないか、ユーザーがフォルダにアクセスできない場合に返されます。
application/jsonクライアントエラー

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

get
メタデータカスケードポリシーのリストを取得
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

cURL
curl -i -X GET "https://api.box.com/2.0/metadata_cascade_policies?folder_id=31232" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
TypeScript Gen
await client.metadataCascadePolicies.getMetadataCascadePolicies({
  folderId: folder.id,
} satisfies GetMetadataCascadePoliciesQueryParams);
Python Gen
client.metadata_cascade_policies.get_metadata_cascade_policies(folder.id)
.NET Gen
await client.MetadataCascadePolicies.GetMetadataCascadePoliciesAsync(queryParams: new GetMetadataCascadePoliciesQueryParams(folderId: folder.Id));
Java
String folderID = "2222";
BoxFolder folder = new BoxFolder(api, folderID);
Iterable<BoxMetadataCascadePolicy.Info> metadataCascadePolicies = folder.getMetadataCascadePolicies();
for (BoxMetadataCascadePolicy.Info policyInfo : metadataCascadePolicies) {
    // take action on policy here
}
Python
cascade_policies = client.folder(folder_id='22222').get_metadata_cascade_policies()
for policy in cascade_policies:
    print(f'Metadata template {policy.templateKey} is cascaded')
.NET
BoxCollectionMarkerBased<BoxMetadataCascadePolicy> metadataCascadePolicies = await client.MetadataCascadePolicyManager.GetAllMetadataCascadePoliciesAsync("12345");
Node
var folderID = '22222';
client.metadata.getCascadePolicies(folderID)
	.then(cascadePolicies => {
		/* cascadePolicies -> {
			limit: 100,
			entries: [
				{
					id: '84113349-794d-445c-b93c-d8481b223434',
					type: 'metadata_cascade_policy',
					owner_enterprise: {
						type: 'enterprise',
						id: '11111'
					},
					parent: {
						type: 'folder',
						id: '22222'
					},
					scope: 'enterprise_11111',
					templateKey: 'testTemplate'
				}
			],
			next_marker: null,
			prev_marker: null
		}
		*/
	});

レスポンスの例

{
  "entries": [
    {
      "id": "6fd4ff89-8fc1-42cf-8b29-1890dedd26d7",
      "owner_enterprise": {
        "id": "690678",
        "type": "enterprise"
      },
      "parent": {
        "id": "1234567",
        "type": "folder"
      },
      "scope": "enterprise_123456",
      "templateKey": "productInfo",
      "type": "metadata_cascade_policy"
    }
  ],
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih"
}