メインコンテンツへスキップ

概要

処理が完了したファイル分割タスクにおいて、分割された子ファイルのカテゴリが不正確な場合や、子ファイルのページ範囲を調整する必要がある場合、カテゴリ修正 API を使用して分割ファイルのカテゴリとページ番号を変更できます。
この API は、ファイル分割タスク(task_type = 2、親タスク)によって生成された子ファイルのカテゴリとページ番号を変更するために使用します。事前に親タスクの task_id を取得する必要があります。

利用シーン

  1. 分割カテゴリの修正:自動分割後、一部の子ファイルのカテゴリ認識が不正確で、手動で修正が必要な場合
  2. ページ範囲の調整:分割ファイルのページ範囲を調整する必要がある場合(複数の子ファイルの結合や再分割など)

API エンドポイント

エンドポイント: POST /api/app-api/sip/platform/v2/file/amend_category

リクエストパラメータ

split_tasks パラメータ説明

パラメータ説明

  • task_id:親タスク ID(task_type = 2)。file/fetch API を通じて取得できます
  • category:新しいファイルカテゴリ名。DocFlow ワークスペースで設定済みのファイルカテゴリである必要があります。子ファイルのカテゴリ変更が不要な場合は、元のカテゴリをそのまま保持できます
  • pages:ページ番号配列。この子ファイルに含まれる元ファイルのページを示します。例えば [0, 1] は 1 ページ目と 2 ページ目を意味します(0 から開始)。子ファイルのページ番号変更が不要な場合は、元のページ番号をそのまま保持できます
重要split_tasks 配列には、一部の子ファイルのカテゴリやページ番号の変更が不要であっても、すべての分割子ファイル情報を含める必要があります。部分的な子ファイル情報のみを送信すると、リストに含まれない子ファイルが削除されるか、処理例外が発生します。

サンプルコード

親タスク ID と子ファイル情報の取得

ファイルカテゴリを変更する前に、親タスクの task_id と子ファイル情報を取得する必要があります。file/fetch API で確認できます。

レスポンス

ファイルカテゴリの変更が成功すると、API は成功レスポンスを返します。

完全な例

以下は、ファイル分割タスク情報を確認し、子ファイルのカテゴリとページ番号を変更する完全な例です:
Python

ページ番号に関する注意事項

  • ページ番号は 0 から始まります。つまり 1 ページ目がページ番号 0、2 ページ目がページ番号 1 に対応します
  • pages 配列は、この子ファイルに含まれる元ファイルのページ番号を示します

注意事項

  1. すべての子ファイルを含めることsplit_tasks 配列には、一部の子ファイルのカテゴリやページ番号の変更が不要であっても、すべての分割子ファイル情報を含める必要があります。部分的な子ファイル情報のみを送信すると、リストに含まれない子ファイルが削除されるか、処理例外が発生します
  2. タスクタイプの制限:ファイル分割の親タスク(task_type = 2)のみ split_tasks パラメータの使用に対応しています
  3. カテゴリが存在すること:指定する category は DocFlow ワークスペースで設定済みである必要があります。そうでない場合、エラーが返されます
  4. カテゴリ名の一致:カテゴリ名は設定された内容と完全に一致する必要があります(大文字・小文字を区別)
  5. ページ範囲pages 配列のページ番号が有効な範囲内(0 から総ページ数 - 1)であることを確認し、ページ番号の重複は許可されません
  6. ページの重複不可:各ページ番号は 1 つの子ファイルにのみ出現可能で、重複は許可されません
  7. 変更後の再処理:ファイルカテゴリとページ番号を変更すると、システムは新しいカテゴリとページ範囲に従ってデータを再処理します