Box Hubドキュメントリソース

Box Hubドキュメント要素 (ページとコンテンツブロック) を取得するために使用される、一連のエンドポイント。

Box Hubドキュメントブロック

Hubドキュメントブロックのリスト。

属性と例

プロパティ	型	必須	説明
`entries`	array of `Box Hubドキュメントブロックエントリ`	はい	ブロックの順序付きリスト。
`type`	`enum<string>`	はい	値は常に`document_blocks`になります。使用可能なオプション: `document_blocks`.
`limit`	`integer`	いいえ	これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。最大値はAPIによって異なります。
`next_marker`	`string`	いいえ	次の検索結果ページの開始場所のマーカー。 `null` を指定できます。

例

{
  "entries": [
    {
      "id": "c9588f08-22d7-4d17-8ca9-f1e61c98c0bd",
      "parent_id": "d97f7c26-0d9b-42a1-a00d-6e6db9619e0f",
      "type": "paragraph",
      "fragment": "This is the paragraph"
    }
  ],
  "type": "document_blocks",
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"
}

Box Hubドキュメントページ

Box Hubドキュメント内のページ。

属性と例

プロパティ	型	必須	説明
`id`	`string`	はい	このページの一意の識別子。
`type`	`string`	はい	このリソースのタイプ。値は常に`page`になります。
`parent_id`	`string`	いいえ	親ページの一意の識別子。ルートレベルのページの場合はNull。 `null` を指定できます。
`title_fragment`	`string`	はい	ページのタイトルテキスト。リッチテキストの書式設定を含みます。

例

{
  "id": "d97f7c26-0d9b-42a1-a00d-6e6db9619e0f",
  "type": "page",
  "parent_id": "d97f7c26-0d9b-42a1-a00d-6e6db9619e0f",
  "title_fragment": "This is the home page title"
}

Box Hubドキュメントページ

Hubドキュメントページのリスト。

属性と例

プロパティ	型	必須	説明
`entries`	array of Box Hubドキュメントページ	はい	ページの順序付きリスト。
`type`	`enum<string>`	はい	値は常に`document_pages`になります。使用可能なオプション: `document_pages`.
`limit`	`integer`	いいえ	これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。最大値はAPIによって異なります。
`next_marker`	`string`	いいえ	次の検索結果ページの開始場所のマーカー。 `null` を指定できます。

例

{
  "entries": [
    {
      "id": "d97f7c26-0d9b-42a1-a00d-6e6db9619e0f",
      "type": "page",
      "parent_id": "d97f7c26-0d9b-42a1-a00d-6e6db9619e0f",
      "title_fragment": "This is the home page title"
    }
  ],
  "type": "document_pages",
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"
}

Box Hubのセクションタイトルテキストブロック

Box Hubドキュメント内のセクションタイトルブロック。

属性と例

プロパティ	型	必須	説明
`id`	`string`	はい	このブロックの一意の識別子。
`parent_id`	`string`	いいえ	親ブロックの一意の識別子。ページの直接の子の場合はNull。 `null` を指定できます。
`type`	`enum<string>`	はい	このブロックのタイプ。値は常に`section_title`になります。使用可能なオプション: `section_title`.
`fragment`	`string`	はい	ブロックのテキストコンテンツ。リッチテキストの書式設定を含みます。

例

{
  "id": "c9588f08-22d7-4d17-8ca9-f1e61c98c0bd",
  "parent_id": "d97f7c26-0d9b-42a1-a00d-6e6db9619e0f",
  "type": "section_title",
  "fragment": "This is the section title"
}

Box Hubの区切り線ブロック

Box Hubドキュメント内の区切り線ブロック。

属性と例

プロパティ	型	必須	説明
`id`	`string`	はい	このブロックの一意の識別子。
`parent_id`	`string`	いいえ	親ブロックの一意の識別子。ページの直接の子の場合はNull。 `null` を指定できます。
`type`	`enum<string>`	はい	このブロックのタイプ。値は常に`divider`になります。使用可能なオプション: `divider`.

例

{
  "id": "c9588f08-22d7-4d17-8ca9-f1e61c98c0bd",
  "parent_id": "d97f7c26-0d9b-42a1-a00d-6e6db9619e0f",
  "type": "divider"
}

Box Hubの項目リストブロック

Box Hubドキュメント内の項目リストブロック。

属性と例

プロパティ	型	必須	説明
`id`	`string`	はい	このブロックの一意の識別子。
`parent_id`	`string`	いいえ	親ブロックの一意の識別子。ページの直接の子の場合はNull。 `null` を指定できます。
`type`	`enum<string>`	はい	このブロックのタイプ。値は常に`item_list`になります。使用可能なオプション: `item_list`.

例

{
  "id": "c9588f08-22d7-4d17-8ca9-f1e61c98c0bd",
  "parent_id": "d97f7c26-0d9b-42a1-a00d-6e6db9619e0f",
  "type": "item_list"
}

Box Hubの吹き出しテキストブロック

Box Hubドキュメント内の吹き出しブロック。

属性と例

プロパティ	型	必須	説明
`id`	`string`	はい	このブロックの一意の識別子。
`parent_id`	`string`	いいえ	親ブロックの一意の識別子。ページの直接の子の場合はNull。 `null` を指定できます。
`type`	`enum<string>`	はい	このブロックのタイプ。値は常に`callout_box`になります。使用可能なオプション: `callout_box`.
`fragment`	`string`	はい	ブロックのテキストコンテンツ。リッチテキストの書式設定を含みます。

例

{
  "id": "c9588f08-22d7-4d17-8ca9-f1e61c98c0bd",
  "parent_id": "d97f7c26-0d9b-42a1-a00d-6e6db9619e0f",
  "type": "callout_box",
  "fragment": "This is the callout box"
}

Box Hubの段落テキストブロック

Box Hubドキュメント内の段落ブロック。

属性と例

プロパティ	型	必須	説明
`id`	`string`	はい	このブロックの一意の識別子。
`parent_id`	`string`	いいえ	親ブロックの一意の識別子。ページの直接の子の場合はNull。 `null` を指定できます。
`type`	`enum<string>`	はい	このブロックのタイプ。値は常に`paragraph`になります。使用可能なオプション: `paragraph`.
`fragment`	`string`	はい	ブロックのテキストコンテンツ。リッチテキストの書式設定を含みます。

例

{
  "id": "c9588f08-22d7-4d17-8ca9-f1e61c98c0bd",
  "parent_id": "d97f7c26-0d9b-42a1-a00d-6e6db9619e0f",
  "type": "paragraph",
  "fragment": "This is the paragraph"
}

​Box Hubドキュメントブロック

​Box Hubドキュメントページ

​Box Hubドキュメントページ

​Box Hubのセクションタイトルテキストブロック

​Box Hubの区切り線ブロック

​Box Hubの項目リストブロック

​Box Hubの吹き出しテキストブロック

​Box Hubの段落テキストブロック

Box Hubドキュメントブロック

Box Hubドキュメントページ

Box Hubドキュメントページ

Box Hubのセクションタイトルテキストブロック

Box Hubの区切り線ブロック

Box Hubの項目リストブロック

Box Hubの吹き出しテキストブロック

Box Hubの段落テキストブロック