以下はそれぞれのAPIについて発生し得るエラーコードです。
<関連マニュアル>
共通
| HTTPステータス | エラーコード | エラーメッセージ | 説明 |
| 401 | 1 | request had invalid authentication credentials | 認証情報が正しくありません。APIキーをご確認ください。 |
| 404 | 120001 | specified resource does not exist | 指定のリソースは存在していないか、アクセスできません。 |
| 405 | 3 | request method is not allowed | サポートしないHTTPメソッドでリクエストしています。 |
| 401 | 300001 | request had invalid authentication credentials |
認証情報が正しくありません。APIキーをご確認ください。 |
| 403 | 300002 | request was forbidden |
APIにアクセスする権限がありません。接続元のIPアドレスをご確認ください。 |
| 500 | 380000 | server error has occurred (Please contact our Customer Support Team.) | サーバーエラーが発生しました。時間を置いて試してください。エラーの事象が解消されない場合、カスタマーサポートチームに問い合わせてください。 |
| 500 | 80000 | server error has occurred (Please contact our Customer Support Team.) | サーバーエラーが発生しました。時間を置いて試してください。エラーの事象が解消されない場合、カスタマーサポートチームに問い合わせてください。 |
| 500 | 280000 | server error has occurred (Please contact our Customer Support Team.) | サーバーエラーが発生しました。時間を置いて試してください。エラーの事象が解消されない場合、カスタマーサポートチームに問い合わせてください。 |
| 500 | 180000 | server error has occurred (Please contact our Customer Support Team.) | サーバーエラーが発生しました。時間を置いて試してください。エラーの事象が解消されない場合、カスタマーサポートチームに問い合わせてください。 |
※ すべてのAPIに共通するエラーコードとなります。
(1)ワークフロー検索API
| HTTPステータス | エラーコード | エラーメッセージ | 説明 |
| 400 | 10005 | {0} was invalid format (Please check the API specification.) | 不正な書式の値がパラメータに指定されています。 |
| 400 | 10008 | {0} length must be between {2} and {1} |
パラメータの文字数は{1}から{2}の間の文字数で指定してください。 |
| 404 | 120001 | specified resource does not exist | 指定のリソースは存在していないか、アクセスできません。 |
(2)ワークフロー設定取得API
| HTTPステータス | エラーコード | エラーメッセージ | 説明 |
| 404 | 120001 | specified resource does not exist |
指定のリソースは存在していないか、アクセスできません。 |
(3)読取ユニット登録API
| HTTPステータス | エラーコード | エラーメッセージ | 説明 |
| 400 | 10001 | {0} is required | 必要なパラメータが指定されていません。 |
| 400 | 10002 | size of {0} must be less than or equal to {1} |
一度に指定できるパラメータ数の上限を超えています。 |
| 400 | 10003 | {0} had invalid characters (Please check the API specification.) | 利用できない文字がパラメータに指定されています。 |
| 400 | 10006 | {0} must not be blank (Remove the field or set null if it is not needed.) |
パラメータに空文字が指定されています。不要であればこのパラメータを削除してください。 |
| 400 | 10008 | {0} length must be between {2} and {1} |
パラメータの文字数は{1}から{2}の間の文字数で指定してください。 |
| 400 | 20001 |
specified department does not exist |
存在しないか誤った部署IDが指定されています。 |
| 400 | 110003 | {0} had invalid characters (Please check the API specification.) | 利用できない文字がパラメータに指定されています。 |
| 404 | 120001 | specified resource does not exist | 指定のリソースは存在していないか、アクセスできません。 |
| 409 | 120002 | workflow was not ready (Please save the workflow and try again.) |
指定のワークフローは保存されていません。ワークフローを保存してもう一度やり直してください。 |
| 400 | 210001 | file format (extension) is unsupported |
サポートしない形式(拡張子)のファイルがアップロードされています。 |
| 400 | 210002 | tiff compression format is unsupported |
サポートしないTIFF圧縮形式のファイルがアップロードされています。 |
| 400 | 210003 | encrypted pdf is unsupported |
サポートしないパスワードつきPDFファイルがアップロードされています。 |
(4)読取ユニット検索API
| HTTPステータス | エラーコード | エラーメッセージ | 説明 |
| 400 | 10003 | {0} had invalid characters (Please check the API specification.) | 利用できない文字がパラメータに指定されています。 |
| 400 | 10005 | {0} was invalid format (Please check the API specification.) | 不正な書式の値がパラメータに指定されています。 |
| 400 | 10006 | {0} must not be blank (Remove the field or set null if it is not needed.) |
パラメータに空文字が指定されています。不要であればこのパラメータを削除してください。 |
| 400 | 10008 | {0} length must be between {2} and {1} |
パラメータの文字数は{1}から{2}の間の文字数で指定してください。 |
| 400 | 10009 | {0} was invalid value (Please check the API specification.) | 利用できない値がパラメータに指定されています。 |
| 400 | 10010 | one of {1} is required |
{}のうちのいずれか一つのパラメータを指定してください。 |
| 404 | 120001 | specified resource does not exist | 指定のリソースは存在していないか、アクセスできません。 |
(5)CSVダウンロードAPI
| HTTPステータス | エラーコード | エラーメッセージ | 説明 |
| 404 | 120001 | specified resource does not exist | 指定のリソースは存在していないか、アクセスできません。 |
| 409 | 120003 | unit process was not completed. (Please try again after the unit process is completed.) |
指定の読取ユニットはデータ化が完了していません。データ化が完了したらもう一度やり直してください。 |
(6)読取ユニット削除API
| HTTPステータス | エラーコード | エラーメッセージ | 説明 |
| 404 | 120001 | specified resource does not exist |
指定のリソースは存在していないか、アクセスできません。 |
| 409 | 120003 | unit process was not completed. (Please try again after the unit process is completed.) | 指定の読取ユニットはデータ化が完了していません。データ化が完了したらもう一度やり直してください。 |
(7)読取パーツ情報取得API
| HTTPステータス | エラーコード | エラーメッセージ | 説明 |
| 400 | 10005 | {0} was invalid format (Please check the API specification.) |
不正な書式の値がパラメータに指定されています。 |
| 400 | 10010 | one of {1} is required | {}のうちのいずれか一つのパラメータを指定してください。 |
| 404 | 120001 | specified resource does not exist |
指定のリソースは存在していないか、アクセスできません。 |
| 406 | 120004 | search condition that retrieve multiple reading units are not allowed.) | 検索条件で複数のユニットに跨るパラメータ指定はできません。検索条件のパラメータは1つのユニット内で指定してください。 |
(8)読取ページ画像取得API
| HTTPステータス | エラーコード | エラーメッセージ | 説明 |
| 400 | 10005 | {0} was invalid format (Please check the API specification.) |
不正な書式の値がパラメータに指定されています。 |
| 400 | 10009 | {0} was invalid value (Please check the API specification.) |
利用できない値がパラメータに指定されています。 |
| 400 | 10010 | one of {1} is required |
{}のうちのいずれか一つのパラメータを指定してください。 |
| 404 | 120001 | specified resource does not exist |
指定のリソースは存在していないか、アクセスできません。 |
| 409 | 120005 | page process was not completed. (Please try again after the page process is completed.) |
指定の読取ページは処理が完了していません。ページ処理が完了したらもう一度やり直してください。 |
(9)読取ユニットID取得API
| HTTPステータス | エラーコード | エラーメッセージ | 説明 |
| 400 | 10005 | {0} was invalid format (Please check the API specification.) | 不正な書式の値がパラメータに指定されています。 |
| 404 | 120001 | specified resource does not exist | 指定のリソースは存在していないか、アクセスできません。 |
(10)読取ユニット状態取得API
| HTTPステータス | エラーコード | エラーメッセージ | 説明 |
| 400 | 10001 | {0} is required |
必要なパラメータが指定されていません。 |
| 400 | 10002 | size of {0} must be less than or equal to {1} | 一度に指定できるパラメータ数の上限を超えています。 |
| 400 | 10007 | {0} must not contain blanks | パラメータに空文字が指定されています。不要であればこのパラメータを削除してください。 |
| 404 | 120001 | specified resource does not exist |
指定のリソースは存在していないか、アクセスできません。 |
(11)仕分けユニット追加API
| HTTPステータス | エラーコード | エラーメッセージ | 説明 |
| 400 | 10001 | {0} is required |
必要なパラメータが指定されていません。 |
| 400 | 10002 | size of {0} must be less than or equal to {1} |
一度に指定できるパラメータ数の上限を超えています。 |
| 400 | 10003 | {0} had invalid characters (Please check the API specification.) | 利用できない文字がパラメータに指定されています。 |
| 400 | 10006 | {0} must not be blank (Remove the field or set null if it is not needed.) |
パラメータに空文字が指定されています。不要であればこのパラメータを削除してください。 |
| 400 | 10008 | {0} length must be between {2} and {1} |
パラメータの文字数は{1}から{2}の間の文字数で指定してください。 |
| 400 | 10011 | {0} was invalid pattern (Please check the API specification.) |
利用できない形式の値がパラメータに指定されています。正しい形式で指定してください。 |
| 400 | 20001 | specified department does not exist | 存在しないか誤った部署IDが指定されています。 |
| 404 | 120001 | specified resource does not exist | 指定のリソースは存在していないか、アクセスできません。 |
| 400 | 210001 | file format (extension) is unsupported |
サポートしない形式(拡張子)のファイルがアップロードされています。 |
| 400 | 210002 | tiff compression format is unsupported | サポートしないTIFF圧縮形式のファイルがアップロードされています。 |
| 400 | 210003 | encrypted pdf is unsupported | サポートしないパスワードつきPDFファイルがアップロードされています。 |
(12)仕分け実施API
| HTTPステータス | エラーコード | エラーメッセージ | 説明 |
| 400 | 10001 | {0} is required |
必要なパラメータが指定されていません。 |
| 400 | 10006 | {0} must not be blank (Remove the field or set null if it is not needed.) |
パラメータに空文字が指定されています。不要であればこのパラメータを削除してください。 |
| 400 | 10011 | {0} was invalid pattern (Please check the API specification.) |
利用できない形式の値がパラメータに指定されています。正しい形式で指定してください。 |
| 400 | 20001 | specified department does not exist | 存在しないか誤った部署IDが指定されています。 |
| 404 | 120001 | specified resource does not exist | 指定のリソースは存在していないか、アクセスできません。 |
| 409 | 120007 | sort unit process was not completed (Please try again after the sort unit process is completed.) |
指定の仕分けユニットは処理が完了していません。処理が完了したらもう一度やり直してください。 |
| 404 | 120008 | pre-sorted pages were not found (Please try again after uploading pages.) |
仕分け前トレイにページが存在しません。ファイルアップロード後もう一度やり直してください。 |
(13)仕分け結果OCR送信API
| HTTPステータス | エラーコード | エラーメッセージ | 説明 |
| 400 | 20001 | specified department does not exist | 存在しないか誤った部署IDが指定されています。 |
| 404 | 120001 | specified resource does not exist |
指定のリソースは存在していないか、アクセスできません。 |
| 404 | 120006 | workflow for recipient was not determined (Please try again after determining workflow for recipient.) |
送信先のワークフローが確定されていません。ワークフロー確定後もう一度やり直してください。 |
| 409 | 120007 | sort unit process was not completed (Please try again after the sort unit process is completed.) |
指定の仕分けユニットは処理が完了していません。処理が完了したらもう一度やり直してください。 |
| 404 | 120009 | sorting was not yet done (Please try again after sorting.) | 仕分けがされていません。仕分け実施後もう一度やり直してください。 |
| 409 | 120010 | already sent to OCR |
仕分けがされていません。仕分け実施後もう一度やり直してください。 |
(14)仕分け結果CSVエクスポートAPI
| HTTPステータス | エラーコード | エラーメッセージ | 説明 |
| 400 | 10001 | {0} is required | 必要なパラメータが指定されていません。 |
| 400 | 10011 | {0} was invalid pattern (Please check the API specification.) | 利用できない形式の値がパラメータに指定されています。正しい形式で指定してください。 |
| 404 | 120001 | specified resource does not exist | 指定のリソースは存在していないか、アクセスできません。 |
| 409 | 120007 | sort unit process was not completed (Please try again after the sort unit process is completed.) |
指定の仕分けユニットは処理が完了していません。処理が完了したらもう一度やり直してください。 |
| 404 | 120011 | not yet sent to OCR (Please try again after sending to OCR) | OCR未送信です。OCR送信後もう一度やり直してください。 |
| 404 | 120012 | sending to OCR was not completed (Please try again after the reading unit process is completed.) | OCR送信が完了していません。対象の読み取りユニットの処理が完了後もう一度やり直してください。 |
(15)仕分けユニット検索API
| HTTPステータス | エラーコード | エラーメッセージ | 説明 |
| 400 | 10001 | {0} is required |
必要なパラメータが指定されていません。 |
| 400 | 10011 | {0} was invalid pattern (Please check the API specification.) |
利用できない形式の値がパラメータに指定されています。正しい形式で指定してください。 |
| 404 | 120001 | specified resource does not exist |
指定のリソースは存在していないか、アクセスできません。 |
(16)仕分けユニット削除API
| HTTPステータス | エラーコード | エラーメッセージ | 説明 |
| 400 | 10001 | {0} is required | 必要なパラメータが指定されていません。 |
| 400 | 10011 | {0} was invalid pattern (Please check the API specification.) |
利用できない形式の値がパラメータに指定されています。正しい形式で指定してください。 |
| 404 | 120001 | specified resource does not exist |
指定のリソースは存在していないか、アクセスできません。 |
| 409 | 120007 | sort unit process was not completed (Please try again after the sort unit process is completed.) |
指定の仕分けユニットは処理が完了していません。処理が完了したらもう一度やり直してください。 |
(17)読取パーツ画像取得API
| HTTPステータス | エラーコード | エラーメッセージ | 説明 |
| 400 | 120014 | We do not support old units. Please create a new unit and try again. | 古いユニットはサポートしていません。 新しいユニットを作成して再試行してください。 |
| 404 | 120001 | specified resource does not exist |
指定のリソースは存在していないか、アクセスできません。 |
| 409 | 120005 | page process was not completed. (Please try again after the page process is completed.) |
指定の読取ページは処理が完了していません。ページ処理が完了したらもう一度やり直してください。 |