メインコンテンツへスキップ

Documentation Index

Fetch the complete documentation index at: https://developer.box.com/llms.txt

Use this file to discover all available pages before exploring further.

POST /2.0/docgen_batchesエンドポイントを使用すると、Box Doc Genテンプレートを入力データとして使用してドキュメントを生成できます。

​
前提条件

Box Doc Gen APIの使用を開始する前に、ガイドに記載されている手順に従って、PlatformアプリとBox Doc Genテンプレートを作成してください。

​
リクエストの送信

ドキュメント (複数可) を生成するには、POST /2.0/docgen_batchesエンドポイントを使用します。

​
パラメータ

コールを実行するには、以下のパラメータを渡す必要があります。必須のパラメータは太字で示されています。
パラメータ説明例
file.idBox 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ドキュメントの生成に使用するJSONデータ。{"id": 2, "name": "Ink Cartridge", "type": "non-fragile"}

​
ユースケース

Box Doc GenテンプレートとJSONデータを準備できたら、Box Doc Gen APIにドキュメント生成のリクエストを行うことができます。 コールのサンプルは次のようになります。 
curl -L 'https://api.box.com/2.0/docgen_batches' \
     -H 'box-version: 2025.0' \
     -H 'Authorization: Bearer <ACCESS_TOKEN>' \
     -D '{
        "file": {
            "id": "12345678",
            "type": "file"
        },
        "input_source": "api",
        "destination_folder": {
            "id": "12345678",
            "type": "folder"
        },
        "output_type": "docx",
        "document_generation_data": [
            {
                "generated_file_name": "Image test",
                "user_input": {
                    "order": {
                        "id": "12305",
                        "date": "18-08-2023",
                        "country": "US",
                        "expiryDate": "18-08-2024",
                        "currency": "$",
                        "amount": 5060.5,
                        "taxRate": 10,
                        "requester": "John",
                        "approver": "Smith",
                        "department": "Procurement",
                        "paymentTerms": "30 days",
                        "deliveryTerms": "30 days",
                        "deliveryDate": "18-09-2023",
                        "vendor": {
                            "company": "Example company",
                            "address": {
                                "street": "Example street",
                                "city": "Example city",
                                "zip": "EX-456"
                            }
                        },
                        "products": [
                            {
                                "id": 1,
                                "name": "A4 Papers",
                                "type": "non-fragile",
                                "quantity": 100,
                                "price": 29,
                                "amount": 2900
                            },
                            {
                                "id": 2,
                                "name": "Ink  Cartridge",
                                "type": "non-fragile",
                                "quantity": 40,
                                "price": 39,
                                "amount": 1560
                            },
                            {
                                "id": 3,
                                "name": "Adhesive tape",
                                "type": "non-fragile",
                                "quantity": 20,
                                "price": 30,
                                "amount": 600.5
                            }
                        ]
                    }
                }
            }
        ]`
リクエストが処理されている間、document_generation_data配列の各エントリは個別のドキュメント生成ジョブとして処理され、そのジョブは、Box Doc Genによってドキュメント生成キューに追加されます。 生成されたドキュメントは、指定したフォルダに保存されます。