Collaboration
アクセス制御リストと同様に、コラボレーションではファイルとフォルダに 対するユーザーおよびグループのアクセス権限が定義されます。コラボレーションオブジェクトは、特定のロールによって定義される権限を含んだファイルまたはフォルダへのアクセス権限をユーザーまたはグループに付与します。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | はい | このコラボレーションの一意の識別子。 |
type | enum<string> | はい | 値は常にcollaborationになります。 使用可能なオプション: collaboration. |
item | コラボレーション項目 | いいえ | アクセスが許可されているファイルまたはフォルダ。コラボレーションのstatusがpendingの場合またはコラボレーションがアプリ項目に作成されている場合 (app_itemフィールド参照)、このフィールドはnullです。 null を指定できます。 |
app_item | アプリ項目 | いいえ | アクセスが許可されているapp_item。コラボレーションが項目に作成されている場合 (itemフィールド参照) またはapp_itemにアクセスできない場合、このフィールドはnullです。ロールは、app_itemに関連付けられたすべての項目にカスケードされます。 null を指定できます。 |
accessible_by | コラボレーションのアクセス権限付与者 | いいえ | |
invite_email | string | いいえ | 登録済みユーザーでない未登録コラボレータを招待するために使用されたメールアドレス。 null を指定できます。 |
role | enum<string> | いいえ | 付与されるアクセスレベル。 使用可能なオプション: editor, viewer, previewer, uploader, previewer uploader, viewer uploader, co-owner, owner. |
expires_at | string | いいえ | コラボレーションの有効期限。有効期限が設定されていない場合はnull。 null を指定できます。 |
is_access_only | boolean | いいえ | trueに設定した場合、コラボレータは共有項目にアクセスできますが、これらの項目は [すべてのファイル] リストに表示されません。また、コラボレータには共有項目のルートフォルダのパスも表示されません。 |
status | enum<string> | いいえ | コラボレーション招待のステータス。ステータスがpendingの場合、nameは空の文字列を返します。 使用可能なオプション: accepted, pending, rejected. |
acknowledged_at | string | いいえ | コラボレーションオブジェクトのstatusがacceptedまたはrejectedに変更された日時。 |
created_by | ユーザー (コラボレーション) | いいえ | コラボレーションオブジェクトを作成したユーザー。 |
created_at | string | いいえ | コラボレーションオブジェクトが作成された日時。 |
modified_at | string | いいえ | コラボレーションオブジェクトが最後に変更された日時。 |
acceptance_requirements_status | object | いいえ |
例
{
"id": "12345678",
"type": "collaboration",
"item": {
"id": "12345",
"etag": "1",
"type": "file",
"sequence_id": "3",
"name": "Contract.pdf",
"sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
"file_version": {
"id": "12345",
"type": "file_version",
"sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
},
"description": "Contract for Q1 renewal",
"size": 629644,
"path_collection": {
"total_count": 1,
"entries": [
{
"id": "12345",
"etag": "1",
"type": "folder",
"sequence_id": "3",
"name": "Contracts"
}
]
},
"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",
"created_by": {
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
},
"modified_by": {
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
},
"owned_by": {
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
},
"shared_link": {
"url": "https://www.box.com/s/vspke7y05sb214wjokpk",
"download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",
"vanity_url": "https://acme.app.box.com/v/my_url/",
"vanity_name": "my_url",
"access": "open",
"effective_access": "company",
"effective_permission": "can_download",
"unshared_at": "2018-04-13T13:53:23-07:00",
"is_password_enabled": true,
"permissions": {
"can_download": true,
"can_preview": true,
"can_edit": false
},
"download_count": 3,
"preview_count": 3
},
"parent": {
"id": "12345",
"etag": "1",
"type": "folder",
"sequence_id": "3",
"name": "Contracts"
},
"item_status": "active"
},
"app_item": {
"id": "12345678",
"type": "app_item",
"application_type": "hubs"
},
"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": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com",
"is_active": true
},
"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,
"terms_of_service": {
"id": "11446498",
"type": "terms_of_service"
}
},
"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
}
}
}
Collaborations
コラボレーションのリスト。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
limit | integer | いいえ | これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータのlimitと等しくなります。最大値はAPIによって異なります。 |
next_marker | string | いいえ | 次の検索結果ページの開始場所のマーカー。 null を指定できます。 |
prev_marker | string | いいえ | 前の検索結果ページの開始場所のマーカー。 null を指定できます。 |
entries | array of Collaboration | いいえ | コラボレーションのリスト。 |
例
{
"limit": 1000,
"next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
"prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
"entries": [
{
"id": "12345678",
"type": "collaboration",
"item": {
"id": "12345",
"etag": "1",
"type": "file",
"sequence_id": "3",
"name": "Contract.pdf",
"sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
"file_version": {
"id": "12345",
"type": "file_version",
"sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
},
"description": "Contract for Q1 renewal",
"size": 629644,
"path_collection": {
"total_count": 1,
"entries": [
{
"id": "12345",
"etag": "1",
"type": "folder",
"sequence_id": "3",
"name": "Contracts"
}
]
},
"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",
"created_by": {
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
},
"modified_by": {
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
},
"owned_by": {
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
},
"shared_link": {
"url": "https://www.box.com/s/vspke7y05sb214wjokpk",
"download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",
"vanity_url": "https://acme.app.box.com/v/my_url/",
"vanity_name": "my_url",
"access": "open",
"effective_access": "company",
"effective_permission": "can_download",
"unshared_at": "2018-04-13T13:53:23-07:00",
"is_password_enabled": true,
"permissions": {
"can_download": true,
"can_preview": true,
"can_edit": false
},
"download_count": 3,
"preview_count": 3
},
"parent": {
"id": "12345",
"etag": "1",
"type": "folder",
"sequence_id": "3",
"name": "Contracts"
},
"item_status": "active"
},
"app_item": {
"id": "12345678",
"type": "app_item",
"application_type": "hubs"
},
"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": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com",
"is_active": true
},
"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,
"terms_of_service": {
"id": "11446498",
"type": "terms_of_service"
}
},
"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
}
}
}
]
}
Collaborations
コラボレーションのリスト。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
total_count | integer | いいえ | コレクション全体の最後のエントリのオフセットに1を加算した値。コレクション内のエントリの合計数は、total_countよりも少ない場合があります。 このフィールドは、オフセットベースのページネーションを使用する呼び出しのみで返されます。マーカーベースでページネーションされたAPIでは、このフィールドは省略されます。 |
limit | integer | いいえ | これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータのlimitと等しくなります。最大値はAPIによって異なります。 |
offset | integer | いいえ | このセットに含まれる最初のエントリのゼロから始まるオフセット。これは、offsetクエリパラメータと同じになります。 このフィールドは、オフセットベースのページネーションを使用する呼び出しのみで返されます。マーカーベースでページネーションされたAPIでは、このフィールドは省略されます。 |
entries | array of Collaboration | いいえ | コラボレーションのリスト。 |
例
{
"total_count": 5000,
"limit": 1000,
"offset": 2000,
"entries": [
{
"id": "12345678",
"type": "collaboration",
"item": {
"id": "12345",
"etag": "1",
"type": "file",
"sequence_id": "3",
"name": "Contract.pdf",
"sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
"file_version": {
"id": "12345",
"type": "file_version",
"sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
},
"description": "Contract for Q1 renewal",
"size": 629644,
"path_collection": {
"total_count": 1,
"entries": [
{
"id": "12345",
"etag": "1",
"type": "folder",
"sequence_id": "3",
"name": "Contracts"
}
]
},
"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",
"created_by": {
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
},
"modified_by": {
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
},
"owned_by": {
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
},
"shared_link": {
"url": "https://www.box.com/s/vspke7y05sb214wjokpk",
"download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",
"vanity_url": "https://acme.app.box.com/v/my_url/",
"vanity_name": "my_url",
"access": "open",
"effective_access": "company",
"effective_permission": "can_download",
"unshared_at": "2018-04-13T13:53:23-07:00",
"is_password_enabled": true,
"permissions": {
"can_download": true,
"can_preview": true,
"can_edit": false
},
"download_count": 3,
"preview_count": 3
},
"parent": {
"id": "12345",
"etag": "1",
"type": "folder",
"sequence_id": "3",
"name": "Contracts"
},
"item_status": "active"
},
"app_item": {
"id": "12345678",
"type": "app_item",
"application_type": "hubs"
},
"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": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com",
"is_active": true
},
"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,
"terms_of_service": {
"id": "11446498",
"type": "terms_of_service"
}
},
"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
}
}
}
]
}