メインコンテンツへスキップ
GET
cURL
「Box SDKのバージョニング戦略について詳しく学ぶ。」

承認

Authorization
string
header
必須

The access token received from the authorization server in the OAuth 2.0 flow.

ヘッダー

box-version
enum<string>
必須

Version header.

利用可能なオプション:
2025.0

パスパラメータ

job_id
string
必須

Box Doc GenジョブのID。

レスポンス

Box Doc Genジョブの詳細。

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

id
string
必須

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

例:

"12345"

type
enum<string>
必須

値は常にdocgen_jobになります。

利用可能なオプション:
docgen_job
例:

"docgen_job"

batch
Box Doc Genのバッチ (Base) · object
必須

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

template_file
ファイル参照 · object
必須

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

template_file_version
ファイルバージョン (Base) · object
必須

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

status
enum<string>
必須

ジョブのステータス。

利用可能なオプション:
submitted,
completed,
failed,
completed_with_error,
pending
例:

"completed"

output_type
string
必須

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

例:

"docx"

external_id
string

Box Doc Genジョブの生成時に呼び出し元から提供された識別子 (省略可)。関連付けのためにのみ返されます。これはBoxリソースIDではなく、必ずしも一意ではないため、ジョブの参照には使用できません。

Maximum string length: 36
例:

"111222_externalID"

output_file
ファイル参照 · object

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

output_file_version
ファイルバージョン (Base) · object

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

failures
object | null

ドキュメント生成中に発生したエラーおよび警告。

最終更新日 2026年1月23日