メインコンテンツへスキップ
GET
/
retention_policy_assignments
/
{retention_policy_assignment_id}
cURL
curl -i -X GET "https://api.box.com/2.0/retention_policy_assignments/1233123" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
{
  "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"
  },
  "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"
}
このリソースは、バージョン2024.0のエンドポイントで使用されています。 詳細については、 Box APIのバージョン管理を参照してください。「Box SDKのバージョニング戦略について詳しく学ぶ。」

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
retention_policy_assignment_id
string
required

リテンションポリシー割り当てのID。

Query Parameters

​
fields
string[]

レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。

このパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。

Response

リテンションポリシー割り当てオブジェクトを返します。

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

​
id
string
required

リテンションポリシー割り当ての一意の識別子。

Example:

"11446498"

​
type
enum<string>
required

値は常にretention_policy_assignmentになります。

利用可能なオプション:
retention_policy_assignment
Example:

"retention_policy_assignment"

​
retention_policy
リテンションポリシー (Mini) · object

コンテンツに割り当てられたリテンションポリシーオブジェクトのMini版の表示。

​
assigned_to
object

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

​
filter_fields
(object | null)[] | null

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

​
assigned_by
ユーザー (Mini) · object

リテンションポリシー割り当てを作成したユーザーをMini版のユーザーオブジェクトで表示。

​
assigned_at
string<date-time>

リテンションポリシー割り当てオブジェクトが作成された日時。

Example:

"2012-12-12T10:53:43-08:00"

​
start_date_field
string

リテンションポリシー割り当ての開始日。assigned_toのタイプがmetadata_templateの場合、このフィールドには、日付フィールドのメタデータ属性キーIDを指定できます。

Example:

"upload_date"