DX Suite 標準API V2 各APIのパラメータ確認方法

部署ID

（departmentId）

確認したい部署名をクリックし、部署名の編集画面に遷移後のURLから部署IDが確認できます。

https://xxx.dx-suite.com/ConsoleWeb/Dx/Settings/Department/Edit?departmentsId=xxxxx

フォルダ名

（folderName）

取得開始位置

（offset）

取得件数

（limit）

部署ID

（departmentId）

確認したい部署名をクリックし、部署名の編集画面に遷移後のURLから部署IDが確認できます。

https://xxx.dx-suite.com/ConsoleWeb/Dx/Settings/Department/Edit?departmentsId=xxxxx

フォルダ名

（folderName）

フォルダID

（ folderId ）

［フォルダID］をクリックすると36桁の文字列をコピーできます。

フォルダID

（ folderId ）

［フォルダID］をクリックすると36桁の文字列をコピーできます。

フォルダID

（ folderId ）

［フォルダID］をクリックすると36桁の文字列をコピーできます。

ワークフロー名

（workflowName）

ワークフローID

（workflowId）*

［ワークフローID］クリックすると36桁の文字列をコピーできます。

ワークフローのリビジョン

（revision）*

OCR種別

（ocrKindType）

-

フォルダID

（folderId）

［フォルダID］をクリックすると36桁の文字列をコピーできます。

ワークフロー名

（workflowName）

設定ファイル

（documentXmlFile ）

各種設定

（fullTextSettings）

データ結合設定

（concatenate）

データチェックのON/OFF設定

（dataCheck）

アウトプットするファイル名の方式

（outputFileNameType）

アウトプットするファイル名

（outputFileName）

［フォルダID］をクリックすると36桁の文字列をコピーできます。

ワークフロー名

（workflowName）

設定ファイル（documentXmlFile ）

各種設定（fullTextSettings）

データ結合設定

（concatenate）

データチェックのON/OFF設定

（dataCheck）

アウトプットするファイル名の方式

（outputFileNameType）

アウトプットするファイル名

（outputFileName）

［ワークフローID］クリックすると36桁の文字列をコピーできます。

ワークフロー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

（unitId）

ユニット名

（unitName）

ユニットのステータス

（status）

ユニット作成の日時

（createdFrom、createdTo）

ユニットID

（unitId）*

［ユニットID］をクリックすると36桁の文字列をコピーできます。

ユニットID

（unitId）*

ユニットID

（unitId）

［ユニットID］をクリックすると36桁の文字列をコピーできます。

ページID

（pageId）

読取パーツID

（dataItemId）

分割読取パーツID

（detailDataItemId）

ユニットID

（unitId）*

ユニットID

（unitId）

［ユニットID］をクリックすると36桁の文字列をコピーできます。

ページID

（pageId）

ZIPファイルに含まれる画像のファイル名タイプ

（filenameType）

ワークフローID

（workflowId）

取得開始位置

（offset）

取得件数

（limit）

ユニットID

（unitId）

［ユニットID］をクリックすると36桁の文字列をコピーできます。

仕分けルール名

（ruleName）

仕分け種別

（sortKindType）

取得開始位置

（offset）

取得件数

（limit）

仕分けルール名

（ruleName）

仕分け種別

（sortKindType）

仕分けトレイ設定

（traySettings）

仕分けトレイの配列

（trays）

仕分けトレイの名前

（trayName）

-

仕分け距離閾値

（distanceThreshold）

-

キーワード仕分け条件の配列

（sortConditionsGroupList）

-

キーワードとの一致種別

（matchType）

-

仕分け条件のキーワードの配列

（conditionItemList）

-

仕分けルールID

（sortConfigId）

確認したい仕分けルールをクリックし、URLから仕分けルールIDが確認できます。

https://xxx.dx-suite.com/wf/?application=elasticSorter&sortConfigId=xxxx

仕分けルールID

（sortConfigId）*

確認したい仕分けルールをクリックし、URLから仕分けルールIDが確認できます。

https://xxx.dx-suite.com/wf/?application=elasticSorter&sortConfigId=xxxx

仕分けルールID

（sortConfigId）*

確認したい仕分けルールをクリックし、URLから仕分けルールIDが確認できます。

https://xxx.dx-suite.com/wf/?application=elasticSorter&sortConfigId=xxxx

取得開始位置

（offset）

取得件数

（limit）

仕分けルールID

（sortConfigId）*

確認したい仕分けルールをクリックし、URLから仕分けルールIDが確認できます。

https://xxx.dx-suite.com/wf/?application=elasticSorter&sortConfigId=xxxx

仕分けトレイ名

（sortTrayName）

ワークフローID

（workflowId）

仕分け距離閾値

（distanceThreshold）

仕分け条件

（sortConditions）

仕分けトレイID

（sortTrayId）

-

仕分けトレイ名

（sortTrayName）

仕分け距離閾値

（distanceThreshold）

ワークフローID

（workflowId）

仕分け条件

（sortConditions）

仕分けトレイID

（sortTrayId）

-

仕分けユニットID

（sortUnitId）

返却結果の並び順

（orderBy）

仕分けユニットID

（sortUnitId）

ページID

（sortPageId）

仕分けトレイID

（sortTrayId）

仕分けユニットID

（sortUnitId）

ページID

（sortPageId）

仕分けルール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

（departmentId）

確認したい部署名をクリックし、部署名の編集画面に遷移後のURLから部署IDが確認できます。

https://xxx.dx-suite.com/ConsoleWeb/Dx/Settings/Department/Edit?departmentsId=xxxxx

継続してOCRに処理結果を送信する

（sendOcr）

仕分けユニットID

（sortUnitId）

［ユニットID］をクリックすると36桁の文字列をコピーできます。

部署ID

（departmentId）

確認したい部署名をクリックし、部署名の編集画面に遷移後のURLから部署IDが確認できます。

https://xxx.dx-suite.com/ConsoleWeb/Dx/Settings/Department/Edit?departmentsId=xxxxx

仕分けユニットID

（sortUnitId）*

仕分けユニットID

（sortUnitId）*

［ユニットID］をクリックすると36桁の文字列をコピーできます。

仕分けユニットID

（sortUnitId）*

［ユニットID］をクリックすると36桁の文字列をコピーできます。