メインコンテンツへスキップ
GET
「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.

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

パスパラメータ

document_split_id
string
必須

ドキュメント分割ジョブの一意の識別子。

レスポンス

ドキュメント分割ジョブを返します。

ドキュメント分割ジョブのStandard版の表示。このジョブは、ページ割りされたソースドキュメントを複数のファイルに分割するリクエストを表します。これは、各ページ範囲の手動指定、非線形のページ選択、またはスマートプロンプトによる分析に基づいて行われます。

id
string
必須

ドキュメント分割ジョブの一意の識別子。

例:

"1748426"

type
enum<string>
必須

値は常にdocument_splitになります。

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

"document_split"

source_file
ファイル参照 · object
必須

分割するファイル。

status
enum<string>
必須

ドキュメント分割ジョブの現在の状態。

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

"submitted"

split_input
ドキュメント分割手動作成リクエスト · object
必須

分割の実行用に呼び出し元から提供された入力。形式はリクエストに応じて異なります。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として表示されます。

destination_folder
フォルダの参照 · object
必須

生成されたファイルが格納されたフォルダ。

input_source
enum<string>
必須

リクエストを開始したシステム。分析および追跡可能性のために使用されます。

利用可能なオプション:
api,
box,
relay,
salesforce
例:

"api"

output
ドキュメント分割の出力 · object

ドキュメント分割ジョブの結果。ジョブが出力を生成するまでの間はnullです。

created_at
string<date-time>

ドキュメント分割ジョブの作成日時。

例:

"2023-10-26T15:30:00Z"

created_by
ユーザー (Mini) · object

ドキュメント分割ジョブを作成したユーザー。

enterprise
企業の参照 · object

ドキュメント分割ジョブを所有している企業。

failures
ドキュメント分割の失敗 · object

ドキュメント分割中に発生したエラーおよび警告。何も記録されていない場合は、nullです。

external_id
string

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

Maximum string length: 255
例:

"invoice-48291"

最終更新日 2026年11月4日