Collaboration - Box Dev Docs

{
  "id": "12345678",
  "type": "collaboration",
  "item": {
    "id": "12345",
    "type": "file",
    "etag": "1",
    "sequence_id": "3",
    "name": "Contract.pdf",
    "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
    "description": "Contract for Q1 renewal",
    "size": 629644,
    "created_at": "2012-12-12T10:53:43-08:00",
    "modified_at": "2012-12-12T10:53:43-08:00",
    "trashed_at": "2012-12-12T10:53:43-08:00",
    "purged_at": "2012-12-12T10:53:43-08:00",
    "content_created_at": "2012-12-12T10:53:43-08:00",
    "content_modified_at": "2012-12-12T10:53:43-08:00",
    "item_status": "active"
  },
  "accessible_by": {
    "id": "11446498",
    "type": "user",
    "name": "Aaron Levie",
    "login": "ceo@example.com",
    "is_active": true
  },
  "invite_email": "john@example.com",
  "role": "editor",
  "expires_at": "2012-12-26T10:53:43-08:00",
  "is_access_only": true,
  "status": "accepted",
  "acknowledged_at": "2012-12-12T10:55:20-08:00",
  "created_by": [
    {
      "id": 33224412
    },
    {
      "type": "user"
    },
    {
      "login": "dylan@example.com"
    },
    {
      "name": "Dylan Smith"
    }
  ],
  "created_at": "2012-12-12T10:53:43-08:00",
  "modified_at": "2012-12-12T10:53:43-08:00",
  "acceptance_requirements_status": {
    "terms_of_service_requirement": {
      "is_accepted": true
    },
    "strong_password_requirement": {
      "enterprise_has_strong_password_required_for_external_users": true,
      "user_has_strong_password": true
    },
    "two_factor_authentication_requirement": {
      "enterprise_has_two_factor_auth_enabled": true,
      "user_has_two_factor_authentication_enabled": true
    }
  }
}

アクセス制御リストと同様に、コラボレーションではファイルとフォルダに対するユーザーおよびグループのアクセス権限が定義されます。コラボレーションオブジェクトは、特定のロールによって定義される権限を含んだファイルまたはフォルダへのアクセス権限をユーザーまたはグループに付与します。

string

必須

このコラボレーションの一意の識別子。

例:

"12345678"

type

enum<string>

必須

値は常にcollaborationになります。

利用可能なオプション:

collaboration

例:

"collaboration"

item

File · object

アクセスが許可されているファイルまたはフォルダ。コラボレーションのstatusがpendingの場合またはコラボレーションがアプリ項目に作成されている場合 (app_itemフィールド参照)、このフィールドはnullです。

File
Folder
ウェブリンク

Show child attributes

app_item

アプリ項目 · object

アクセスが許可されているapp_item。コラボレーションが項目に作成されている場合 (itemフィールド参照) またはapp_itemにアクセスできない場合、このフィールドはnullです。ロールは、app_itemに関連付けられたすべての項目にカスケードされます。

Show child attributes

accessible_by

ユーザー (コラボレーション) · object

ユーザーのMini版の表示は、ステータスがpendingの場合にのみ返すことができます。

ユーザー (コラボレーション)
グループ (Mini)

Show child attributes

invite_email

string | null

登録済みユーザーでない未登録コラボレータを招待するために使用されたメールアドレス。

例:

"john@example.com"

role

enum<string>

付与されるアクセスレベル。

利用可能なオプション:

editor,

viewer,

previewer,

uploader,

previewer uploader,

viewer uploader,

co-owner,

owner

例:

"editor"

expires_at

string<date-time> | null

コラボレーションの有効期限。有効期限が設定されていない場合はnull。

例:

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

is_access_only

boolean

trueに設定した場合、コラボレータは共有項目にアクセスできますが、これらの項目は [すべてのファイル] リストに表示されません。また、コラボレータには共有項目のルートフォルダのパスも表示されません。

例:

true

status

enum<string>

コラボレーション招待のステータス。ステータスがpendingの場合、loginとnameは空の文字列を返します。

利用可能なオプション:

accepted,

pending,

rejected

例:

"accepted"

acknowledged_at

string<date-time>

コラボレーションオブジェクトのstatusがacceptedまたはrejectedに変更された日時。

例:

"2012-12-12T10:55:20-08:00"

created_by

ユーザー (コラボレーション) · object

コラボレーションオブジェクトを作成したユーザー。

Show child attributes

例:

[
  { "id": 33224412 },
  { "type": "user" },
  { "login": "dylan@example.com" },
  { "name": "Dylan Smith" }
]

created_at

string<date-time>

コラボレーションオブジェクトが作成された日時。

例:

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

modified_at

string<date-time>

コラボレーションオブジェクトが最後に変更された日時。

例:

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

acceptance_requirements_status

object

Show child attributes

分類を追加

Collaborations

⌘I

Documentation Index