APIエラーリスト

説明概要

APIを使用する際に発生するエラーの内容を説明します。
APIを呼ぶ際に発行するGET/POSTリクエストに対してエラーとなる場合、以下の内容が返されます。

HTTPレスポンスのコード一覧

HTTPレスポンスコード 説明
200 正常に処理されました。
400 下記リスト以外のエラーが発生しました。
Body部にJSON形式のテキスト(UTF-8)を含みます。
401 ユーザ認証に失敗しました。
403 認証されたユーザが、指定した操作を実行する権限を持っていません。

HTTPレスポンスコードが「400」の場合のエラー内容

エラー応答オブジェクト

HTTPレスポンスコードが「400」の場合、エラーの詳細情報は以下の形式で返されます。

ErrorEntryの構造

属性名 型 説明
errorCode 文字列 エラーコード
type 文字列 エラー種別
input 文字列 エラーの原因となった入力値

エラー応答の例


 {"errors":[{"errorCode":"20002","input":"foo@localhost.localdomain","type":"QuserDoesNotExist"}]}

エラーコード一覧

エラーコード
(errorCode)		 エラー種別
(type)		 説明
10000 Validation 特定のパラメータでバリデーションエラーが発生しました。
10001 InvalidId 不正なidが指定されました。
idは、0～9223372036854775807の整数を指定してください。
10002 InvalidQuserId 不正なquserIdが指定されました。
quserIdは、0～9223372036854775807の整数を指定してください。
10003 InvalidQgroupId 不正なqgroupIdが指定されました。
qgroupIdは、0～9223372036854775807の整数を指定してください。
10004 InvalidName 不正なnameが指定されました。
nameは、64文字以内の文字列を指定してください。
10005 InvalidEmail 不正なemailが指定されました。
emailは、256文字以内のメールアドレスを指定してください。
10006 InvalidPassword 不正なpasswordが指定されました。
passwordは、8文字から16文字の半角英数記号を指定してください。
または、システム管理者が設定したパスワードポリシーに適合した値を指定してください。
10007 InvalidDelegateQuserId 不正なdelegateQuserIdが指定されました。
qgroupIdは、0～9223372036854775807の整数を指定してください。
10008 InvalidDelegateQgroupId 不正なdelegateQgroupIdが指定されました。
qgroupIdは、0～9223372036854775807の整数を指定してください。
10009 InvalidParentQgroupId 不正なparentQgroupIdが指定されました。
qgroupIdは、0～9223372036854775807の整数を指定してください。
10010 InvalidRole 不正な組織役割(ロール)が指定されました。
ロールは、「null」か「_leader」のみを指定してください。
10011 InvalidActivityId 不正なactivityIdが指定されました。
activityIdは、0～9223372036854775807の整数を指定してください。
10012 InvalidStart 不正なstartが指定されました。
startは、0～2147483647の整数を指定してください。
10013 InvalidLimit 不正なlimitが指定されました。
limitは、0～1000の整数を指定してください。
10014 InvalidProcessInstanceId 不正なprocessInstanceIdが指定されました。
processInstanceIdは、0～9223372036854775807の整数を指定してください。
10015 InvalidProcessDataInstanceId 不正なprocessDataInstanceIdが指定されました。
processDataInstanceIdは、0～9223372036854775807の整数を指定してください。
10016 InvalidWorkitemId 不正なworkitemIdが指定されました。
workitemIdは、0～9223372036854775807の整数を指定してください。
10017 InvalidProcessModelInfoId 不正なprocessModelInfoIdが指定されました。
processModelInfoIdは、0～9223372036854775807の整数を指定してください。
10018 InvalidNodeNumber 不正なnodeNumberが指定されました。
nodeNumberは、0～9223372036854775807の整数を指定してください。
10019 InvalidQroleId 不正なqroleIdが指定されました。
qroleIdは、0～9223372036854775807の整数を指定してください。
10020 InvalidSystemAuthorityType 不正なsystemAuthorityTypeが指定されました(指定なし、または0,1,2以外の指定)。
systemAuthorityTypeは、0,1,2の整数を指定してください。
10021 InvalidProcessAuthorityType 不正なprocessAuthorityTypeが指定されました(指定なし、または0,1,2,3以外の指定)。
processAuthorityTypeは、0,1,2,3の整数を指定してください。
20001 QuserExists emailの重複するユーザが存在します。
20002 QuserDoesNotExist 指定したユーザが存在しません。
20003 QgroupExists nameの重複する組織が存在します。
20004 QgroupDoesNotExist 指定した組織が存在しません。
20005 MembershipExists 重複する組織のメンバが存在します。
20006 MembershipDoesNotExist 指定した組織のメンバが存在しません。
20007 DelegateDoesNotExist ユーザ削除時にタスクを引き継ぐユーザが存在しません。
20008 NoneSystemAdministrator 操作の結果、システム管理者権限を持つユーザが1人も存在しなくなります。
20009 ParentQgroupUndeletable 子組織を持つ組織を削除しようとしました。
20010 RootQgroupUndeletable ルート組織を削除しようとしました。
20011 LoopedOrganization 組織の階層構造がループになるような変更をしようとしました。
20012 ActivityDoesNotExist activityIdで指定したタスクが存在しません。
20013 ParentQgroupDoesNotExist 親組織で指定した組織が存在しません。
20014 DelegateIsSameWithDeletingQuser ユーザ削除時のタスク引き継ぎユーザに、削除ユーザを指定しました。
20015 NeedDelegate ユーザ削除時に、削除するユーザがマイタスクを保持していているが、代理ユーザの指定がされていません。
20016 ProcessInstanceDoesNotExist processInstanceIdで指定したプロセスが存在しません。
20017 QuserNameExists nameが重複したユーザが存在します。
20018 QroleExists nameが重複したロールが存在します。
20019 QroleDoesNotExist 指定したロールが存在しません。
20020 RoleMembershipExists 指定したユーザがすでに指定したロールに所属しています。
20021 RoleMembershipDoesNotExist 指定したユーザが指定したロールに所属していません。
20022 YourselfUndeletable APIを実行しているユーザ自身は削除できません。
20023 SystemAuthorityDoesNotExist 指定したシステム権限が存在しません。
20024 ProcessAuthorityDoesNotExist 指定したプロセス権限が存在しません。
20025 ProcessModelInfoDoesNotExist processModelInfoIdで指定したプロセスモデルが存在しません。
30004 InstanceNumberExceeding プロセス数制限を超えてプロセスを起動しようとしました。
30005 UserNumberExceeding ユーザ数制限を超えている状態でプロセスを起動しようとしました。
または、ユーザ数制限を超えてユーザを登録しようとしました。
30007 OverQuota 短時間に大量のプロセスを起動しようとしました。
40000 NeedToAcceptOtherWorkitems まとめて引き受けなければならないタスクが他に存在します。
40001 WorkitemIsNotOffered タスクが自分にはオファーされていません。
40002 WorkitemStatusAlreadyChanged オファー状態でないタスクを引き受けようとしました。
40003 WorkitemDoesNotExist タスクが存在しません。
40006 WorkitemFinished タスクが完了しています。
40007 ProcessInstanceFinished プロセスが終了しています。