ドキュメント分割
ドキュメント分割ジョブのStandard版の表示。このジョブは、ページ割りされたソースドキュメントを複数のファイルに分割するリクエストを表します。これは、各ページ範囲の手動指定、非線形のページ選択、またはスマートプロンプトによる分析に基づいて行われます。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | はい | ドキュメント分割ジョブの一意の識別子。 |
type | enum<string> | はい | 値は常にdocument_splitになります。 使用可能なオプション: document_split. |
source_file | ファイル参照 | はい | 分割するファイル。 |
status | enum<string> | はい | ドキュメント分割ジョブの現在の状態。 使用可能なオプション: submitted, completed, failed, completed_with_error. |
split_input | ドキュメント分割作成リクエストタイプ | はい | 分割の実行用に呼び出し元から提供された入力。形式はリクエストに応じて異なります。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として表示されます。 |
output | ドキュメント分割の出力 | いいえ | ドキュメント分割ジョブの結果。ジョブが出力を生成するまでの間はnullです。 null を指定できます。 |
destination_folder | フォルダの参照 | はい | 生成されたファイルが格納されたフォルダ。 |
input_source | enum<string> | はい | リクエストを開始したシステム。分析および追跡可能性のために使用されます。 使用可能なオプション: api, box, relay, salesforce. |
created_at | string | いいえ | ドキュメント分割ジョブの作成日時。 |
created_by | ユーザー (Mini) | いいえ | ドキュメント分割ジョブを作成したユーザー。 |
enterprise | 企業の参照 | いいえ | ドキュメント分割ジョブを所有している企業。 |
failures | ドキュメント分割の失敗 | いいえ | ドキュメント分割中に発生したエラーおよび警告。何も記録されていない場合は、nullです。 null を指定できます。 |
external_id | string | いいえ | ドキュメント分割ジョブの生成時に呼び出し元から提供された識別子 (省略可)。関連付けのためにのみ返されます。これはBoxリソースIDではなく、必ずしも一意ではないため、ジョブの参照には使用できません。 |
例
{
"id": "1748426",
"type": "document_split",
"source_file": {
"type": "file",
"id": "42037322"
},
"status": "submitted",
"split_input": {
"split_type": "manual",
"version": "v_1",
"split_definition": [
{
"start": 1,
"end": 5
},
{
"start": 6,
"end": 14
}
]
},
"output": {
"generated_files": [
{
"type": "file",
"id": "42037322"
}
],
"split_definition": [
{
"start": 1,
"end": 10
},
{
"start": 11,
"end": 25
}
]
},
"destination_folder": {
"type": "folder",
"id": "42037322"
},
"input_source": "api",
"created_at": "2023-10-26T15:30:00Z",
"created_by": {
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
},
"enterprise": {
"id": "1910967",
"type": "enterprise"
},
"failures": {
"errors": [
"The source file could not be processed."
],
"warnings": [
"Some pages were skipped because they were blank."
]
},
"external_id": "invoice-48291"
}
ドキュメント分割
ドキュメント分割ジョブのページ割りされたリスト。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
entries | array of ドキュメント分割 | いいえ | ドキュメント分割ジョブのリスト。 |
limit | integer | いいえ | これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータのlimitと等しくなります。最大値はAPIによって異なります。 |
next_marker | string | いいえ | 次の検索結果ページの開始場所のマーカー。 null を指定できます。 |
例
{
"entries": [
{
"id": "1748426",
"type": "document_split",
"source_file": {
"type": "file",
"id": "42037322"
},
"status": "submitted",
"split_input": {
"split_type": "manual",
"version": "v_1",
"split_definition": [
{
"start": 1,
"end": 5
},
{
"start": 6,
"end": 14
}
]
},
"output": {
"generated_files": [
{
"type": "file",
"id": "42037322"
}
],
"split_definition": [
{
"start": 1,
"end": 10
},
{
"start": 11,
"end": 25
}
]
},
"destination_folder": {
"type": "folder",
"id": "42037322"
},
"input_source": "api",
"created_at": "2023-10-26T15:30:00Z",
"created_by": {
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
},
"enterprise": {
"id": "1910967",
"type": "enterprise"
},
"failures": {
"errors": [
"The source file could not be processed."
],
"warnings": [
"Some pages were skipped because they were blank."
]
},
"external_id": "invoice-48291"
}
],
"limit": 1000,
"next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"
}
ドキュメント分割によるレスポンスの作成
新しく作成されたドキュメント分割ジョブへの参照。ドキュメント分割ジョブが非同期処理について承認された場合に返されます。クライアントはこのIDを使用して、ジョブの完全なレプリゼンテーションをポーリングできます。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
type | enum<string> | はい | 値は常にdocument_splitになります。 使用可能なオプション: document_split. |
id | string | はい | 作成されたドキュメント分割ジョブの一意の識別子。 |
例
{
"type": "document_split",
"id": "1748426"
}
ドキュメント分割の失敗
ドキュメント分割ジョブで発生したエラーおよび警告。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
errors | array of string | はい | ドキュメントジョブで発生したエラーのリスト。 |
warnings | array of string | はい | ドキュメントジョブで発生した警告のリスト。 |
例
{
"errors": [
"The source file could not be processed."
],
"warnings": [
"Some pages were skipped because they were blank."
]
}
ドキュメント分割の出力
完了したドキュメント分割ジョブによって生成された一連のファイル。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
generated_files | array of ファイル参照 | いいえ | 分割により作成されたファイルへの参照。 |
split_definition | array of ドキュメント分割のページ範囲 | いいえ | smart分割でBoxが生成したページの範囲。各エントリはページ範囲が[start, end] (最初と最後のページを含む) である1個の生成済みファイルに対応しています。manual分割の場合は省略するか、nullを指定します (呼び出し元が指定した範囲はsplit_input.split_definitionにあります)。page_selection分割の場合は省略します (呼び出し元が指定したページレイアウトはsplit_input.page_selectionにあります)。 null を指定できます。 |
例
{
"generated_files": [
{
"type": "file",
"id": "42037322"
}
],
"split_definition": [
{
"start": 1,
"end": 10
},
{
"start": 11,
"end": 25
}
]
}
ドキュメント分割作成リクエスト
ドキュメント分割ジョブを作成するためのリクエスト本文。split_inputプロパティには、分割の実行方法を決定するために呼び出し元から提供された入力が格納されています。
属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
source_file_id | string | はい | 分割するソースファイルのID。 |
destination_folder_id | string | はい | 結果のファイルがアップロードされるフォルダのID。 |
input_source | enum<string> | はい | リクエストを開始したシステム。分析および追跡可能性のために使用されます。 使用可能なオプション: api, box, relay, salesforce. |
split_input | ドキュメント分割作成リクエストタイプ | はい | |
external_id | string | いいえ | このドキュメント分割ジョブに対して呼び出し元から提供された識別子 (省略可)。この値は、関連付けのためにのみジョブレスポンスで返されます。これはBoxリソースIDではなく、必ずしも一意ではないため、ジョブの参照には使用できません。 |
例
{
"source_file_id": "12345",
"destination_folder_id": "14047816008",
"input_source": "api",
"split_input": {
"split_type": "manual",
"version": "v_1",
"split_definition": [
{
"start": 1,
"end": 5
},
{
"start": 6,
"end": 14
}
]
},
"external_id": "invoice-48291"
}