メインコンテンツへスキップ
APIバージョン 2024.0 リテンションの割り当ては、リテンションポリシーで保持されるファイルを指定するルールを表します。割り当てにより、フォルダまたはメタデータに基づいてファイルを保持したり、企業内のすべてのファイルを保持したりできます。
id
string
11446498リテンションポリシー割り当ての一意の識別子。
type
string
retention_policy_assignment値は常にretention_policy_assignmentになります。次の値に固定: retention_policy_assignment
assigned_at
string(date-time)
2012-12-12T10:53:43-08:00リテンションポリシー割り当てオブジェクトが作成された日時。
assigned_by
ユーザー (Mini)object
リテンションポリシー割り当てを作成したユーザーをMini版のユーザーオブジェクトで表示。
assigned_to
object
リテンションの対象となるコンテンツのtypeidtypeは、folderenterprisemetadata_templateのいずれかになります。
filter_fields
object[]
フィールドオブジェクトの配列。値が返されるのは、assigned_toのタイプがmetadata_templateの場合のみです。それ以外の場合、配列は空です。
retention_policy
リテンションポリシー (Mini)object
コンテンツに割り当てられたリテンションポリシーオブジェクトのMini版の表示。
start_date_field
string
upload_dateリテンションポリシー割り当ての開始日。assigned_toのタイプがmetadata_templateの場合、このフィールドには、日付フィールドのメタデータ属性キーIDを指定できます。
{
  "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"
}