リテンションポリシーを更新

put

https://api.box.com/2.0

/retention_policies/:retention_policy_id

リテンションポリシーを更新します。

リクエスト

Content-Typeapplication/json

パスパラメータ

retention_policy_id stringパス内必須

例982312

リテンションポリシーのID。

リクエスト本文

disposition_action string本文内省略可能

例permanently_delete

リテンションポリシーの廃棄アクション。このアクションをpermanently_deleteに設定すると、ポリシーによって保持されているコンテンツが完全に削除されます。remove_retentionに設定すると、コンテンツへのリテンションポリシーの適用が解除され、リテンションポリシーの有効期限が切れた後は、ユーザーがコンテンツを削除できるようになります。

次の値のいずれか1つ: permanently_delete,remove_retention

policy_name string本文内省略可能

例Some Policy Name

リテンションポリシーの名前

status string本文内省略可能

例retired

次の値に固定: retired

レスポンス

200application/jsonリテンションポリシー

更新されたリテンションポリシーオブジェクトを返します。

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

誤ったdisposition_actionが設定された場合は、bad_requestを返します。

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

指定した名前を持つリテンションポリシーがすでに存在する場合は、エラーを返します

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

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

put

リテンションポリシーを更新

このドキュメント内で一部のAPIを試せるようになりました。

ログイン

リクエストの例

cURL

curl -X PUT https://api.box.com/2.0/retention_policies/982312 \
     -H 'Authorization: Bearer <ACCESS_TOKEN>" '
     -H 'Content-Type: application/json" '
     -d '{
       "disposition_action": "permanently_delete"
     }'

.NET

var updates = new BoxRetentionPolicyRequest()
{
    PolicyName = "New Policy Name"
};
BoxRetentionPolicy updatedPolicy = await client.RetentionPoliciesManager
    .UpdateRetentionPolicyAsync("11111", updates);

Java

BoxRetentionPolicy policy = new BoxRetentionPolicy(api, id);
BoxRetentionPolicy.Info policyInfo = policy.new Info();
policyInfo.addPendingChange("policy_name", "new policy name");
policy.updateInfo(policyInfo);

Python

policy_update = {'policy_name': 'New Policy Name',}
updated_retention_policy = client.retention_policy(policy_id='12345').update_info(policy_update)
print('Retention Policy ID is {0} and the new policy name is {1}'.format(updated_retention_policy.id, updated_retention_policy.policy_name))

Node

client.retentionPolicies.update('123456789', {status: 'retired'})
	.then(policy => {
		/* policy -> {
			type: 'retention_policy',
			id: '123456789',
			policy_name: 'Tax Documents',
			policy_type: 'indefinite',
			retention_length: 'indefinite',
			disposition_action: 'remove_retention',
			can_owner_extend_retention: false,
			status: 'retired',
			are_owners_notified: true,
			custom_notification_recipients: []
			assignment_counts: { enterprise: 0, folder: 1, metadata_template: 0 },
			created_by: 
			{ type: 'user',
				id: '11111',
				name: 'Example User',
				login: 'user@example.com' },
			created_at: '2015-05-01T11:12:54-07:00',
			modified_at: '2015-06-08T11:11:50-07:00' }
		*/
	});