リテンションポリシー割り当てのリストを取得
get
https://api.box.com/2.0
/retention_policies/:retention_policy_id/assignments
指定したリテンションポリシーに関連付けられているすべてのリテンションポリシー割り当てのリストを返します。
リクエスト
application/json
パスパラメータ
stringパス内必須
982312リテンションポリシーのID。
クエリパラメータ
integer / int64クエリ内省略可能
10001000返す項目の1ページあたりの最大数。
stringクエリ内省略可能
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。
これを使用するには、usemarkerをtrueに設定する必要があります。
stringクエリ内省略可能
folder取得するリテンションポリシー割り当てのタイプ。
次の値のいずれか1つ: folder,enterprise
レスポンス
application/jsonリテンションポリシー割り当て
指定したリテンションポリシーに関連付けられているリテンションポリシー割り当てのリストを返します。
application/jsonクライアントエラー
不明なtypeが指定された場合は、エラーを返します。
application/jsonクライアントエラー
予期しないクライアントエラー。
リクエストの例
cURL
curl -X GET https://api.box.com/2.0/retention_policies/982312/assignments \
-H 'Authorization: Bearer <ACCESS_TOKEN>'.NET
BoxCollectionMarkerBased<BoxRetentionPolicyAssignment> assignments = await client.RetentionPoliciesManager
.GetRetentionPolicyAssignmentsAsync(retentionPolicyId: "11111");Java
BoxRetentionPolicy policy = new BoxRetentionPolicy(api, id);
Iterable<BoxRetentionPolicyAssignment.Info> allAssignments = policy.getAllAssignments("assigned_by");
Iterable<BoxRetentionPolicyAssignment.Info> folderAssignments = policy.getFolderAssignments(50, "assigned_by");
Iterable<BoxRetentionPolicyAssignment.Info> enterpriseAssignments = policy.getEnterpriseAssignments();
for (BoxRetentionPolicyAssignments.Info assignmentInfo : allAssignments) {
// Do something with the assignment.
}
for (BoxRetentionPolicyAssignments.Info assignmentInfo : folderAssignments) {
// Do something with the assignment.
}
for (BoxRetentionPolicyAssignments.Info assignmentInfo : enterpriseAssignments) {
// Do something with the assignment.
}Node
client.retentionPolicies.getAssignments('123456789', {type: 'folder'})
.then(assignments => {
/* assignments -> {
entries: [ { type: 'retention_policy_assignment', id: '12345678' } ],
limit: 100,
next_marker: 'someMarkerString' }
*/
});