ドキュメントの生成
ドキュメントの生成
POST /2.0/docgen_batches
エンドポイントを使用すると、Box Doc Genテンプレートを入力データとして使用してドキュメントを生成できます。
前提条件
Box Doc Gen APIの使用を開始する前に、Box Doc Genの使い方ガイドに記載されている手順に従って、PlatformアプリとBox Doc Genテンプレートを作成してください。
リクエストの送信
ドキュメント (複数可) を生成するには、POST /2.0/docgen_batches
エンドポイントを使用します。
パラメータ
コールを実行するには、以下のパラメータを渡す必要があります。必須のパラメータは太字で示されています。
パラメータ | 説明 | 例 |
---|---|---|
file.id | Box Doc Genテンプレートとして設定するファイルのID。 | 12345678 |
file.type | 指定した入力データの種類。値は常に**file **になります。 | file |
file_version | テンプレートのファイルバージョン。 | 12345 |
input_source | 生成されるドキュメントの入力ソース。この値は、APIベースのすべてのドキュメント生成リクエストでapi にする必要があります。 | api |
output_type | 出力ファイルの種類。 | docx , pdf |
destination_folder.id | 生成されたドキュメントが保存されるフォルダのID。 | 12345678 |
destination_folder.type | 保存先の項目の種類。生成されたファイルはフォルダに保存されるため、値は常に**folder **になります。 | file |
document_generation_data.generated_file_name | 生成されるファイルの名前。 | New_Template |
document_generation_data.user_input |