コラボレーションを更新

このリソースは、バージョン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

collaboration_id

string

required

コラボレーションのID。

Body

application/json

role

enum<string>

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

利用可能なオプション:

editor,

viewer,

previewer,

uploader,

previewer uploader,

viewer uploader,

co-owner,

owner

Example:

"editor"

status

enum<string>

コラボレーション招待のステータスとして、保留中 (pending)、承認、拒否のいずれかを設定します。

利用可能なオプション:

pending,

accepted,

rejected

Example:

"accepted"

expires_at

string<date-time>

コラボレーションの有効期限を更新します。この日付になると、項目から自動的にコラボレーションが削除されます。

この機能が動作するのは、管理コンソールの [Enterprise設定] で [招待したコラボレータを自動的に削除する] の [フォルダの所有者に有効期限の延長を許可する] の設定が有効になっている場合のみです。この設定が有効になっていない場合、コラボレーションに有効期限を設定できず、このフィールドの値によってエラーが返されます。

さらに、コラボレーションに有効期限を指定できるのは、[招待したコラボレータを自動的に削除する] の設定を有効にした後に作成した場合のみです。

Example:

"2019-08-29T23:59:00-07:00"

can_view_path

boolean

招待されたユーザーが招待に関連付けられているフォルダへの親パス全体を見ることができるかどうかを示します。招待されたユーザーには親フォルダ内の権限が付与されないため、自身が参加しているコラボレーションに関係しないコンテンツを閲覧することはできません。

これにより、招待されたユーザーの [すべてのファイル] ページの読み込みに必要な時間が有意に増加することに注意してください。can_view_pathが有効になっているコラボレーションの数を1ユーザーあたり1,000に制限することをお勧めします。

can_view_pathをtrueにしてコラボレータを招待できるのは所有者と共同所有者のみ、既存のコラボレーションでcan_view_pathを更新できるのは所有者のみです。

can_view_pathは、フォルダのコラボレーションのみに使用できます。

When you delete a folder with can_view_path=true, collaborators may still see the parent path. For instructions on how to remove this, see Even though a folder invited via can_view_path is deleted, the path remains displayed.

Example:

true

Response

所有者が変わっていない限り、更新されたコラボレーションオブジェクトを返します。

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

string

required

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

Example:

"12345678"

type

enum<string>

required

値は常にcollaborationになります。

利用可能なオプション:

collaboration

Example:

"collaboration"

item

コラボレーション項目 · object

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

コラボレーション項目
コラボレーション項目
コラボレーション項目

表示子属性

item.id

string

required

ファイルを表す一意の識別子。

ファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/files/123の場合、file_idは123です。

Example:

"12345"

item.type

enum<string>

required

値は常にfileになります。

利用可能なオプション:

file

Example:

"file"

item.etag

string | null

このファイルのHTTP etag。これは変更が発生した場合 (またはしなかった場合) にファイルに対して変更を行う目的でのみ、If-MatchおよびIf-None-Matchヘッダー内の一部のAPIエンドポイントで使用できます。

Example:

"1"

item.sequence_id

string | null

この項目に適用された最新のUser Eventを表す数値の識別子。

これをGET /eventsエンドポイントと組み合わせて使用すると、この識別子が読み取られる前に発生した可能性があるUser Eventを除外できます。

たとえば、Box DriveなどのアプリケーションがAPIを介して項目を取得し、その項目の変更に関連するUser Eventの発生を監視する場合などがこれに該当します。User Eventのsequence_idが最初に取得されたリソースのsequence_idよりも小さいか同じである場合、アプリケーションはそのようなUser Eventをすべて無視します。

Example:

"3"

item.name

string

ファイルの名前。

Example:

"Contract.pdf"

item.sha1

string<digest>

ファイルのSHA1ハッシュ。Box上のファイルとローカルファイルの内容を比較する目的に使用できます。

Example:

"85136C79CBF9FE36BB9D05D0639C70C265C18D37"

item.file_version

ファイルバージョン (Mini) · object

ファイルの現在のバージョンに関する情報。

表示子属性

item.file_version.id

string

required

ファイルバージョンを表す一意の識別子。

Example:

"12345"

item.file_version.type

enum<string>

required

値は常にfile_versionになります。

利用可能なオプション:

file_version

Example:

"file_version"

item.file_version.sha1

string

ファイルの現在のバージョンのSHA1ハッシュ。

Example:

"134b65991ed521fcfe4724b7d814ab8ded5185dc"

item.description

string

このファイルの説明 (省略可)。説明が255文字を超える場合は、最初の255文字がファイルの説明として設定され、残りは無視されます。

Maximum string length: 255

Example:

"Contract for Q1 renewal"

item.size

integer

ファイルサイズ (バイト単位)。この整数を解析する際には、非常に大きな数値となって整数オーバーフローになる可能性があるため、注意が必要です。

Example:

629644

item.path_collection

パスのコレクション · object

ルートフォルダを起点にした、このファイルを含むフォルダツリー。

表示子属性

item.path_collection.total_count

integer<int64>

required

このリスト内のフォルダの数。

Example:

1

item.path_collection.entries

フォルダ (Mini) · object[]

required

この項目の親フォルダ。

表示子属性

item.path_collection.entries.id

string

required

フォルダを表す一意の識別子。

フォルダIDを確認するには、ウェブアプリケーションでフォルダにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/folders/123の場合、folder_idは123です。

Example:

"12345"

item.path_collection.entries.type

enum<string>

required

値は常にfolderになります。

利用可能なオプション:

folder

Example:

"folder"

item.path_collection.entries.etag

string | null

このフォルダのHTTP etag。これは変更が発生した場合 (またはしなかった場合) にフォルダに対して変更を行う目的でのみ、If-MatchおよびIf-None-Matchヘッダー内の一部のAPIエンドポイントで使用できます。

Example:

"1"

item.path_collection.entries.sequence_id

string | null

この項目に適用された最新のUser Eventを表す数値の識別子。

これをGET /eventsエンドポイントと組み合わせて使用すると、この識別子が読み取られる前に発生した可能性があるUser Eventを除外できます。

Example:

"3"

item.path_collection.entries.name

string

フォルダの名前。

Example:

"Contracts"

item.created_at

string<date-time>

Box上でこのファイルが作成された日時。

Example:

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

item.modified_at

string<date-time>

Boxでこのファイルが最後に更新された日時。

Example:

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

item.trashed_at

string<date-time> | null

このファイルがごみ箱に移動された日時。

Example:

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

item.purged_at

string<date-time> | null

このファイルがごみ箱から削除される予定日時。

Example:

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

item.content_created_at

string<date-time> | null

このファイルが最初に作成された日時。この日時はファイルがBoxにアップロードされた時点よりも前になる場合があります。

Example:

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

item.content_modified_at

string<date-time> | null

このファイルが最後に更新された日時。この日時はファイルがBoxにアップロードされた時点よりも前になる場合があります。

Example:

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

item.created_by

ユーザー (Mini) · object

このファイルを作成したユーザー。

表示子属性

item.created_by.id

string

required

このユーザーの一意の識別子。

Example:

"11446498"

item.created_by.type

enum<string>

required

値は常にuserになります。

利用可能なオプション:

user

Example:

"user"

item.created_by.name

string

このユーザーの表示名。

Maximum string length: 50

Example:

"Aaron Levie"

このユーザーのプライマリメールアドレス。

Example:

"ceo@example.com"

item.modified_by

ユーザー (Mini) · object

このファイルを最後に変更したユーザー。

表示子属性

item.modified_by.id

string

required

このユーザーの一意の識別子。

Example:

"11446498"

item.modified_by.type

enum<string>

required

値は常にuserになります。

利用可能なオプション:

user

Example:

"user"

item.modified_by.name

string

このユーザーの表示名。

Maximum string length: 50

Example:

"Aaron Levie"

このユーザーのプライマリメールアドレス。

Example:

"ceo@example.com"

item.owned_by

ユーザー (Mini) · object

このファイルを所有するユーザー。

表示子属性

item.owned_by.id

string

required

このユーザーの一意の識別子。

Example:

"11446498"

item.owned_by.type

enum<string>

required

値は常にuserになります。

利用可能なオプション:

user

Example:

"user"

item.owned_by.name

string

このユーザーの表示名。

Maximum string length: 50

Example:

"Aaron Levie"

このユーザーのプライマリメールアドレス。

Example:

"ceo@example.com"

item.shared_link

共有リンク · object

このファイルの共有リンク。このファイルに対してまだ共有リンクが作成されていない場合、この値はnullになります。

表示子属性

item.shared_link.url

string<url>

required

Box上の項目にアクセスするために使用できるURL。

このURLに移動すると、BoxのプレビューUIに項目が表示され、許可されている場合は、このUIからファイルをダウンロードできます。

このURLは、この共有リンクに対してカスタムのvanity_urlが設定されている場合でも動作します。

Example:

"https://www.box.com/s/vspke7y05sb214wjokpk"

item.shared_link.effective_access

enum<string>

required

共有リンクの実際のアクセスレベル。許可されるアクセスレベルが会社の設定で制限されている場合は、accessフィールドの値よりも低いアクセスレベルになることがあります。

利用可能なオプション:

open,

company,

collaborators

Example:

"company"

item.shared_link.effective_permission

enum<string>

required

この共有リンクの実際の権限。これらにより、共有リンクの権限と、管理者、所有者、任意の先祖項目 (フォルダなど) によって設定される項目の権限の組み合わせの制限が厳しくなります。

利用可能なオプション:

can_edit,

can_download,

can_preview,

no_access

Example:

"can_download"

item.shared_link.is_password_enabled

boolean

required

共有リンクを通じて項目にアクセスする際にパスワードを要求するかどうかを定義します。

Example:

true

item.shared_link.download_count

integer

required

この項目がダウンロードされた回数。

Example:

3

item.shared_link.preview_count

integer

required

この項目がプレビューされた回数。

Example:

3

item.shared_link.download_url

string<url> | null

ファイルをダウンロードするために使用できるURL。このURLをブラウザで使用すると、ファイルをダウンロードできます。このURLには、ファイルを正しいファイルタイプで保存できるように、ファイル拡張子が含まれます。

フォルダの場合、このプロパティはnullになります。

Example:

"https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg"

item.shared_link.vanity_url

string<url> | null

Boxで項目をプレビューする目的にも使用できる「カスタムURL」。カスタムURLの作成と変更は、Boxウェブアプリケーションでのみ行えます。

Example:

"https://acme.app.box.com/v/my_url/"

item.shared_link.vanity_name

string | null

vanity_urlフィールドで使用される、共有リンクのカスタム名。

Example:

"my_url"

item.shared_link.access

enum<string>

この共有リンクのアクセスレベル

open - このリンクを知っている全員にこの項目へのアクセスを許可します
company - 同じ会社のユーザーにのみこの項目へのアクセスを許可します
collaborators - この項目のコラボレータとなっているユーザーに対してのみこの項目へのアクセスを許可します

共有リンクの作成時にこのフィールドを省略した場合は、Enterprise管理者によって指定されたデフォルトのアクセスレベルに設定されます。

利用可能なオプション:

open,

company,

collaborators

Example:

"open"

item.shared_link.unshared_at

string<date-time> | null

このリンクが共有解除される日時。このフィールドを設定できるのは、有料アカウントを持つユーザーのみです。

Example:

"2018-04-13T13:53:23-07:00"

item.shared_link.permissions

object

このリンクを通じてユーザーが項目のプレビュー、編集、およびダウンロードを行うことを許可するかどうかを定義します。これらの権限は、共有リンクのみに適用され、その項目自体に適用される権限より優先されることはありません。

表示子属性

item.shared_link.permissions.can_download

boolean

required

共有リンクを通じて項目をダウンロードすることを許可するかどうかを定義します。フォルダの共有リンクの場合、この設定はフォルダ内のすべての項目にも適用されます。

実際のアクセスレベルがcollaboratorsではなく、openまたはcompanyに設定されている場合は、この値をtrueに設定できます。

Example:

true

item.shared_link.permissions.can_preview

boolean

required

共有リンクを通じて項目をプレビューすることを許可するかどうかを定義します。

この値は常にtrueです。フォルダの共有リンクの場合、この設定はフォルダ内のすべての項目にも適用されます。

Example:

true

item.shared_link.permissions.can_edit

boolean

required

共有リンクからの項目の編集を許可するかどうかを定義します。

can_downloadがtrueで、項目のタイプがfileの場合のみ、この値もtrueに設定できます。

Example:

false

item.parent

フォルダ (Mini) · object

このフォルダが配置されているフォルダ。ルートフォルダやごみ箱フォルダなど、一部のフォルダの場合、この値はnullになる可能性があります。

表示子属性

item.parent.id

string

required

フォルダを表す一意の識別子。

Example:

"12345"

item.parent.type

enum<string>

required

値は常にfolderになります。

利用可能なオプション:

folder

Example:

"folder"

item.parent.etag

string | null

Example:

"1"

item.parent.sequence_id

string | null

この項目に適用された最新のUser Eventを表す数値の識別子。

これをGET /eventsエンドポイントと組み合わせて使用すると、この識別子が読み取られる前に発生した可能性があるUser Eventを除外できます。

Example:

"3"

item.parent.name

string

フォルダの名前。

Example:

"Contracts"

item.item_status

enum<string>

この項目が削除されたかどうかを定義します。

active - 項目がごみ箱に移動されていない場合。
trashed - 項目がごみ箱に移動されているが、まだ削除されていない場合。
deleted - 項目がすでに完全に削除されている場合。

利用可能なオプション:

active,

trashed,

deleted

Example:

"active"

app_item

アプリ項目 · object

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

表示子属性

app_item.id

string

required

このアプリ項目の一意の識別子。

Example:

"12345678"

app_item.type

enum<string>

required

値は常にapp_itemになります。

利用可能なオプション:

app_item

Example:

"app_item"

app_item.application_type

string

required

このアプリ項目を所有するアプリの種類。

Example:

"hubs"

accessible_by

コラボレーションのアクセス権限付与者 · object

アクセス権限が付与されるユーザーまたはグループ。ユーザーのMini版の表示は、ステータスがpendingの場合にのみ返すことができます。他のリソース内にネストされたときに使用されるユーザーのMini版の表示。

コラボレーションのアクセス権限付与者
コラボレーションのアクセス権限付与者

表示子属性

accessible_by.id

string

required

このユーザーの一意の識別子。

Example:

"11446498"

accessible_by.type

enum<string>

required

値は常にuserになります。

利用可能なオプション:

user

Example:

"user"

accessible_by.name

string

このユーザーの表示名。コラボレーションのステータスがpendingの場合、空の文字列が返されます。

Maximum string length: 50

Example:

"Aaron Levie"

このユーザーのプライマリメールアドレス。コラボレーションのステータスがpendingの場合、空の文字列が返されます。

Example:

"ceo@example.com"

accessible_by.is_active

boolean

falseに設定した場合、ユーザーは非アクティブになるか削除されます。

Example:

true

invite_email

string | null

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

Example:

"john@example.com"

role

enum<string>

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

利用可能なオプション:

editor,

viewer,

previewer,

uploader,

previewer uploader,

viewer uploader,

co-owner,

owner

Example:

"editor"

expires_at

string<date-time> | null

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

Example:

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

is_access_only

boolean

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

Example:

true

status

enum<string>

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

利用可能なオプション:

accepted,

pending,

rejected

Example:

"accepted"

acknowledged_at

string<date-time>

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

Example:

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

created_by

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

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

表示子属性

created_by.id

string

required

このユーザーの一意の識別子。

Example:

"11446498"

created_by.type

enum<string>

required

値は常にuserになります。

利用可能なオプション:

user

Example:

"user"

created_by.name

string

このユーザーの表示名。コラボレーションのステータスがpendingの場合、空の文字列が返されます。

Maximum string length: 50

Example:

"Aaron Levie"

このユーザーのプライマリメールアドレス。コラボレーションのステータスがpendingの場合、空の文字列が返されます。

Example:

"ceo@example.com"

created_by.is_active

boolean

falseに設定した場合、ユーザーは非アクティブになるか削除されます。

Example:

true

Example:

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

created_at

string<date-time>

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

Example:

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

modified_at

string<date-time>

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

Example:

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

acceptance_requirements_status

object

表示子属性

acceptance_requirements_status.terms_of_service_requirement

object

表示子属性

acceptance_requirements_status.terms_of_service_requirement.is_accepted

boolean | null

サービス利用規約に同意済みかどうか。利用規約への同意が必要ない場合、このフィールドはnullです。

Example:

true

acceptance_requirements_status.terms_of_service_requirement.terms_of_service

サービス利用規約 (Base) · object

コラボレーションが承認される前に同意する必要があるサービス利用規約。利用規約への同意が必要ない場合、このフィールドはnullです。

表示子属性

acceptance_requirements_status.terms_of_service_requirement.terms_of_service.id

string

required

このサービス利用規約の一意の識別子。

Example:

"11446498"

acceptance_requirements_status.terms_of_service_requirement.terms_of_service.type

enum<string>

required

値は常にterms_of_serviceになります。

利用可能なオプション:

terms_of_service

Example:

"terms_of_service"

acceptance_requirements_status.strong_password_requirement

object

表示子属性

acceptance_requirements_status.strong_password_requirement.enterprise_has_strong_password_required_for_external_users

boolean

コンテンツを所有する企業が、コンテンツのコラボレーションに強力なパスワードを要求するかどうか、または外部コラボレータに対して漏えいが確認されたパスワードの検出を適用するかどうか。

Example:

true

acceptance_requirements_status.strong_password_requirement.user_has_strong_password

boolean | null

ユーザーのアカウントに対して、強力なパスワードの要求と漏えいが確認されたパスワードの検出が設定されているかどうか。強力なパスワードが要求されていない場合、このフィールドはnullになります。

Example:

true

acceptance_requirements_status.two_factor_authentication_requirement

object

表示子属性

acceptance_requirements_status.two_factor_authentication_requirement.enterprise_has_two_factor_auth_enabled

boolean

このコンテンツを所有する会社が、このコンテンツでのコラボレーションを行うために2要素認証を有効にする必要があるかどうか。

Example:

true

acceptance_requirements_status.two_factor_authentication_requirement.user_has_two_factor_authentication_enabled

boolean | null

ユーザーが2要素認証を有効にしているかどうか。2要素認証が必要ない場合、このフィールドはnullです。

Example:

true