DX Suite 標準API V2を利用した業務フローについて説明します。
1.Intelligent OCR を利用する基本フロー
APIを使用することで、DX Suite の画面を操作せずに、外部プログラムから以下の処理を実行できます。
- 画像ファイルのアップロード
- CSVファイルのダウンロード
- 読取ユニットの削除
このフローにより、業務の自動化と効率化が可能になります。
2.Elastic Sorter を併用する場合のフロー
Elastic Sorter を併用することで、以下の処理をAPIを介して実行できます。
- 画像ファイルのアップロード
- 仕分け処理
- Intelligent OCR への送信
- 仕分けユニットの削除
- CSVファイルのダウンロード
- 仕分けユニットの検索
また、Elastic Sorter の 「Intelligent OCR へ送信」API を組み合わせることで、より柔軟なワークフローを構築できます。業務の要件に応じて適切なAPIを活用してください。
3.その他のAPI使用例
業務の要件に応じて、さまざまなAPIを活用できます。
| No | API名 | パラメータ |
| 1 | 部署取得 | ※本APIにはパラメータは不要です。 |
| 2 | フォルダ検索 | ・部署ID（departmentId） ・フォルダ名（folderName） ・取得開始位置（offset） ・取得件数（limit） |
| 3 | フォルダ作成 | ・部署ID（departmentId） ・フォルダ名（folderName） |
| 4 | フォルダ名変更 | ・フォルダID（folderId） ・フォルダ名（folderName） |
| 5 | フォルダ削除 | ・フォルダID（folderId） |
| 6 | ワークフロー検索 | ・フォルダID（folderId） ・ワークフロー名（workflowName） |
| 7 | ワークフロー設定取得 | ・ワークフローID（workflowId） ・ワークフローのリビジョン（revision） |
| 8 | ワークフロー作成 | ・OCR種別（ocrKindType） ・フォルダID（folderId） ・ワークフロー名（workflowName） ・定型・非定型・項目抽出の設定ファイル(Xml形式)（documentXmlFile） ・全文のパラメータ(JSON形式)（fullTextSettings） |
| 9 | ワークフロー更新 | ・ワークフローID（workflowId） ・フォルダID（folderId） ・ワークフロー名（workflowName） ・ワークフロー(Xml形式)（documentXmlFile） ・全文のパラメータ(JSON形式)（fullTextSettings） └データ結合設定（concatenate） データチェックON/OFF（dataCheck） CSVアウトプット時のファイル名方式（outputFileNameType） CSVアウトプット時のファイル名（outputFileName） |
| 10 | ワークフロー削除 | ・ワークフローID（workflowId） |
| 12 | 読取ユニット検索 | ・フォルダID（folderId） ・ワークフローID（workflowId） ・ユニットID（unitId） ・ユニット名（unitName） ・ユニットのステータス（status） ・ユニット作成日時（createdFrom,createdTo） |
| 15 | 読取パーツ情報取得 | ・ユニットID（unitId） ・ページID（pageId） ・読取パーツID（dataItemId） ・分割読取パーツID（detailDataItemId） |
| 16 | 読取ユニット内の全パーツ画像取得 | ・ユニットID（unitId） |
| 17 | 読取ページ画像取得 | ・ユニットID（unitId） ・ページID（pageId） ・ZIPファイルに含まれる画像のファイル名タイプ（filenameType） |
| 18 | 読取ユニットID取得 | ・ワークフローID（workflowId） ・取得開始位置（offset） ・取得件数（limit） |
| 19 | 読取ユニット状態取得 | ・ユニットID（unitId） |
| 20 | 仕分けルール取得 | ・仕分けルール名（ruleName） ・仕分け種別（sortKindType） ・取得開始位置（offset） ・取得件数（limit） |
| 21 | 仕分けルール作成 | ・仕分けルール名（ruleName） ・仕分け種別（sortKindType） ・仕分けトレイ設定（traySettings） └仕分けトレイの配列（trays） 仕分けトレイの名前（trayName） ワークフローID（workflowId） 仕分け距離閾値（distanceThreshold） キーワード仕分け条件の配列（sortConditionsGroupList） キーワードとの一致種別（matchType） 仕分け条件のキーワードの配列（conditionItemList） |
| 22 | 仕分けルール名変更 | ・仕分けルールID（sortConfigId） ・仕分けルール名（ruleName） |
| 23 | 仕分けルール削除 | ・仕分けルールID（sortConfigId） |
| 24 | 仕分けトレイ取得 | ・仕分けルールID（sortConfigId） ・取得開始位置（offset） ・取得件数（limit） |
| 25 | 仕分けトレイ作成 | ・仕分けルールID（sortConfigId） ・仕分けトレイ名（sortTrayName） ・ワークフローID（workflowId） ・仕分け距離閾値（distanceThreshold） ・仕分け条件(JSON形式)（sortConditions） └キーワード仕分け条件の配列（sortConditionsGroupList） キーワードとの一致種別（matchType） 仕分け条件のキーワードの配列（conditionItemList） |
| 26 | 仕分けトレイ更新 | ・仕分けトレイID（sortTrayId） ・仕分けトレイ名（sortTrayName） ・仕分け距離閾値（distanceThreshold） ・ワークフローID（workflowId） ・仕分け条件(JSON形式)（sortConditions） └キーワード仕分け条件の配列（sortConditionsGroupList） キーワードとの一致種別（matchType） 仕分け条件のキーワードの配列（conditionItemList） |
| 27 | 仕分けトレイ削除 | ・仕分けトレイID（sortTrayId） |
| 28 | 仕分け結果取得 | ・仕分けユニットID（sortUnitId） ・返却結果の並び順（orderBy） |
| 29 | 仕分け結果修正トレイ移動 | ・仕分けユニットID（sortUnitId） ・ページID（sortPageId） ・移動先の仕分けトレイID（sortTrayId） |
| 30 | 仕分けページ画像取得 | ・仕分けユニットID（sortUnitId） ・ページID（sortPageId） |
| 35 | 仕分けユニット検索 | ・仕分けユニットID（sortUnitId） |
詳細については、以下の関連リンクを参照してください。
<関連リンク>
DX Suite 標準API V2 共通仕様ガイド
読取ユニット内の全パーツ画像取得API レスポンスについて
DX Suite 標準API V2 各APIで確認できるステータス一覧
DX Suite 標準API V2 各APIのパラメータ確認方法