リーガルホールドポリシーを更新

put
https://api.box.com/2.0
/legal_hold_policies/:legal_hold_policy_id

リーガルホールドポリシーを更新します。

リクエスト

application/json

パスパラメータ

リクエスト本文

string本文内省略可能
A custom policy for the sales team500

ポリシーの説明。

string本文内省略可能
Sales Policy254

ポリシーの名前。

string本文内省略可能
Required for GDPR500

ポリシーが解除された理由に関するメモ。

レスポンス

新しいリーガルホールドポリシーオブジェクトを返します。

この名前のポリシーがすでに存在する場合は、エラーを返します。

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

put
リーガルホールドポリシーを更新
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

cURL
curl -X PUT https://api.box.com/2.0/legal_hold_policies/324432 \
     -H 'Authorization: Bearer <ACCESS_TOKEN>" '
     -H 'Content-Type: application/json" '
     -d '{
       "policy_name": "Policy 4"
     }'
.NET
var updates = new BoxLegalHoldPolicyRequest()
{
    Description = "Hold for documents related to the IRS audit"
};
BoxLegalHoldPolicy updatedPolicy = await client.LegalHoldPoliciesManager
    .UpdateLegalHoldPolicyAsync("11111", updates);
Java
BoxLegalHoldPolicy policy = new BoxLegalHoldPolicy(api, id);
BoxLegalHoldPolicy.Info policyInfo = policy.new Info();
info.addPendingChange("description", "new description");
policy.updateInfo(info);
Python
policy_update = {'description': 'New Description', 'release_notes': 'Example Notes'}
updated_policy = client.legal_hold_policy(policy_id='12345').update_info(policy_update)
Node
client.legalHoldPolicies.update('11111', {description: 'Documents related to IRS audit'})
	.then(policy => {
		/* policy -> {
			type: 'legal_hold_policy',
			id: '11111',
			policy_name: 'IRS Audit',
			description: 'Documents related to IRS audit',
			status: 'active',
			assignment_counts: { user: 1, folder: 0, file: 0, file_version: 0 },
			created_by: 
			{ type: 'user',
				id: '22222',
				name: 'Example User',
				login: 'user@example.com' },
			created_at: '2016-05-18T10:28:45-07:00',
			modified_at: '2016-05-18T11:25:59-07:00',
			deleted_at: null,
			filter_started_at: '2016-05-17T01:00:00-07:00',
			filter_ended_at: '2016-05-21T01:00:00-07:00' }
		*/
	});
iOS
client.legalHolds.update(policyId: "1234", policyName: "New Name") { (result: Result<LegalHoldPolicy, BoxSDKError>) in
    guard case let .success(policy) = result else {
        print("Error updating legal hold policy")
        return
    }
    print("Updated legal hold policy name is \"\(policy.name)\"")
}