各APIのパラメータと返却データは、ユニットIDなどの識別子を使って関連付けられています。
本記事では、各APIに指定するパラメータと、その取得方法について解説します。
Intelligent OCR のAPI
ワークフロー検索
| パラメータ | 説明 |
|
フォルダID （unitId） |
［フォルダID］をクリックすると36桁の文字列をコピーできます。 |
|
ワークフロー名 （workflowName） |
ワークフロー設定取得
| パラメータ | 説明 |
|
ワークフローID （workflowId）* |
［ワークフローID］クリックすると36桁の文字列をコピーできます。 |
|
ワークフローのリビジョン （revision）* |
リビジョンはワークフローのバージョンを表す値です。 詳細はこちらの記事をご確認ください |
* 必須項目
読取ユニット登録
| パラメータ | 説明 |
|
ワークフローID （workflowId）* |
［ワークフローID］クリックすると36桁の文字列をコピーできます。 |
|
追加する画像データファイル （files）* |
ファイルは一度に複数を指定できます。 curlコマンドで複数ファイルを指定する場合は、ファイルの数だけ -F "files=@{ファイル名}" を追加します。 |
|
ユニット名 （unitName） |
|
|
部署ID （departmentId） |
確認したい部署名をクリックし、部署名の編集画面に遷移後のURLから部署IDが確認できます。https://xxx.dx-suite.com/ConsoleWeb/Dx/Settings/Department/Edit?departmentsId=xxxxx |
* 必須項目
読取ユニット検索
| パラメータ | 説明 |
|
フォルダID （folderId） |
［フォルダID］をクリックすると36桁の文字列をコピーできます。 |
|
ワークフローID （workflowId） |
［ワークフローID］クリックすると36桁の文字列をコピーできます。 |
|
ユニットID （unitId） |
［ユニットID］をクリックすると36桁の文字列をコピーできます。 |
|
ユニット名 （unitName） |
|
|
ユニットのステータス （status） |
- |
|
ユニット作成の日時 （createdFrom、createdTo） |
- |
CSVダウンロード
| パラメータ | 説明 |
|
ユニットID （unitId）* |
［ユニットID］をクリックすると36桁の文字列をコピーできます。 |
* 必須項目
読取ユニット削除
| パラメータ | 説明 |
|
ユニットID （unitId）* |
［ユニットID］をクリックすると36桁の文字列をコピーできます。 |
* 必須項目
読取パーツ情報取得
| パラメータ | 説明 |
|
ユニットID （unitId） |
［ユニットID］をクリックすると36桁の文字列をコピーできます。 |
|
ページID （pageId） |
- |
|
読取パーツID （dataItemId） |
- |
|
分割読取パーツID （detailDataItemId） |
- |
読取ユニット内の全パーツ画像取得
| パラメータ | 説明 |
|
ユニットID （unitId）* |
［ユニットID］をクリックすると36桁の文字列をコピーできます。 |
* 必須項目
読取ページ画像取得
| パラメータ | 説明 |
|
ユニットID （unitId） |
［ユニットID］をクリックすると36桁の文字列をコピーできます。 |
|
ページID （pageId） |
- |
|
ZIPファイルに含まれる画像のファイル名タイプ （filenameType） |
- |
Elastic Sorter のAPI
仕分けユニット追加
| パラメータ | 説明 |
|
仕分けルールID （sortConfigId）* |
確認したい仕分けルールをクリックし、URLから仕分けルールIDが確認できます。https://xxx.dx-suite.com/wf/?application=elasticSorter&sortConfigId=xxxx |
|
仕分けたいファイル （files）* |
- |
|
仕分けユニット名 （sortUnitName） |
仕分けユニット名は以下で確認できます。 |
|
部署ID （departmentId） |
確認したい部署名をクリックし、部署名の編集画面に遷移後のURLから部署IDが確認できます。https://xxx.dx-suite.com/ConsoleWeb/Dx/Settings/Department/Edit?departmentsId=xxxxx |
|
継続して仕分け処理を開始する （runSorting） |
- |
|
継続してOCRに処理結果を送信する （sendOcr） |
- |
* 必須項目
仕分け実施
| パラメータ | 説明 |
|
仕分けユニットID （sortUnitId）* |
［ユニットID］をクリックすると36桁の文字列をコピーできます。 |
|
部署ID （departmentId） |
確認したい部署名をクリックし、部署名の編集画面に遷移後のURLから部署IDが確認できます。https://xxx.dx-suite.com/ConsoleWeb/Dx/Settings/Department/Edit?departmentsId=xxxxx |
|
継続してOCRに処理結果を送信する （sendOcr） |
- |
* 必須項目
仕分け結果OCR送信
| パラメータ | 説明 |
|
仕分けユニットID （sortUnitId） |
［ユニットID］をクリックすると36桁の文字列をコピーできます。 |
|
部署ID （departmentId） |
確認したい部署名をクリックし、部署名の編集画面に遷移後のURLから部署IDが確認できます。https://xxx.dx-suite.com/ConsoleWeb/Dx/Settings/Department/Edit?departmentsId=xxxxx |
仕分け結果CSVエクスポート
| パラメータ | 説明 |
|
仕分けユニットID （sortUnitId）* |
［ユニットID］をクリックすると36桁の文字列をコピーできます。 |
* 必須項目
仕分けユニット検索
| パラメータ | 説明 |
|
仕分けユニットID （sortUnitId）* |
［ユニットID］をクリックすると36桁の文字列をコピーできます。 |
* 必須項目
仕分けユニット検索で取得できる仕分けユニットのステータスについては、「Elastic Sorter の仕分けステータス」を参照ください。
仕分けユニット削除
| パラメータ | 説明 |
|
仕分けユニットID （sortUnitId）* |
［ユニットID］をクリックすると36桁の文字列をコピーできます。 |
* 必須項目
<関連リンク>
DX Suite 標準API V2 共通仕様ガイド
DX Suite 標準API V2 を利用する場合の業務フロー
読取ユニット内の全パーツ画像取得API レスポンスについて
DX Suite 標準API V2 各APIで確認できるステータス一覧