APIバージョン 2025.0
Box Doc GenジョブのFull版の表示。
このリソースにはAPIの使用時に発生する可能性があるいくつかのバリエーションがあります。Fullバリアントに含まれるフィールドは、fieldsパラメータをサポートするAPIエンドポイントによって返すことができます。たとえば、IDでファイルを取得するときに、fieldsリクエストパラメータをid,typeに設定すると、これらのフィールドのみがAPIレスポンスで返されます。
例 12345Box Doc Genジョブを表す一意の識別子。
例 docgen_job値は常にdocgen_jobになります。次の値に固定: docgen_job
batch
Box Doc Genのバッチ (Base)object
ジョブが属しているBox Doc Genのバッチ。
例 2022-05-11T10:56:11-07:00ジョブの作成時刻。
ジョブを作成したユーザー。
例 user値は常にuserになります。次の値に固定: user
企業のID。
例 enterprise値は常にenterpriseになります。次の値に固定: enterprise
ジョブの出力ファイル。このプロパティは、ジョブが完了するまでnullとなります。
例 file値は常にfileになります。次の値に固定: file
出力ファイルのファイルバージョン。このプロパティは、ジョブが完了するまでnullとなります。
例 12345ファイルバージョンを表す一意の識別子。
例 file_version値は常にfile_versionになります。次の値に固定: file_version
例 completedジョブのステータス。次の値のいずれか1つ: submitted,completed,failed,completed_with_error,pending
ジョブで使用されたBox Doc Genテンプレート。
例 file値は常にfileになります。次の値に固定: file
テンプレートのファイルバージョン。
例 12345ファイルバージョンを表す一意の識別子。
例 file_version値は常にfile_versionになります。次の値に固定: file_version
{
"id": "12345",
"type": "docgen_job",
"batch": {
"id": "12345",
"type": "docgen_batch"
},
"created_at": "2022-05-11T10:56:11-07:00",
"created_by": {
"id": "11446498",
"type": "user"
},
"enterprise": {
"id": "1910967",
"type": "enterprise"
},
"output_file": {
"id": "42037322",
"type": "file"
},
"output_file_version": {
"id": "12345",
"type": "file_version"
},
"output_type": "docx",
"source": "api",
"status": "completed",
"template_file": {
"id": "42037322",
"type": "file"
},
"template_file_version": {
"id": "12345",
"type": "file_version"
}
}
