{
  "type": "document_split",
  "id": "1748426"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

ドキュメント分割

ドキュメント分割ジョブを作成

提供されたソースファイルに対してドキュメント分割ジョブを開始します。ジョブは非同期で実行され、クライアントは返されるジョブIDをポーリングして進捗状況を追跡できます。

split_inputの配下にある、すべての分割固有の入力。split_input.split_typeがmanualのときには、split_input.split_definitionを指定します (連続的なページ範囲、versionは省略するかv_1を指定)。split_input.split_typeがpage_selectionのときには、split_input.page_selectionを指定します (非線形的なページセグメント、versionは省略するかv_2を指定)。これらのバリアントに対してはsplit_input.promptを指定しないでください。split_input.split_typeがsmartのときにはsplit_input.promptが必須であり、split_input.split_definitionとsplit_input.page_selectionのどちらも指定しないでください。

POST

document_splits

{
  "type": "document_split",
  "id": "1748426"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

「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

ボディ

application/json

ドキュメント分割ジョブを作成するためのリクエスト本文。split_inputプロパティには、分割の実行方法を決定するために呼び出し元から提供された入力が格納されています。

source_file_id

string

必須

分割するソースファイルのID。

例:

"12345"

destination_folder_id

string

必須

結果のファイルがアップロードされるフォルダのID。

例:

"14047816008"

input_source

enum<string>

必須

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

利用可能なオプション:

api,

box,

relay,

salesforce

例:

"api"

split_input

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

必須

呼び出し元から提供されたページ範囲を使用してドキュメント分割ジョブを作成するための検証ルール。

ドキュメント分割手動作成リクエスト
ドキュメント分割ページ選択作成リクエスト
ドキュメント分割スマート作成リクエスト

Show child attributes

external_id

string

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

Maximum string length: 255

例:

"invoice-48291"

レスポンス

ドキュメント分割ジョブの処理が承認されました。新しく作成されたジョブへの参照を返します。

新しく作成されたドキュメント分割ジョブへの参照。ドキュメント分割ジョブが非同期処理について承認された場合に返されます。クライアントはこのIDを使用して、ジョブの完全なレプリゼンテーションをポーリングできます。

type

enum<string>

必須

値は常にdocument_splitになります。

利用可能なオプション:

document_split

例:

"document_split"

string

必須

作成されたドキュメント分割ジョブの一意の識別子。

例:

"1748426"

最終更新日 2026年11月4日

APIリファレンス

v2025.0

v2026.0

APIリファレンス

APIリファレンス

ドキュメント分割ジョブを作成

承認

ヘッダー

ボディ

レスポンス