Box Developerドキュメント

Box Developerドキュメントの新しいベータ版サイトがまもなくリリースされる予定です。最新の開発者向けガイド、APIリファレンス、AI搭載の検索により、Boxを使用した迅速な開発をサポートします。更新情報については今しばらくお待ちください。

最新バージョン

フォルダにメタデータカスケードポリシーを強制適用

post
https://api.box.com/2.0
/metadata_cascade_policies/:metadata_cascade_policy_id/apply

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

メタデータカスケードポリシーを持つフォルダのメタデータをそのすべての子に強制的に適用します。これは、新しいカスケードポリシーの作成後、そのフォルダ内にある既存のすべてのファイルにカスケードされるメタデータを適用するのに使用できます。

リクエスト

bearer [ACCESS_TOKEN]
application/json

パスパラメータ

stringパス内必須
6fd4ff89-8fc1-42cf-8b29-1890dedd26d7

強制的に適用するカスケードポリシーのID。

リクエスト本文

string本文内必須
"none"

メタデータテンプレートですでにインスタンスが子に適用されているという競合に対処する際の最適な動作を説明します。

  • noneを指定すると、ファイルの既存の値が保持されます。
  • overwriteを指定すると、既存の値を無視してテンプレートの値が強制的に適用されます。

次の値のいずれか1つ: none,overwrite

レスポンス

none

APIコールが成功した場合は空のレスポンスを返します。メタデータのカスケード操作は非同期的に実行されます。

APIコールは、カスケード操作が完了していなくても直ちに復帰します。現時点では、この操作のステータスを確認するためのAPIはありません。

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

  • instance_not_found - ポリシーが見つかりませんでした。
  • not_found - フォルダが見つからないか、ユーザーがフォルダにアクセスできない場合に返されます。

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

post
フォルダにメタデータカスケードポリシーを強制適用
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

Box SDKのバージョン戦略の詳細については、 **こちら**を確認してください。


cURL
curl -i -X POST "https://api.box.com/2.0/metadata_cascade_policies/21312/apply" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H "content-type: application/json" \
     -d '{
       "conflict_resolution": "overwrite"
     }'
Node/TypeScript v10
await client.metadataCascadePolicies.applyMetadataCascadePolicy(
  cascadePolicyId,
  {
    conflictResolution:
      'overwrite' as ApplyMetadataCascadePolicyRequestBodyConflictResolutionField,
  } satisfies ApplyMetadataCascadePolicyRequestBody,
);
Python v10
client.metadata_cascade_policies.apply_metadata_cascade_policy(
    cascade_policy_id, ApplyMetadataCascadePolicyConflictResolution.OVERWRITE
)
.NET v10
await client.MetadataCascadePolicies.ApplyMetadataCascadePolicyAsync(metadataCascadePolicyId: cascadePolicyId, requestBody: new ApplyMetadataCascadePolicyRequestBody(conflictResolution: ApplyMetadataCascadePolicyRequestBodyConflictResolutionField.Overwrite));
Swift v10
try await client.metadataCascadePolicies.applyMetadataCascadePolicy(metadataCascadePolicyId: cascadePolicyId, requestBody: ApplyMetadataCascadePolicyRequestBody(conflictResolution: ApplyMetadataCascadePolicyRequestBodyConflictResolutionField.overwrite))
Java v10
client.getMetadataCascadePolicies().applyMetadataCascadePolicy(cascadePolicyId, new ApplyMetadataCascadePolicyRequestBody(ApplyMetadataCascadePolicyRequestBodyConflictResolutionField.OVERWRITE))
.NET v6
await client.MetadataCascadePolicies.ApplyMetadataCascadePolicyAsync(metadataCascadePolicyId: cascadePolicyId, requestBody: new ApplyMetadataCascadePolicyRequestBody(conflictResolution: ApplyMetadataCascadePolicyRequestBodyConflictResolutionField.Overwrite));
Node v4
await client.metadataCascadePolicies.applyMetadataCascadePolicy(
  cascadePolicyId,
  {
    conflictResolution:
      'overwrite' as ApplyMetadataCascadePolicyRequestBodyConflictResolutionField,
  } satisfies ApplyMetadataCascadePolicyRequestBody,
);