Box Developerドキュメント
 

    Box Doc Genジョブ (Full)

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

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

    Fullバリアントに含まれるフィールドは、fieldsパラメータをサポートするAPIエンドポイントによって返すことができます。たとえば、IDでファイルを取得するときに、fieldsリクエストパラメータをid,typeに設定すると、これらのフィールドのみがAPIレスポンスで返されます。

    string
    12345

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

    string
    docgen_job

    docgen_job

    次の値に固定: docgen_job

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

    string
    2022-05-11T10:56:11-07:00

    ジョブの作成時刻。

    object

    ジョブを作成したユーザー。

    11446498

    このユーザーの一意の識別子

    user

    user

    次の値に固定: user

    object

    企業のID。

    1910967

    この企業の一意の識別子

    enterprise

    enterprise

    次の値に固定: enterprise

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

    42037322

    オブジェクトのID

    file

    file

    次の値に固定: file

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

    12345

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

    file_version

    file_version

    次の値に固定: file_version

    docx

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

    string
    api

    リクエストのソース。

    string
    completed

    ジョブのステータス。

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

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

    42037322

    オブジェクトのID

    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"
      }
    }