Box Doc Genテンプレートリソース

Doc Genテンプレートは、ドキュメントを生成するための入力として使用されます。

Box Doc Genタグ

Box Doc Genタグのリスト。

属性と例

プロパティ	型	必須	説明
`limit`	`integer`	いいえ	これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。最大値はAPIによって異なります。
`next_marker`	`string`	いいえ	次の検索結果ページの開始場所のマーカー。 `null` を指定できます。
`prev_marker`	`string`	いいえ	前の検索結果ページの開始場所のマーカー。 `null` を指定できます。
`entries`	array of Box Doc Genテンプレートタグ	いいえ	タグのリスト。

例

{
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
  "entries": [
    {
      "tag_content": "{{item.name}}",
      "tag_type": "text",
      "json_paths": [
        "products",
        "products.name"
      ]
    }
  ]
}

Box Doc Genタグの処理メッセージ

ドキュメントのタグがまだ処理中であることをユーザーに通知するメッセージ。

属性と例

プロパティ	型	必須	説明
`message`	`string`	はい	ドキュメントのタグがまだ処理中であることをユーザーに通知するメッセージ。読み取り専用。

例

{
  "message": "Processing tags for this file."
}

Box Doc Genテンプレート

Box Doc Genテンプレートオブジェクト。

属性と例

プロパティ	型	必須	説明
`file`	`ファイル参照`	いいえ	ドキュメントの生成元となるファイルを有効にします。
`file_name`	`string`	いいえ	テンプレートの名前。 `null` を指定できます。

例

{
  "file": {
    "type": "file",
    "id": "42037322"
  },
  "file_name": "Official contract"
}

Box Doc Genテンプレート

Box Doc Genテンプレートのリスト。

属性と例

プロパティ	型	必須	説明
`limit`	`integer`	いいえ	これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。最大値はAPIによって異なります。
`next_marker`	`string`	いいえ	次の検索結果ページの開始場所のマーカー。 `null` を指定できます。
`prev_marker`	`string`	いいえ	前の検索結果ページの開始場所のマーカー。 `null` を指定できます。
`entries`	array of Box Doc Genテンプレート	いいえ	テンプレートのリスト。

例

{
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
  "entries": [
    {
      "file": {
        "type": "file",
        "id": "42037322"
      },
      "file_name": "Official contract"
    }
  ]
}

Box Doc Genテンプレートタグ

Box Doc Genテンプレートタグオブジェクト。

属性と例

プロパティ	型	必須	説明
`tag_content`	`string`	はい	タグの内容。読み取り専用。
`tag_type`	`enum<string>`	はい	タグの種類。使用可能なオプション: `text`, `arithmetic`, `conditional`, `for-loop`, `table-loop`, `image`. 読み取り専用。
`json_paths`	array of `string`	はい	パスのリスト。読み取り専用。

例

{
  "tag_content": "{{item.name}}",
  "tag_type": "text",
  "json_paths": [
    "products",
    "products.name"
  ]
}

​Box Doc Genタグ

​Box Doc Genタグの処理メッセージ

​Box Doc Genテンプレート

​Box Doc Genテンプレート

​Box Doc Genテンプレートタグ

Box Doc Genタグ

Box Doc Genタグの処理メッセージ

Box Doc Genテンプレート

Box Doc Genテンプレート

Box Doc Genテンプレートタグ