リテンションの対象となるファイル
リテンションの対象となるファイルのリスト。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
limit | integer | いいえ | これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータのlimitと等しくなります。最大値はAPIによって異なります。 |
next_marker | string | いいえ | 次の検索結果ページの開始場所のマーカー。 null を指定できます。 |
prev_marker | string | いいえ | 前の検索結果ページの開始場所のマーカー。 null を指定できます。 |
entries | array of ファイル (Mini) | いいえ | ファイルのリスト。 |
例
{
"limit": 1000,
"next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
"prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
"entries": [
{
"id": "12345",
"etag": "1",
"type": "file",
"sequence_id": "3",
"name": "Contract.pdf",
"sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
"file_version": {
"id": "12345",
"type": "file_version",
"sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
}
}
]
}
リテンションポリシー割り当て
リテンションの割り当ては、リテンションポリシーで保持されるファイルを指定するルールを表します。割り当てにより、フォルダまたはメタデータに基づいてファイルを保持したり、企業内のすべてのファイルを保持したりできます。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | はい | リテンションポリシー割り当ての一意の識別子。 |
type | enum<string> | はい | 値は常にretention_policy_assignmentになります。 使用可能なオプション: retention_policy_assignment. |
retention_policy | リテンションポリシー (Mini) | いいえ | コンテンツに割り当てられたリテンションポリシーオブジェクトのMini版の表示。 |
assigned_to | object | いいえ | リテンションの対象となるコンテンツのtypeとid。typeは、folder、enterprise、metadata_templateのいずれかになります。 |
filter_fields | array of object | いいえ | フィールドオブジェクトの配列。値が返されるのは、assigned_toのタイプがmetadata_templateの場合のみです。それ以外の場合、配列は空です。 null を指定できます。 |
assigned_by | ユーザー (Mini) | いいえ | リテンションポリシー割り当てを作成したユーザーをMini版のユーザーオブジェクトで表示。 |
assigned_at | string | いいえ | リテンションポリシー割り当てオブジェクトが作成された日時。 |
start_date_field | string | いいえ | リテンションポリシー割り当ての開始日。assigned_toのタイプがmetadata_templateの場合、このフィールドには、日付フィールドのメタデータ属性キーIDを指定できます。 |
例
{
"id": "11446498",
"type": "retention_policy_assignment",
"retention_policy": {
"id": "12345",
"type": "retention_policy",
"policy_name": "Some Policy Name",
"retention_length": "365",
"disposition_action": "permanently_delete",
"max_extension_length": "365"
},
"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"
}
],
"assigned_by": {
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
},
"assigned_at": "2012-12-12T10:53:43-08:00",
"start_date_field": "upload_date"
}
リテンションポリシー割り当て
リテンションポリシー割り当てのリスト。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
entries | array of リテンションポリシー割り当て | いいえ | リテンションポリシー割り当てのリスト。 |
limit | integer | いいえ | これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータのlimitと等しくなります。最大値はAPIによって異なります。 |
next_marker | string | いいえ | 次の検索結果ページの開始場所のマーカー。 null を指定できます。 |
例
{
"entries": [
{
"id": "11446498",
"type": "retention_policy_assignment",
"retention_policy": {
"id": "12345",
"type": "retention_policy",
"policy_name": "Some Policy Name",
"retention_length": "365",
"disposition_action": "permanently_delete",
"max_extension_length": "365"
},
"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"
}
],
"assigned_by": {
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
},
"assigned_at": "2012-12-12T10:53:43-08:00",
"start_date_field": "upload_date"
}
],
"limit": 1000,
"next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"
}