Box Developerドキュメントの新しいベータ版サイトがまもなくリリースされる予定です。最新の開発者向けガイド、APIリファレンス、AI搭載の検索により、Boxを使用した迅速な開発をサポートします。更新情報については今しばらくお待ちください。
リテンションポリシーを割り当て
リテンションポリシーを項目に割り当てます。
リクエスト
リクエスト本文
ポリシーを割り当てる項目。
"6564564"ポリシーを割り当てる項目のID。typeがenterpriseに設定されている場合は、nullに設定するか省略します。
"metadata_template"ポリシーを割り当てる項目のタイプ。
次の値のいずれか1つ: enterprise,folder,metadata_template
assign_toのタイプがmetadata_templateの場合は、必要に応じてfilter_fieldsパラメータを追加します。このパラメータには、フィールドエントリと値エントリを含むオブジェクトの配列が必要になります。現在、fieldおよびvalueのオブジェクトは1つだけサポートされています。
"a0f4ee4e-1dc1-4h90-a8a9-aef55fc681d4"メタデータ属性キーID。
"0c27b756-0p87-4fe0-a43a-59fb661ccc4e"メタデータ属性フィールドID。値については、列挙型とmultiselect型のみがサポートされています。
"173463"割り当てるリテンションポリシーのID。
"upload_date"リテンションポリシー割り当ての開始日。
assigned_toのタイプがmetadata_templateの場合、このフィールドには、日付フィールドのメタデータ属性キーIDを指定できます。
レスポンス
新しいリテンションポリシー割り当てオブジェクトを返します。
企業にリテンションポリシーを割り当てている最中にidが指定された場合は、エラーを返します。
start_date_fieldが存在するものの、assign_to.typeがmetadata_templateでない場合は、エラーを返します。
start_date_fieldが存在するものの、assign_to.idで指定されたものとは異なるメタデータテンプレートに属している場合は、エラーを返します。
start_date_fieldが存在するものの、retention_policyのretention_lengthが「indefinite」である場合は、エラーを返します。
start_date_fieldが存在するものの、有効なメタデータの日付フィールドに解決できない場合は、エラーを返します。
指定したpolicy_idを持つリテンションポリシーが存在しない場合は、エラーを返します。
期間が同じであるか、それよりも長いリテンションポリシーがこの項目にすでに割り当てられている場合は、エラーを返します。
予期しないクライアントエラー。
リクエストの例
curl -i -X POST "https://api.box.com/2.0/retention_policy_assignments" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-H "content-type: application/json" \
-d '{
"policy_id": "173463",
"assign_to": {
"type": "folder",
"id": "6564564"
}
}'await client.retentionPolicyAssignments.createRetentionPolicyAssignment({
policyId: retentionPolicy.id,
assignTo: {
type: 'folder' as CreateRetentionPolicyAssignmentRequestBodyAssignToTypeField,
id: folder.id,
} satisfies CreateRetentionPolicyAssignmentRequestBodyAssignToField,
} satisfies CreateRetentionPolicyAssignmentRequestBody);client.retention_policy_assignments.create_retention_policy_assignment(
retention_policy.id,
CreateRetentionPolicyAssignmentAssignTo(
type=CreateRetentionPolicyAssignmentAssignToTypeField.FOLDER, id=folder.id
),
)await client.RetentionPolicyAssignments.CreateRetentionPolicyAssignmentAsync(requestBody: new CreateRetentionPolicyAssignmentRequestBody(policyId: retentionPolicy.Id, assignTo: new CreateRetentionPolicyAssignmentRequestBodyAssignToField(type: CreateRetentionPolicyAssignmentRequestBodyAssignToTypeField.Folder) { Id = folder.Id }));try await client.retentionPolicyAssignments.createRetentionPolicyAssignment(requestBody: CreateRetentionPolicyAssignmentRequestBody(policyId: retentionPolicy.id, assignTo: CreateRetentionPolicyAssignmentRequestBodyAssignToField(type: CreateRetentionPolicyAssignmentRequestBodyAssignToTypeField.folder, id: folder.id)))client.getRetentionPolicyAssignments().createRetentionPolicyAssignment(new CreateRetentionPolicyAssignmentRequestBody(retentionPolicy.getId(), new CreateRetentionPolicyAssignmentRequestBodyAssignToField.Builder(CreateRetentionPolicyAssignmentRequestBodyAssignToTypeField.FOLDER).id(folder.getId()).build()))await client.RetentionPolicyAssignments.CreateRetentionPolicyAssignmentAsync(requestBody: new CreateRetentionPolicyAssignmentRequestBody(policyId: retentionPolicy.Id, assignTo: new CreateRetentionPolicyAssignmentRequestBodyAssignToField(type: CreateRetentionPolicyAssignmentRequestBodyAssignToTypeField.Folder) { Id = folder.Id }));await client.retentionPolicyAssignments.createRetentionPolicyAssignment({
policyId: retentionPolicy.id,
assignTo: {
type: 'folder' as CreateRetentionPolicyAssignmentRequestBodyAssignToTypeField,
id: folder.id,
} satisfies CreateRetentionPolicyAssignmentRequestBodyAssignToField,
} satisfies CreateRetentionPolicyAssignmentRequestBody);レスポンスの例
{
"id": "11446498",
"type": "retention_policy_assignment",
"assigned_at": "2012-12-12T10:53:43-08:00",
"assigned_by": {
"id": "11446498",
"type": "user",
"login": "ceo@example.com",
"name": "Aaron Levie"
},
"assigned_to": {
"id": "a983f69f-e85f-4ph4-9f46-4afdf9c1af65",
"type": "metadata_template"
},
"filter_fields": [
{
"field": "a0f4ee4e-1dc1-4h90-a8a9-aef55fc681d4",
"value": "0c27b756-0p87-4fe0-a43a-59fb661ccc4e"
}
],
"retention_policy": {
"id": "12345",
"type": "retention_policy",
"disposition_action": "permanently_delete",
"policy_name": "Some Policy Name",
"retention_length": "365"
},
"start_date_field": "upload_date"
}