DX Suite APIs (1.0.0)
Download OpenAPI specification:
DX Suite API ドキュメントへようこそ
DX Suite は、開発者がアプリケーションで活用できるよう、以下の API を公開しています。
これらの API を使用することで、DX Suite の機能を柔軟に統合し、業務効率化を図ることが可能です。
APIの詳細な利用方法や設定については、ヘルプセンターの「APIで連携する」をご参照ください。最新の情報や具体的な例を確認できます。
また、アップロードの推奨値や上限値については、ヘルプセンターの「DX Suite クラウドサービス仕様書」をご確認ください。
ワークフロー検索
登録済みのワークフロー情報を取得します。
Authorizations:
query Parameters
| folderId | string (フォルダID) 指定したフォルダ内のワークフローを検索します。 フォルダIDを複数指定する場合、カンマ区切りで指定可能です。 |
| workflowName | string (ワークフロー名) 指定した文字列に完全一致するワークフローを検索します。 1〜128文字まで指定できます。 日本語で設定する場合は、URLエンコードして設定します。 例) テスト → %e3%83%86%e3%82%b9%e3%83%88 |
Responses
Response samples
- 200
- 400
- 401
- 404
- 500
{- "workflows": [
- {
- "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- "docsetId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- "name": "My workflow"
}, - {
- "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- "docsetId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- "name": "My workflow"
}
]
}ワークフロー設定取得
ワークフローの設定を取得します。
Authorizations:
path Parameters
| workflowId required | string (ワークフローID) |
| revision required | string (ワークフローのリビジョン) ワークフローのリビジョンは1以上の整数です。ワークフローのリビジョンは「読取ユニット状態取得API」にて取得できます。 |
Responses
Response samples
- 200
- 400
- 401
- 404
- 500
{- "workflowId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- "revision": 1,
- "applicationType": 1,
- "ocrKindType": 2,
- "atypicalModelName": "xxxxxx",
- "dataCheck": false,
- "dataProcessing": false,
- "outputCharCode": "2"
}読取ユニット登録
ワークフローに読取ユニットを登録します。
Authorizations:
path Parameters
| workflowId required | string (ワークフローID) |
Request Body schema: multipart/form-data
| files required | string <binary> (追加する画像データファイル) サポートしている拡張子は png、jpg、jpeg、pdf、tiff です。ファイルを複数指定する場合、ファイルの数だけ -F "files=@{ファイル名}" を追加します。 |
| unitName | string (登録するユニット名) ユニット名を1〜128文字で指定します。半角全角英数記号かなカナ漢字を使用できますが、 \ / : * ? " < > | は使用不可文字です。 |
| departmentId | string (部署ID) OCRリクエスト数集計の仕分け先を指定します。形式は数字です。 |
Responses
Response samples
- 200
- 400
- 401
- 404
- 409
- 500
{- "unitId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- "unitName": "test"
}読取ユニット検索
登録済みのユニット情報を取得します。
Authorizations:
query Parameters
| folderId | string (フォルダID) 複数をカンマ区切りで指定可能。{folderId}、{workflowId}、{unitId} はいずれか1つのみ必須となります。 |
| workflowId | string (ワークフローID) 複数をカンマ区切りで指定可能。{folderId}、{workflowId}、{unitId} はいずれか1つのみ必須となります。 |
| unitId | string (ユニットID) 複数をカンマ区切りで指定可能。{folderId}、{workflowId}、{unitId} はいずれか1つのみ必須となります。 |
| unitName | string (ユニット名) 1〜128文字まで指定できます。日本語で設定する場合は、URLエンコードして設定します。 |
| status | string (ユニットのステータス) ステータスを複数指定する場合、カンマ区切りで指定可能です。2: データ化中, 13: データチェック中, 15: コンペア中, 16: コンペア完了, 22: CSVダウンロード済 |
| createdFrom | string (ユニット作成日時(UTC)) 指定したユニット作成日以降のユニットを検索します。 |
| createdTo | string (ユニット作成日時(UTC)) 指定したユニット作成日以前のユニットを検索します。 |
Responses
Response samples
- 200
- 400
- 401
- 404
- 500
{- "units": [
- {
- "unitId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- "unitName": "My unit",
- "status": 22,
- "dataProcessingStatus": 400,
- "dataCheckStatus": 0,
- "dataCompareStatus": 0,
- "csvDownloadStatus": 400,
- "csvFileName": "test",
- "partsImageCreationStatus": 4,
- "folderId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- "workflowId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- "workflowName": "My Workflow",
- "createdAt": "2023-04-13T01:22:43.319337Z"
}, - {
- "unitId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- "unitName": "My unit",
- "status": 22,
- "dataProcessingStatus": 400,
- "dataCheckStatus": 0,
- "dataCompareStatus": 0,
- "csvDownloadStatus": 400,
- "csvFileName": "test",
- "partsImageCreationStatus": 4,
- "folderId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- "workflowId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- "workflowName": "My Workflow",
- "createdAt": "2023-04-13T01:22:43.319337Z"
}
]
}読取パーツ情報取得
登録済みユニットの読取パーツ情報を取得します。
Authorizations:
query Parameters
| unitId | string (ユニットID) 1つのユニットのみ指定可能です。{unitId}、{pageId}、{dataItemId}、{detailDataItemId} はいずれか1つのみ必須となります。 |
| pageId | string (ページID) ページIDはカンマ区切りで複数指定が可能です。但し、複数ユニットに跨るページIDの指定はできません。{unitId}、{pageId}、{dataItemId}、{detailDataItemId} はいずれか1つのみ必須となります。 |
| dataItemId | string (読取パーツID) 読取パーツIDはカンマ区切りで複数指定が可能です。但し、複数ユニットに跨る読取パーツIDの指定はできません。{unitId}、{pageId}、{dataItemId}、{detailDataItemId} はいずれか1つのみ必須となります。 |
| detailDataItemId | string (分割読取パーツID) 分割読取パーツIDはカンマ区切りで複数指定が可能です。但し、複数ユニットに跨る分割読取パーツIDの指定はできません。{unitId}、{pageId}、{dataItemId}、{detailDataItemId} はいずれか1つのみ必須となります。 |
Responses
Response samples
- 200
- 400
- 401
- 404
- 406
- 500
{- "dataItems": [
- {
- "dataItemId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- "detailDataItemId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- "status": 1,
- "folderId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- "workflowId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- "unitId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- "pageId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- "fileName": "sample.png",
- "columnNo": 1,
- "columnName": "銀行名",
- "x": 100.1,
- "y": 200.1,
- "width": 120.1,
- "height": 30.1,
- "result": " テスト銀行",
- "accuracy": 0.9976,
- "accuracyRank": 4,
- "createdAt": "2023-02-21 11:43:14.0"
}, - {
- "dataItemId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- "detailDataItemId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- "status": 1,
- "folderId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- "workflowId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- "unitId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- "pageId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- "fileName": "sample.png",
- "columnNo": 1,
- "columnName": "銀行名",
- "x": 100.1,
- "y": 200.1,
- "width": 120.1,
- "height": 30.1,
- "result": " テスト銀行",
- "accuracy": 0.9976,
- "accuracyRank": 4,
- "createdAt": "2023-02-21 11:43:14.0"
}
]
}読取ユニット内の全パーツ画像取得
登録済みユニット内の全読取パーツ画像を取得します。 ※合計パーツ数（1ページ内の項目数 x ページ数）が3,000以下のユニットで利用できます。
Authorizations:
path Parameters
| unitId required | string (ユニットID) |
Responses
Response samples
- 400
- 401
- 404
- 409
- 500
V1.110以前に作られたユニットです。新しいユニットでもう一度やり直してください。
{- "errorCode": 120014,
- "message": "We do not support old units. Please create a new unit and try again."
}読取ページ画像取得
登録済みユニットのページ画像を取得します。
Authorizations:
query Parameters
| unitId | string (ユニットID) 1つのユニットのみ指定可能です。{unitId}、{pageId} はいずれか1つのみ必須となります。 |
| pageId | string (ページID) ページIDはカンマ区切りで複数指定が可能です。但し、複数ユニットに跨るページIDの指定はできません。{unitId}、{pageId} はいずれか1つのみ必須となります。 |
| filenameType | integer (ZIPファイルに含まれる画像のファイル名タイプ) 1: ページID, 2: アップロード時のファイル名 ※未指定の場合はページIDとなります。 |
Responses
Response samples
- 400
- 401
- 404
- 409
- 500
不正な書式の値がパラメータに指定されています。
{- "errorCode": 10005,
- "message": "{0} was invalid format (Please check the API specification.)"
}読取ユニットID取得
ワークフローに登録されている読取ユニットのIDを取得します。※読取ユニット検索で代用できます。
Authorizations:
path Parameters
| workflowId required | string (ワークフローID) |
query Parameters
| offset | integer (取得開始位置) 何件目(数値)から取得するかを設定します。 |
| limit | integer (取得件数) 1回あたりの取得件数(数値)を設定します。最大10000件 |
Responses
Response samples
- 200
- 400
- 401
- 404
- 500
{- "unitIds": [
- "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
], - "offset": 0,
- "limit": 10000,
- "totalCount": 20000
}読取ユニット状態取得
読取ユニットの状態を取得します。※読取ユニット検索で代用できます。
Authorizations:
path Parameters
| unitId required | string (Unitid) 1〜100件まで指定できます。ユニットIDを複数指定する場合、ユニットIDの数だけパラメータに &unitId={ユニットID} を追加します。 (100件以上のIDを指定した場合は、エラーとはならずに1~100件分のレスポンスとなり、101件以上のレスポンスは含まれません) |
Responses
Response samples
- 200
- 400
- 401
- 404
- 500
[- {
- "unitId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- "unitName": "abc",
- "dataProcessingStatus": 400,
- "dataCheckStatus": 0,
- "dataCompareStatus": 0,
- "csvDownloadStatus": 400,
- "partsImageCreationStatus": 2,
- "workflowId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- "revision": 1,
- "createdAt": "2021-04-21T08:20:45Z",
- "updatedAt": "2021-04-22T09:44:50Z"
}, - {
- "unitId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- "unitName": "abc",
- "dataProcessingStatus": 400,
- "dataCheckStatus": 0,
- "dataCompareStatus": 0,
- "csvDownloadStatus": 400,
- "partsImageCreationStatus": 2,
- "workflowId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- "revision": 1,
- "createdAt": "2021-04-21T08:20:45Z",
- "updatedAt": "2021-04-22T09:44:50Z"
}
]仕分けユニット追加
仕分けユニットに対して、ページ画像を追加します。
Authorizations:
Request Body schema: multipart/form-datarequired
| sortConfigId required | string (仕分けルールID) |
| files required | string <binary> (追加するファイル) サポートしている拡張子は png、jpg、jpeg 、pdf、tiff です。ファイルを複数指定する 場合、ファイルの数だけ -F "files=@{ファイル名}" を追加します。キーワード仕分けルールについては、100ページまで指定可能です。 |
| sortUnitName | string (登録する仕分けユニット名) ※ ユニット名を1〜128文字で指定します。半角全角英数記号かなカナ漢字を使用できますが、 \ / : * ? " < > | は使用不可 文字です。※ 未指定の場合は仕分けルール名+システム日付で設定されます。 |
| departmentId | string (部署ID) OCRリクエスト数集計の仕分け先を指定します。形式は数字です。 |
| runSorting | boolean (継続して仕分け処理を開始する) true:実施する, false:実施しない ※デフォルト値はfalse |
| sendOcr | boolean (継続してOCRに処理結果を送信する) true: 送信する, false: 送信しない ※デフォルト値はfalse |
Responses
Response samples
- 200
- 400
- 401
- 404
- 409
- 500
{- "sortUnitId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- "sortUnitName": "test"
}仕分け処理の実施
仕分けユニットIDを元に仕分けを実施します。
Authorizations:
Request Body schema: multipart/form-datarequired
| sortUnitId required | string (仕分けユニットID) |
| departmentId | string (部署ID) OCRリクエスト数集計の仕分け先を指定します。形式は数字です。 |
| sendOcr | boolean (継続してOCRに処理結果を送信する) true: 送信する, false: 送信しない ※デフォルト値はfalse |
Responses
Response samples
- 200
- 400
- 401
- 404
- 409
- 500
{- "sortUnitId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- "sortUnitName": "test"
}仕分け結果OCR送信
仕分けユニットIDで仕分けした結果をOCRに転送します。
Authorizations:
Request Body schema: multipart/form-datarequired
| sortUnitId required | string (仕分けユニットID) |
| departmentId | string (部署ID) OCRリクエスト数集計の仕分け先を指定します。形式は数字です。 |
Responses
Response samples
- 200
- 400
- 401
- 404
- 409
- 500
{- "sortUnitId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- "sortUnitName": "test"
}仕分けユニット検索
仕分けユニットのステータスを返却します。
Authorizations:
Request Body schema: multipart/form-datarequired
| sortUnitId required | string (仕分けユニットID) |
Responses
Response samples
- 200
- 400
- 401
- 404
- 500
{- "statusCode": 130,
- "statusName": "コンペア完了",
- "pageCountAll": 1,
- "statusList": [
- {
- "readingUnitId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- "sendCountSuccess": 1,
- "sendCountFailure": 0,
- "sendCountAll": 1,
- "statusCode": 130,
- "statusName": "コンペア完了"
}, - {
- "readingUnitId": "0",
- "sendCountSuccess": 0,
- "sendCountFailure": 0,
- "sendCountAll": 0,
- "statusCode": 0,
- "statusName": ""
}
]
}| メッセージ | 内容 | エラーコード |
|---|---|---|
| request had invalid authentication credentials | 認証情報が正しくありません。APIキーをご確認ください。 | 1 300001 |
| no handler found | 存在しないエンドポイントをリクエストしています。 | 2 |
| request method is not allowed | サポートしないHTTPメソッドでリクエストしています。 | 3 |
| request was forbidden | APIにアクセスする権限がありません。接続元のIPアドレスをご確 認ください。 | 300002 |
| {} is required | 必要なパラメータが指定されていません。 | 10001 |
| size of {} must be less than or equal to {} | 一度に指定できるパラメータ数の上限を超えています。 | 10002 |
| {} had invalid characters (Please check the API specification.) | 利用できない文字がパラメータに指定されています。 | 10003 |
| {} was invalid format (Please check the API specification.) | 不正な書式の値がパラメータに指定されています。 | 10005 |
| {} must not be blank (Remove the field or set null if it is not needed.) | パラメータに空文字が指定されています。不要であればこのパラメータを削除してください。 | 10006 |
| {} must not contain blanks | パラメータに空文字が指定されています。不要であればこのパラメータを削除してください。 | 10007 |
| {} length must be between {1} and {2} | パラメータの文字数は{1}から{2}の間の文字数で指定してください。 | 10008 |
| {} was invalid value (Please check the API specification.) | 利用できない値がパラメータに指定されています。 | 10009 |
| one of {} is required | {}のうちのいずれか一つのパラメータを指定してください。 | 10010 |
| {} was invalid pattern (Please check the API specification.) | 利用できない形式の値がパラメータに指定されています。正しい形式で指定してください。 | 10011 |
| {} had invalid characters (Please check the API specification.) | 利用できない文字がパラメータに指定されています。 | 110003 |
| file format (extension) is unsupported | サポートしない形式(拡張子)のファイルがアップロードされています。 | 210001 |
| tiff compression format is unsupported | サポートしないTIFF圧縮形式のファイルがアップロードされています。 | 210002 |
| encrypted pdf is unsupported | サポートしないパスワードつきPDFファイルがアップロードされてい ます。 | 210003 |
| specified department does not exist | 存在しないか誤った部署IDが指定されています。 | 20001 |
| specified resource does not exist | 指定のリソースは存在していないか、アクセスできません。 | 120001 |
| workflow was not ready (Please save the workflow and try again.) | 指定のワークフローは保存されていません。ワークフローを保存してもう一度やり直してください。 | 120002 |
| unit process was not completed. (Please try again after the unit process is completed.) | 指定の読取ユニットはデータ化が完了していません。データ化が完了したらもう一度やり直してください。 | 120003 |
| search conditions that retrieve multiple reading units are not allowed.(Please set the search condition within one unit.) | 検索条件で複数のユニットに跨るパラメータ指定はできません。検索条件のパラメータは1つのユニット内で指定してください。 | 120004 |
| page process was not completed. (Please try again after the page process is completed.) | 指定の読取ページは処理が完了していません。ページ処理が完了したらもう一度やり直してください。 | 120005 |
| workflow for recipient was not determined (Please try again after determining workflow for recipient.) | 送信先のワークフローが確定されていません。ワークフロー確定後もう一度やり直してください。 | 120006 |
| sort unit process was not completed (Please try again after the sort unit process is completed.) | 指定の仕分けユニットは処理が完了していません。処理が完了したらもう一度やり直してください。 | 120007 |
| pre-sorted pages were not found (Please try again after uploading pages.) | 仕分け前トレイにページが存在しません。ファイルアップロード後もう一度やり直してください。 | 120008 |
| sorting was not yet done (Please try again after sorting.) | 仕分けがされていません。仕分け実施後もう一度やり直してください。 | 120009 |
| already sent to OCR | すでにOCR送信済みです。 | 120010 |
| not yet sent to OCR (Please try again after sending to OCR) | OCR未送信です。OCR送信後もう一度やり直してください。 | 120011 |
| sending to OCR was not completed (Please try again after the reading unit process is completed.) | OCR送信が完了していません。対象の読み取りユニットの処理が完了後もう一度やり直してください。 | 120012 |
| conflict error has occurred (Please try again after the process is completed.) | 競合が発生しました。競合した指定リソースの処理が完了した後、 再度やり直してください。 | 120013 |
| We do not support old units. Please create a new unit and try again. | V1.110以前に作られたユニットです。新しいユニットでもう一度やり直してください。 | 120014 |
| specified resource is not available from the API | 指定のリソースはAPIからご利用できません。 | 120015 |
| the maximum page limit has been reached (Please reduce the number of pages and try again.) | ページ数の上限に達しました。ページ数を減らしてもう一度やり直してください。 | 120018 |
| server error has occurred (Please contact our Customer Support Team.) | サーバーエラーが発生しました。カスタマーサポートチームに問い合わせてください。 | 80000 180000 280000 380000 |
読取登録API
読取依頼を登録するAPI
Authorizations:
Request Body schema: multipart/form-data
| files required | string <binary> (送信ファイル) 送信ファイル：必須, 複数指定可 |
| model required | string (利用モデルの名称) 必須、以下のいずれかを指定 |
| classes | string (読み取りクラス名) 任意, カンマ区切り |
| departmentId | string (部署ID) 任意, DX Suiteの「設定」 > 「組織と権限の設定」>「部署一覧」タブにて（該当する部署を選択中に）ブラウザーのURLから確認できるid（数字） |
Responses
Response samples
- 200
- 4xx
- 5xx
{- "receptionId": "string"
}読取結果取得API
読取結果を取得するAPI
Authorizations:
query Parameters
| receptionId required | string (受付ID) |
Responses
Response samples
- 200
- 4xx
- 5xx
{- "status": 0,
- "files": [
- {
- "status": 0,
- "fileName": "string",
- "ocrResults": [
- {
- "status": 0,
- "pageNum": 0,
- "deskewAngle": 0.1,
- "parts": [
- {
- "className": "string",
- "text": "string",
- "detectionConfidence": 0.1,
- "ocrConfidence": 0.1,
- "confidenceScore": 0.1,
- "status": 0,
- "tags": [ ],
- "bbox": {
- "x": 0.1,
- "y": 0.1,
- "width": 0.1,
- "height": 0.1
}
}
]
}
]
}
]
}受付情報取得API
受付情報を取得するAPI
Authorizations:
query Parameters
| departmentId | string (部署ID) DX Suiteの「設定」 > 「組織と権限の設定」>「部署一覧」タブにて（該当する部署を選択中に）ブラウザーのURLから確認できるid（数字） |
| model | string (非定型モデル) 非定型モデル名を以下の中から英名で単一指定 |
| status | integer (読取処理状態) 読取処理状態 |
| limit | integer (取得件数) 取得件数 |
| offset | integer (取得開始位置) |
| receptionDateTimeFrom | string (受付日時From) 取得対象の受付日時Fromを設定する |
| receptionDateTimeTo | string (受付日時To) 取得対象の受付日時Toを設定する |
Responses
Response samples
- 200
- 4xx
- 5xx
{- "receptions": [
- {
- "receptionId": "string",
- "departmentId": "string",
- "model": "string",
- "classes": "string",
- "status": 0,
- "receptionDateTime": "string"
}
]
}データ削除API
読取関連の各データを削除するAPI
Authorizations:
Request Body schema: application/json
| receptionId required | string (受付ID) |
Responses
Request samples
- Payload
{- "receptionId": "string"
}Response samples
- 4xx
- 5xx
{- "errors": [
- {
- "errorCode": "string",
- "message": "string"
}
]
}| メッセージ | 内容 | エラーコード |
|---|---|---|
| The number of pages is too large in the PDF file. 500 pages or less per file is recommended. | PDFファイルのページ数が多すぎます。1ファイルあたり500ページ以下を推奨します。 | 10000 |
| The number of pages is too large in the TIFF file. 500 pages or less per file is recommended. | TIFFファイルのページ数が多すぎます。1ファイルあたり500ページ以下を推奨します。 | 10001 |
| An unsupported filename extension was detected. | サポート対象外のファイル拡張子を検出しました。 | 10002 |
| The file size is too large. Please make it less than 20MB. | ファイルサイズが大きすぎます。20MB以下にしてください。 | 10003 |
| Could not delete due to in-processing. | 処理中により削除できませんでした。 | 10004 |
| {} is a required parameter. | {}は必須パラメータです。 | 10005 |
| Empty value is not permitted. | 空の値は許可されていません。 | 10006 |
| null is not permitted. | nullは許可されていません。 | 10007 |
| There is an unknown field. | 不明なフィールドがあります。 | 10008 |
| For classes, specify the class name separated by commas. | classesにはカンマ区切りでクラス名を指定してください。 | 10009 |
| The id must be a 36-character id (string). | idは36文字のid(文字列)を指定してください。 | 10010 |
| Please select one or more files. | filesは1件以上指定してください。 | 10011 |
| Please specify a valid value for the status. | statusは有効値を指定してください。 | 10013 |
| The format for receptionDateTime is incorrect. | receptionDateTimeのフォーマットが正しくありません。 | 10014 |
| Please specify the {} in numbers. | {}は数字で指定してください。 | 10015 |
| This ID does not exist. | このIDは存在しません。 | 20000 |
| No API key found in request. | APIキーは未設定です。 | 120000 |
| Request had invalid authentication credentials. | ドメインもしくはAPIキーが利用不可の状態です。 | 120001 |
| The department Id is invalid. | 部署IDは不正です。 | 120002 |
| Your IP address is not allowed | IPは許可されていない状態です。 | 120003 |
| A server error has occurred. Please contact our Customer Support Team. | サーバーでエラーが発生しました。カスタマーサポートチームに問い合わせてください。 | 180000 |
| The model or class name is incorrect. Please check the API specification. | モデル名またはクラス名に誤りがあります。API仕様書をチェックしてください。 | 210000 |
| There are no OCR results corresponding to the reception ID. | 受付IDに該当する読取結果は存在しません。 | 210001 |
| A server error has occurred. Please contact our Customer Support Team. | サーバーでエラーが発生しました。カスタマーサポートチームに問い合わせてください。 | 80000 80001 280000 380000 480000 |
全文読取登録API
全文読取を登録するAPI
Authorizations:
Request Body schema: multipart/form-data
| file required | string <binary> (送信ファイル) |
| concatenate | integer (結合オプション) 結合オプション（任意） |
| characterExtraction | integer (文字抽出オプション) 文字抽出オプション（任意） |
| tableExtraction | integer (表抽出オプション) 表抽出オプション（任意） |
| departmentId | integer (部署ID) 部署ID（任意） |
Responses
Response samples
- 200
- 4xx
- 5xx
{- "id": "string"
}全文読取結果取得API
全文読取結果を取得するAPI
Authorizations:
query Parameters
| id required | string (全文読取登録ID) |
Responses
Response samples
- 200
- 4xx
- 5xx
{- "status": "string",
- "results": [
- {
- "fileName": "string",
- "fileSuccess": true,
- "pages": [
- {
- "pageNum": 0,
- "ocrSuccess": true,
- "fullText": "string",
- "ocrResults": [
- {
- "text": 0,
- "bbox": {
- "top": 0.1,
- "bottom": 0.1,
- "right": 0.1,
- "left": 0.1
}, - "vertices": [
- {
- "x": null,
- "y": null
}
], - "characters": [
- {
- "char": "string",
- "ocrConfidence": 0.1,
- "bbox": {
- "top": null,
- "bottom": null,
- "right": null,
- "left": null
}, - "vertices": [
- { }
]
}
]
}
], - "tables": [
- {
- "bbox": {
- "top": 0.1,
- "bottom": 0.1,
- "right": 0.1,
- "left": 0.1
}, - "confidence": 0.1,
- "cells": [
- {
- "bbox": {
- "top": null,
- "bottom": null,
- "right": null,
- "left": null
}, - "col_index": 0,
- "col_span": 0,
- "row_index": 0,
- "row_span": 0,
- "text": "string"
}
]
}
]
}
]
}
]
}サーチャブルPDF登録API
サーチャブルPDFを登録するAPI
Authorizations:
Request Body schema: application/json
| fullOcrJobId required | string (全文読取登録ID) |
| highResolutionMode | integer (高解像度オプション) 登録するサーチャブルPDFを高解像度にするオプション（任意） |
Responses
Request samples
- Payload
{- "fullOcrJobId": "string",
- "highResolutionMode": 0
}Response samples
- 200
- 4xx
- 5xx
{- "id": "string"
}| メッセージ | 内容 | エラーコード |
|---|---|---|
| {} is a required parameter. | 必要なパラメータが指定されていません。 | 10001 |
| {} is an unknown parameter. | 不明なパラメータが設定されています。 | 10002 |
| {} must not be empty. | パラメータに空文字が指定されています。 | 10003 |
| {} had invalid values. | 不正な値がパラメータに指定されています。 | 10005 |
| Please specify {} in numbers. | 該当パラメータは数字で入力指定ください。 | 10006 |
| Please select a file. | 登録するファイルを指定してください。 | 10007 |
| The id must be a 36-character id (string). | idは36文字の文字列を指定してください。 | 10008 |
| The requested URL was not found on the server. If you entered the URL manually please check your spelling and try again. | 存在しないエンドポイント（URL）をリクエストしています。URLに間違いがないかご確認の上、もう一度お試しください。 | 20001 |
| The request method is not allowed for the requested URL. | サポートしないHTTPメソッドでリクエストしています。 | 20002 |
| The file size is too large. Please make it less than 20MB. | ファイルサイズが大きすぎます。20MB以下にしてください。 | 20003 |
| The number of pages is too large in the PDF file. 100 pages or less per file is recommended. | PDFファイルのページ数が多すぎます。1ファイルあたり100ページ以下を推奨します。 | 30001 |
| The number of pages is too large in the TIFF file. 100 pages or less per file is recommended. | TIFFファイルのページ数が多すぎます。1ファイルあたり100ページ以下を推奨します。 | 30002 |
| An unsupported filename extension was detected. | サポート対象外のファイル拡張子を検出しました。 | 30003 |
| The compression format for this tiff file is not supported. | サポートしないTIFF圧縮形式のファイルがアップロードされています。 | 30004 |
| This ID does not exist. | 存在しないか誤ったIDが指定されています。 | 40001 |
| Could not delete due to in-processing. | 処理中により削除できません。 | 40002 |
| Searchable PDF cannot be created due to the full ocr job is in progress. | 全文読取処理が完了していないためサーチャブルPDFを作成できません。 | 50001 |
| Searchable PDF cannot be created due to the full ocr job has failed. | 全文読取処理が失敗しているためサーチャブルPDFを作成できません。 | 50002 |
| No API key found in request. | APIキーを指定してください。 | 120000 |
| Request had invalid authentication credentials. | 存在しないか誤ったドメインもしくはAPIキーが指定されています。 | 120001 |
| The department Id is invalid. | 存在しないか誤った部署IDが指定されています。 | 120002 |
| Your IP address is not allowed | 許可されていないIPアドレスからリクエストしています。 | 120003 |
| A server error has occurred. Please contact our Customer Support Team. | サーバーエラーが発生しました。カスタマーサポートチームに問い合わせてください。 | 80000 180000 380001 380002 380003 380004 |
ドキュメント検索
ドキュメントを検索します。
Authorizations:
query Parameters
| docsetId | string (フォルダID) 複数をカンマ区切りで指定可能 |
| documentName | string (ドキュメント名) |
Responses
Response samples
- 200
- 400
- 401
- 404
- 500
- default
{- "status": "success",
- "errorCode": 0,
- "message": "Document listing.",
- "documents": [
- {
- "docsetId": 123,
- "name": "MyTest",
- "id": 456
}, - {
- "docsetId": 123,
- "name": "MyTest",
- "id": 456
}
]
}読取ユニット検索
読取ユニットを検索します。
Authorizations:
query Parameters
| status | string (読取ユニットのステータス値) 複数をカンマ区切りで指定可能 |
| docsetId | string (フォルダID) 複数をカンマ区切りで指定可能。※フォルダID、ドキュメントID、読取ユニットIDのうち、1つは指定必須。(複数指定不可) |
| documentId | string (ドキュメントID) 複数をカンマ区切りで指定可能。※フォルダID、ドキュメントID、読取ユニットIDのうち、1つは指定必須。(複数指定不可) |
| readingUnitId | string (読取ユニットID) 複数をカンマ区切りで指定可能。※フォルダID、ドキュメントID、読取ユニットIDのうち、1つは指定必須。(複数指定不可) |
| name | string (読取ユニット名) 複数をカンマ区切りで指定可能 |
| createdFrom | string (作成日の範囲の開始日時) yyyy-mm-dd HH:MM:SSで指定 |
| createdTo | string (作成日の範囲の終了日時) yyyy-mm-dd HH:MM:SSで指定 |
Responses
Response samples
- 200
- 400
- 401
- 404
- 500
- default
{- "status": "success",
- "errorCode": 0,
- "message": "ReadingUnit listing",
- "readingUnits": [
- {
- "createdAt": { },
- "csvFileName": "sample.csv",
- "name": "サンプル",
- "docsetId": 123,
- "documentId": 789,
- "id": 135,
- "documentName": "申込書",
- "status": 13
}, - {
- "createdAt": { },
- "csvFileName": "sample.csv",
- "name": "サンプル",
- "docsetId": 123,
- "documentId": 789,
- "id": 135,
- "documentName": "申込書",
- "status": 13
}
]
}読取ページの追加
読取ユニットに対して、ページ画像を追加します。
Authorizations:
Request Body schema: multipart/form-datarequired
| unitId | integer (追加先の読取ユニットID) 読取ユニットIDとドキュメントIDのどちらかは必須項目 |
| documentId | integer (ドキュメントID) 読取ユニットIDとドキュメントIDのどちらかは必須項目 |
| file required | string <binary> (追加ファイル) |
| unitName | string (読取ユニット名) documentIdを指定している場合、作成するユニット名を指定します。省略時は登録した年月日時分秒で設定されます。unitIdを指定した場合は無視されます。 |
| userId | string (ユーザーID) |
Responses
Response samples
- 200
- 400
- 401
- 404
- 500
- default
{- "errorCode": 0,
- "unitId": 438832,
- "id": [
- 6658232,
- 6658232
], - "message": "ReadingPage added.",
- "status": "success"
}読取ページの画像の取得
読取ページの画像をZIPファイルで取得します。
Authorizations:
query Parameters
| readingUnitId | string (読取ユニットID) ※読取ユニットID、読取ページIDのうち、1つは指定必須。(複数指定不可) |
| readingPageId | string (読取ページID) ※読取ユニットID、読取ページIDのうち、1つは指定必須。(複数指定不可) |
| filenameType | string (Zipファイルに含まれる画像のファイル名) 1: ページID, 2: アップロード時のファイル名, 無指定の場合はページIDとなります。 |
Responses
Response samples
- 400
- 401
- 404
- 500
- default
{- "status": "error",
- "errorCode": 104,
- "message": "Bad Request. (Invalid parameter : {パラメータ名} or {パラメータ名}のいずれかは1つのパラメータを設定してください。"
}読取パーツの情報の取得
読取パーツの情報を取得します。
Authorizations:
query Parameters
| readingUnitId | string (ユニットID) １つのユニットのみ指定可能 ※読取ユニットID、読取ページID、読取パーツIDのうち、1つは指定必須。(複数指定不可) |
| readingPageId | string (ページID) 複数をカンマ区切りで指定可能 ※読取ユニットID、読取ページID、読取パーツIDのうち、1つは指定必須。(複数指定不可) |
| readingPartsId | string (パーツID) 複数をカンマ区切りで指定可能 ※読取ユニットID、読取ページID、読取パーツIDのうち、1つは指定必須。(複数指定不可) |
Responses
Response samples
- 200
- 400
- 401
- 404
- 406
- 500
- default
{- "status": "success",
- "errorCode": 0,
- "message": "ReadingParts listing",
- "readingParts": [
- {
- "columnNo": 1,
- "fileName": "sample.jpg",
- "accuracy": 0,
- "readingUnitId": 28494,
- "readingPageId": 48876,
- "result": "2019-001",
- "createdAt": { },
- "accuracyRank": 0,
- "docsetId": 1455,
- "x": 100,
- "width": 120,
- "y": 200,
- "documentId": 4236,
- "id": 12345,
- "status": 16,
- "columnName": "申し込みNo",
- "height": 30
}, - {
- "columnNo": 1,
- "fileName": "sample.jpg",
- "accuracy": 0,
- "readingUnitId": 28494,
- "readingPageId": 48876,
- "result": "2019-001",
- "createdAt": { },
- "accuracyRank": 0,
- "docsetId": 1455,
- "x": 100,
- "width": 120,
- "y": 200,
- "documentId": 4236,
- "id": 12345,
- "status": 16,
- "columnName": "申し込みNo",
- "height": 30
}
]
}仕分けユニット追加
仕分けユニットに対して、ページ画像を追加します。
Authorizations:
Request Body schema: multipart/form-datarequired
| sorterRuleId required | integer (仕分けルールID) |
| sortingUnitName | string (ユニット名) |
| file required | string <binary> (仕分けしたいファイル) |
| runSortingFlag | boolean (継続して仕分け処理を開始する) true:実施する, false:実施しない ※デフォルト値はfalse |
| sendOcrFlag | boolean (継続してOCRに処理結果を送信する) true: 送信する, false: 送信しない ※デフォルト値はfalse |
| userId | string (ユーザーID) |
Responses
Response samples
- 200
- 400
- 401
- 404
- 406
- 500
- default
{- "sortingUnitId": 1350729,
- "errorCode": 0,
- "message": "SortingUnit add success.",
- "status": "success"
}仕分け処理の実施
仕分けユニットIDを元に仕分けを実施します。
Authorizations:
query Parameters
| sortingUnitId required | string (仕分けユニットID) |
| sendOcrFlag | boolean (継続してOCRに処理結果を送信する) true:実施する, false:実施しない ※デフォルト値はfalse |
| userId | string (ユーザーID) |
Responses
Response samples
- 200
- 400
- 401
- 404
- 406
- 500
- default
{- "errorCode": 0,
- "message": "Start sorting. [sorting_unit_id: 4]",
- "status": "success"
}仕分け結果をOCRに送信
仕分けユニットIDで仕分けした結果をOCRに転送します。
Authorizations:
query Parameters
| sortingUnitId required | string (仕分けユニットID) |
| userId | string (ユーザーID) |
Responses
Response samples
- 200
- 400
- 401
- 404
- 406
- 500
- default
{- "errorCode": 0,
- "message": "Start sorting. [sorting_unit_id: 4]",
- "status": "success"
}仕分けユニット検索
仕分けユニットのステータスを返却します。
Authorizations:
query Parameters
| sortingUnitId required | string (仕分けユニットID) |
Responses
Response samples
- 200
- 401
- 404
- 500
- default
{- "statusList": [
- {
- "sendCountFailure": 0,
- "sendCountSuccess": 2,
- "sendCountAll": 2,
- "statusName": "OCRエントリー中",
- "readingUnitId": 27923,
- "statusCode": 100
}, - {
- "sendCountFailure": 0,
- "sendCountSuccess": 2,
- "sendCountAll": 2,
- "statusName": "OCRエントリー中",
- "readingUnitId": 27923,
- "statusCode": 100
}
], - "statusName": "OCRエントリー中",
- "pageCountAll": 3,
- "errorCode": 0,
- "message": "",
- "status": "success",
- "statusCode": 100
}