Box Hub
任意のBox Hubs APIエンドポイントからデフォルトで返されるBox HubのStandard版の表示。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | はい | Box Hubを表す一意の識別子。 Box HubのIDを確認するには、ウェブアプリでBox Hubにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/hubs/123の場合、hub_idは123です。 |
type | enum<string> | はい | 値は常にhubsになります。 使用可能なオプション: hubs. |
title | string | いいえ | Box Hubのタイトル。 |
description | string | いいえ | Box Hubの説明。最初の200文字が返されます。 |
created_at | string | いいえ | このフォルダが作成された日時。ルートフォルダやごみ箱フォルダなど、一部のフォルダの場合、この値はnullになる場合があります。 |
updated_at | string | いいえ | Box Hubが最後に更新された日時。 |
created_by | ユーザー (Mini) | いいえ | このBox Hubを作成したユーザー。 |
updated_by | ユーザー (Mini) | いいえ | このBox Hubを最後に変更したユーザー。 |
view_count | integer | いいえ | Box Hubの表示回数。 |
is_ai_enabled | boolean | いいえ | AI機能がBox Hubに対して有効になっているかどうかを示します。 |
is_collaboration_restricted_to_enterprise | boolean | いいえ | コラボレーションが企業に制限されているかどうかを示します。 |
can_non_owners_invite | boolean | いいえ | 所有者以外のユーザーが他のユーザーをBox Hubに招待できるかどうかを示します。 |
can_shared_link_be_created | boolean | いいえ | Box Hubに対して共有リンクを作成できるかどうかを示します。 |
can_public_shared_link_be_created | boolean | いいえ | Box Hubに対して公開共有リンクを作成できるかどうかを示します。 |
copy_hub_access | enum<string> | いいえ | Box Hubをコピーできるユーザーを指定します。 - all - Hubにアクセス可能な任意のユーザーがコピーできます。 - company - Hubと同じ企業内のユーザーのみがコピーできます。 - none - どのユーザーもHubをコピーできません。 使用可能なオプション: all, company, none. |
例
{
"id": "12345",
"type": "hubs",
"title": "Contracts",
"description": "All the contracts for the company.",
"created_at": "2012-12-12T10:53:43Z",
"updated_at": "2012-12-12T10:53:43Z",
"created_by": {
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
},
"updated_by": {
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
},
"view_count": 506,
"is_ai_enabled": true,
"is_collaboration_restricted_to_enterprise": true,
"can_non_owners_invite": true,
"can_shared_link_be_created": true,
"can_public_shared_link_be_created": true,
"copy_hub_access": "company"
}
Box Hub (Base)
最も基本的なBox HubのBase版の表示。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | はい | Box Hubを表す一意の識別子。 Box HubのIDを確認するには、ウェブアプリでBox Hubにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/hubs/123の場合、hub_idは123です。 |
type | enum<string> | はい | 値は常にhubsになります。 使用可能なオプション: hubs. |
例
{
"id": "12345",
"type": "hubs"
}
Box Hubs
Hubのページ割りされたリスト。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
entries | array of Box Hub | いいえ | Hubのリスト。 |
limit | integer | いいえ | これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータのlimitと等しくなります。最大値はAPIによって異なります。 |
next_marker | string | いいえ | 次の検索結果ページの開始場所のマーカー。 null を指定できます。 |
例
{
"entries": [
{
"id": "12345",
"type": "hubs",
"title": "Contracts",
"description": "All the contracts for the company.",
"created_at": "2012-12-12T10:53:43Z",
"updated_at": "2012-12-12T10:53:43Z",
"created_by": {
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
},
"updated_by": {
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
},
"view_count": 506,
"is_ai_enabled": true,
"is_collaboration_restricted_to_enterprise": true,
"can_non_owners_invite": true,
"can_shared_link_be_created": true,
"can_public_shared_link_be_created": true,
"copy_hub_access": "company"
}
],
"limit": 1000,
"next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"
}