メインコンテンツへスキップ
POST
/
metadata_cascade_policies
cURL
curl -i -X POST "https://api.box.com/2.0/metadata_cascade_policies" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H "content-type: application/json" \
     -d '{
       "folder_id": "12321",
       "scope": "enterprise_27335",
       "templateKey": "productInfo"
     }'
{
  "id": "6fd4ff89-8fc1-42cf-8b29-1890dedd26d7",
  "type": "metadata_cascade_policy",
  "owner_enterprise": {
    "type": "enterprise",
    "id": "690678"
  },
  "parent": {
    "type": "folder",
    "id": "1234567"
  },
  "scope": "enterprise_123456",
  "templateKey": "productInfo"
}
このリソースは、バージョン2024.0のエンドポイントで使用されています。 詳細については、 Box APIのバージョン管理を参照してください。「Box SDKのバージョニング戦略について詳しく学ぶ。」

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
​
folder_id
string
required

ポリシーを適用するフォルダのID。このフォルダには、ターゲットメタデータテンプレートのインスタンスがすでに適用されている必要があります。

Example:

"1234567"

​
scope
enum<string>
required

ターゲットメタデータテンプレートのスコープ。このテンプレートでは、ターゲットフォルダにすでにインスタンスが適用されている必要があります。

利用可能なオプション:
global,
enterprise
Example:

"enterprise"

​
templateKey
string
required

ターゲットメタデータテンプレートのキー。このテンプレートでは、ターゲットフォルダにすでにインスタンスが適用されている必要があります。

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

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

Example:

"productInfo"

Response

新しいメタデータカスケードポリシーを返します。

メタデータカスケードポリシーにより、メタデータテンプレートインスタンスが自動的にターゲットフォルダ内のすべてのファイルとフォルダに適用されます。

​
id
string
required

メタデータカスケードポリシーオブジェクトのID。

Example:

"6fd4ff89-8fc1-42cf-8b29-1890dedd26d7"

​
type
enum<string>
required

値は常にmetadata_cascade_policyになります。

利用可能なオプション:
metadata_cascade_policy
Example:

"metadata_cascade_policy"

​
owner_enterprise
object

このポリシーを所有する会社。

​
parent
object

ポリシーが適用されるフォルダを表します。

​
scope
string

メタデータカスケードポリシーのスコープは、globalまたはenterprise_*のいずれかになります。globalスコープは、任意のBox Enterpriseで利用できるポリシーに使用されます。enterprise_*スコープは、特定のEnterprise内で作成されたポリシーを表します (*はそのEnterpriseのID)。

Example:

"enterprise_123456"

​
templateKey
string

フォルダの子にカスケードされるテンプレートのキー。

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

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

Example:

"productInfo"