Box Developerドキュメント
ログイン

Box Doc Genジョブ

Box Doc GenジョブのStandard版の表示。

このリソースにはAPIの使用時に発生する可能性があるいくつかのバリエーションがあります。

通常、Standardバリアントに含まれるフィールドは、固有のAPIエンドポイントを介してこのリソースがリクエストされたときに返されます。 たとえば、fieldsパラメータが指定されていない場合、IDでファイルを取得すると、これらのフィールドが返されます。

string
12345

Box Doc Genジョブを表す一意の識別子。

string
docgen_job

値は常にdocgen_jobになります。

次の値に固定: docgen_job

Box Doc Genのバッチ (Base) object

ジョブが属しているBox Doc Genのバッチ。

object

ジョブの出力ファイル。このプロパティは、ジョブが完了するまでnullとなります。

string
42037322

オブジェクトのID。

string
file

値は常にfileになります。

次の値に固定: file

object

出力ファイルのファイルバージョン。このプロパティは、ジョブが完了するまでnullとなります。

string
12345

ファイルバージョンを表す一意の識別子。

string
file_version

値は常にfile_versionになります。

次の値に固定: file_version

string
docx

生成されたファイルの種類。

string
completed

ジョブのステータス。

次の値のいずれか1つ: submitted,completed,failed,completed_with_error,pending

object

ジョブで使用されたBox Doc Genテンプレート。

string
42037322

オブジェクトのID。

string
file

値は常にfileになります。

次の値に固定: file

object

テンプレートのファイルバージョン。

string
12345

ファイルバージョンを表す一意の識別子。

string
file_version

値は常にfile_versionになります。

次の値に固定: file_version

レスポンスの例

{
  "id": "12345",
  "type": "docgen_job",
  "batch": {
    "id": "12345",
    "type": "docgen_batch"
  },
  "output_file": {
    "id": "42037322",
    "type": "file"
  },
  "output_file_version": {
    "id": "12345",
    "type": "file_version"
  },
  "output_type": "docx",
  "status": "completed",
  "template_file": {
    "id": "42037322",
    "type": "file"
  },
  "template_file_version": {
    "id": "12345",
    "type": "file_version"
  }
}