Box Doc Genジョブ
Box Doc GenジョブのStandard版の表示。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | はい | Box Doc Genジョブを表す一意の識別子。 |
type | enum<string> | はい | 値は常にdocgen_jobになります。 使用可能なオプション: docgen_job. |
batch | Box Doc Genのバッチ (Base) | はい | ジョブが属しているBox Doc Genのバッチ。 |
template_file | ファイル参照 | はい | ジョブで使用されたBox Doc Genテンプレート。 |
template_file_version | ファイルバージョン (Base) | はい | テンプレートのファイルバージョン。 |
output_file | ファイル参照 | いいえ | ジョブの出力ファイル。このプロパティは、ジョブが完了するまでnullとなります。 null を指定できます。 |
output_file_version | ファイルバージョン (Base) | いいえ | 出力ファイルのファイルバージョン。このプロパティは、ジョブが完了するまでnullとなります。 null を指定できます。 |
status | enum<string> | はい | ジョブのステータス。 使用可能なオプション: submitted, completed, failed, completed_with_error, pending. |
output_type | string | はい | 生成されたファイルの種類。 |
failures | object | いいえ | ドキュメント生成中に発生したエラーおよび警告。 null を指定できます。 |
例
{
"id": "12345",
"type": "docgen_job",
"batch": {
"id": "12345",
"type": "docgen_batch"
},
"template_file": {
"type": "file",
"id": "42037322"
},
"template_file_version": {
"id": "12345",
"type": "file_version"
},
"output_file": {
"type": "file",
"id": "42037322"
},
"output_file_version": {
"id": "12345",
"type": "file_version"
},
"status": "completed",
"output_type": "docx",
"failures": {
"errors": [
"The tag 'customer_name' was not provided in the input data."
],
"warnings": [
"The tag 'optional_field' was provided but not used in the template."
]
}
}
Box Doc Genジョブ
標準のパラメータのセットを含むBox Doc Genジョブのリスト。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
limit | integer | いいえ | これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータのlimitと等しくなります。最大値はAPIによって異なります。 |
next_marker | string | いいえ | 次の検索結果ページの開始場所のマーカー。 null を指定できます。 |
prev_marker | string | いいえ | 前の検索結果ページの開始場所のマーカー。 null を指定できます。 |
entries | array of Box Doc Genジョブ | いいえ | ジョブのリスト。 |
例
{
"limit": 1000,
"next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
"prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
"entries": [
{
"id": "12345",
"type": "docgen_job",
"batch": {
"id": "12345",
"type": "docgen_batch"
},
"template_file": {
"type": "file",
"id": "42037322"
},
"template_file_version": {
"id": "12345",
"type": "file_version"
},
"output_file": {
"type": "file",
"id": "42037322"
},
"output_file_version": {
"id": "12345",
"type": "file_version"
},
"status": "completed",
"output_type": "docx",
"failures": {
"errors": [
"The tag 'customer_name' was not provided in the input data."
],
"warnings": [
"The tag 'optional_field' was provided but not used in the template."
]
}
}
]
}
Box Doc Genジョブ (Base)
Box Doc GenジョブのBase版の表示。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | はい | Box Doc Genジョブを表す一意の識別子。 |
type | enum<string> | はい | 値は常にdocgen_jobになります。 使用可能なオプション: docgen_job. |
例
{
"id": "12345",
"type": "docgen_job"
}
Box Doc Genジョブ (Full)
Box Doc GenジョブのFull版の表示。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | はい | Box Doc Genジョブを表す一意の識別子。 |
type | enum<string> | はい | 値は常にdocgen_jobになります。 使用可能なオプション: docgen_job. |
batch | Box Doc Genのバッチ (Base) | はい | ジョブが属しているBox Doc Genのバッチ。 |
template_file | ファイル参照 | はい | ジョブで使用されたBox Doc Genテンプレート。 |
template_file_version | ファイルバージョン (Base) | はい | テンプレートのファイルバージョン。 |
output_file | ファイル参照 | いいえ | ジョブの出力ファイル。このプロパティは、ジョブが完了するまでnullとなります。 null を指定できます。 |
output_file_version | ファイルバージョン (Base) | いいえ | 出力ファイルのファイルバージョン。このプロパティは、ジョブが完了するまでnullとなります。 null を指定できます。 |
status | enum<string> | はい | ジョブのステータス。 使用可能なオプション: submitted, completed, failed, completed_with_error, pending. |
output_type | string | はい | 生成されたファイルの種類。 |
failures | object | いいえ | ドキュメント生成中に発生したエラーおよび警告。 null を指定できます。 |
created_at | string | いいえ | ジョブの作成時刻。 読み取り専用。 |
created_by | ユーザー (Base) | はい | ジョブを作成したユーザー。 |
enterprise | 企業の参照 | はい | 企業のID。 |
source | string | はい | リクエストのソース。 読み取り専用。 |
例
{
"id": "12345",
"type": "docgen_job",
"batch": {
"id": "12345",
"type": "docgen_batch"
},
"template_file": {
"type": "file",
"id": "42037322"
},
"template_file_version": {
"id": "12345",
"type": "file_version"
},
"output_file": {
"type": "file",
"id": "42037322"
},
"output_file_version": {
"id": "12345",
"type": "file_version"
},
"status": "completed",
"output_type": "docx",
"failures": {
"errors": [
"The tag 'customer_name' was not provided in the input data."
],
"warnings": [
"The tag 'optional_field' was provided but not used in the template."
]
},
"created_at": "2022-05-11T10:56:11-07:00",
"created_by": {
"id": "11446498",
"type": "user"
},
"enterprise": {
"id": "1910967",
"type": "enterprise"
},
"source": "api"
}
Box Doc Genジョブ (Full)
すべてのパラメータを含むBox Doc Genジョブのリスト。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
limit | integer | いいえ | これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータのlimitと等しくなります。最大値はAPIによって異なります。 |
next_marker | string | いいえ | 次の検索結果ページの開始場所のマーカー。 null を指定できます。 |
prev_marker | string | いいえ | 前の検索結果ページの開始場所のマーカー。 null を指定できます。 |
entries | array of Box Doc Genジョブ (Full) | いいえ | ジョブのリスト。 |
例
{
"limit": 1000,
"next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
"prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
"entries": [
{
"id": "12345",
"type": "docgen_job",
"batch": {
"id": "12345",
"type": "docgen_batch"
},
"template_file": {
"type": "file",
"id": "42037322"
},
"template_file_version": {
"id": "12345",
"type": "file_version"
},
"output_file": {
"type": "file",
"id": "42037322"
},
"output_file_version": {
"id": "12345",
"type": "file_version"
},
"status": "completed",
"output_type": "docx",
"failures": {
"errors": [
"The tag 'customer_name' was not provided in the input data."
],
"warnings": [
"The tag 'optional_field' was provided but not used in the template."
]
},
"created_at": "2022-05-11T10:56:11-07:00",
"created_by": {
"id": "11446498",
"type": "user"
},
"enterprise": {
"id": "1910967",
"type": "enterprise"
},
"source": "api"
}
]
}
Box Doc Genのバッチ (Base)
Box Doc GenバッチオブジェクトのBase版の表示。Box Doc Genのバッチには、1つ以上のBox Doc Genジョブが含まれています。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | はい | Box Doc Genのバッチを表す一意の識別子。 |
type | enum<string> | はい | 値は常にdocgen_batchになります。 使用可能なオプション: docgen_batch. |
例
{
"id": "12345",
"type": "docgen_batch"
}