リテンションポリシー割り当て

リテンションの割り当ては、リテンションポリシーで保持されるファイルを指定するルールを表します。割り当てにより、フォルダまたはメタデータに基づいてファイルを保持したり、企業内のすべてのファイルを保持したりできます。

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

リテンションの対象となるコンテンツのtypeとid。typeは、folder、enterprise、metadata_templateのいずれかになります。

assigned_to.id string

例"a983f69f-e85f-4ph4-9f46-4afdf9c1af65"

ポリシーが割り当てられるフォルダ、企業、またはメタデータテンプレートのID。

assigned_to.type string

例"metadata_template"

ポリシーが割り当てられるリソースのタイプ。

次の値のいずれか1つ: folder,enterprise,metadata_template

filter_fields object array

フィールドオブジェクトの配列。値が返されるのは、assigned_toのタイプがmetadata_templateの場合のみです。それ以外の場合、配列は空です。

[filter_fields].field string

例"a0f4ee4e-1dc1-4h90-a8a9-aef55fc681d4"

メタデータ属性キーID。

[filter_fields].value string

例"0c27b756-0p87-4fe0-a43a-59fb661ccc4e"

メタデータ属性フィールドID。値については、列挙型とmultiselect型のみがサポートされています。

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"
}