ドキュメント分割ジョブをIDで取得
IDによって識別される1つのドキュメント分割ジョブの詳細を返します。これには、現在のステータス、入力定義、およびジョブによって生成される出力ファイルが含まれます。
承認
The access token received from the authorization server in the OAuth 2.0 flow.
ヘッダー
Version header.
2026.0 パスパラメータ
ドキュメント分割ジョブの一意の識別子。
レスポンス
ドキュメント分割ジョブを返します。
ドキュメント分割ジョブのStandard版の表示。このジョブは、ページ割りされたソースドキュメントを複数のファイルに分割するリクエストを表します。これは、各ページ範囲の手動指定、非線形のページ選択、またはスマートプロンプトによる分析に基づいて行われます。
ドキュメント分割ジョブの一意の識別子。
"1748426"
値は常にdocument_splitになります。
document_split "document_split"
分割するファイル。
ドキュメント分割ジョブの現在の状態。
submitted, completed, failed, completed_with_error "submitted"
分割の実行用に呼び出し元から提供された入力。形式はリクエストに応じて異なります。manual分割の場合、split_inputにはsplit_typeおよびsplit_definitionが含まれます。page_selection分割の場合、split_inputにはsplit_typeおよびpage_selectionが含まれます。smart分割の場合、split_inputにはsplit_typeおよび呼び出し元から提供されたpromptが含まれます。スマート分割の場合、Boxによって生成されたページ範囲がoutput.split_definitionとして表示されます。
- ドキュメント分割手動作成リクエスト
- ドキュメント分割ページ選択作成リクエスト
- ドキュメント分割スマート作成リクエスト
生成されたファイルが格納されたフォルダ。
リクエストを開始したシステム。分析および追跡可能性のために使用されます。
api, box, relay, salesforce "api"
ドキュメント分割ジョブの結果。ジョブが出力を生成するまでの間はnullです。
- ドキュメント分割の出力
- OpenAPI 3.0 null schema type
ドキュメント分割ジョブの作成日時。
"2023-10-26T15:30:00Z"
ドキュメント分割ジョブを作成したユーザー。
ドキュメント分割ジョブを所有している企業。
ドキュメント分割中に発生したエラーおよび警告。何も記録されていない場合は、nullです。
- ドキュメント分割の失敗
- OpenAPI 3.0 null schema type
ドキュメント分割ジョブの生成時に呼び出し元から提供された識別子 (省略可)。関連付けのためにのみ返されます。これはBoxリソースIDではなく、必ずしも一意ではないため、ジョブの参照には使用できません。
255"invoice-48291"
