6.1.9.3.3. 申請¶
申請を実行します。
6.1.9.3.3.1. HTTP リクエスト¶
POST /api/workflow/applications/flow/apply
6.1.9.3.3.2. リクエストボディ¶
6.1.9.3.3.2.1. JSON¶
{
"applyProcessParameter": {
"applyAuthUserCd": "string",
"applyBaseDate": "string",
"authUserDepartmentInfo": {
"companyCd": "string",
"departmentCd": "string",
"departmentSetCd": "string"
},
"branchSelects": [
{
"branchStartNodeId": "string",
"forwardNodeIds": [
"string"
]
}
],
"confirmNodeConfigs": [
{
"nodeId": "string",
"processTargetConfigs": [
{
"extensionPointId": "string",
"parameter": "string",
"pluginId": "string"
}
]
}
],
"dynamicNodeConfigs": [
{
"nodeId": "string",
"processTargetConfigs": [
{
"extensionPointId": "string",
"parameter": "string",
"pluginId": "string"
}
]
}
],
"flowId": "string",
"horizontalNodeConfigs": [
{
"matterNodeExpansions": [
{
"nodeName": "string",
"processTargetConfigs": [
{
"extensionPointId": "string",
"parameter": "string",
"pluginId": "string"
}
]
}
],
"nodeId": "string"
}
],
"matterName": "string",
"nego": {
"subject": "string",
"text": "string",
"userCdsBcc": [
"string"
],
"userCdsCc": [
"string"
],
"userCdsTo": [
"string"
]
},
"priorityLevel": "string",
"processComment": "string",
"temporaryDirectoryKey": "string",
"userDataId": "string",
"verticalNodeConfigs": [
{
"matterNodeExpansions": [
{
"nodeName": "string",
"processTargetConfigs": [
{
"extensionPointId": "string",
"parameter": "string",
"pluginId": "string"
}
]
}
],
"nodeId": "string"
}
]
},
"optionalParameter": {}
}
6.1.9.3.3.3. レスポンスデータ¶
6.1.9.3.3.3.1. JSON¶
{
"data": {
"matterNumber": "string",
"systemMatterId": "string",
"userDataId": "string"
}
}
6.1.9.3.3.3.2. 詳細¶
| プロパティ名 | 論理名 | 型 | 説明 |
|---|---|---|---|
| - matterNumber | 案件番号 | string | |
| - systemMatterId | システム案件ID | string | |
| - userDataId | ユーザデータID | string |
6.1.9.3.3.4. エラーコード¶
| エラーコード | エラーメッセージ | 備考 |
|---|---|---|
| 1005 | 申請情報が未指定です。 | リクエストボディ が未指定の場合 |
| 5056 | 日付の認識に失敗しました。管理者に連絡してください。 | 申請基準日 のフォーマットが「yyyy/MM/dd」ではない場合 |
| 1137 | ワークフローパラメータの取得に失敗しました。管理者に連絡してください。 | ワークフローパラメータ「user-data-id-set-mode」の値の取得に失敗した場合 |
| 1138 | システム一意なIDの取得に失敗しました。管理者に連絡してください。 | Identifier.get()を用いてシステム一意なIDの取得に失敗した場合 |
| 1015 | フローIDが未指定です。 | リクエストボディ - 処理パラメータ - flowId が未指定の場合 |
| 0021 | ユーザデータIDに紐づく一時保存情報への権限がありません。 | リクエストボディ - 処理パラメータ - userDataId に紐づく一時保存情報への権限がない場合 |
| 0022 | ユーザデータIDに紐づく一時保存情報への権限チェックに失敗しました。 | リクエストボディ - 処理パラメータ - userDataId に紐づく一時保存情報の取得、または権限チェックに失敗した場合 |
| 1082 | 申請基準日のフォーマットが不正です | リクエストボディ - 処理パラメータ - applyBaseDate のフォーマットが yyyy/MM/dd ではない場合 |
| 0003 | 指定したフロー、申請基準日、権限者に対する申請権限がありません。 | リクエストボディ - 処理パラメータ - flowId 、 リクエストボディ - 処理パラメータ - applyBaseDate 、 リクエストボディ - 処理パラメータ - authUserCd 、 アカウントコンテキストのユーザコードをもとにした、フローへの申請権限チェックで権限がないと判定された場合 |
| 0004 | 申請権限のチェックに失敗しました。管理者に連絡してください。 | リクエストボディ - 処理パラメータ - flowId 、 リクエストボディ - 処理パラメータ - applyBaseDate 、 リクエストボディ - 処理パラメータ - authUserCd 、 アカウントコンテキストのユーザコードをもとにした、フローへの申請権限チェックに失敗した場合 |
| 0005 | 申請可能な組織権限がありません。 | リクエストボディ - 処理パラメータ - flowId 、 リクエストボディ - 処理パラメータ - applyBaseDate 、 リクエストボディ - 処理パラメータ - authUserCd 、 アカウントコンテキストのユーザコードをもとにした、フローの組織処理権限情報が存在しない場合 |
| 0006 | 組織権限情報の取得に失敗しました。管理者に連絡してください。 | リクエストボディ - 処理パラメータ - flowId 、 リクエストボディ - 処理パラメータ - applyBaseDate 、 リクエストボディ - 処理パラメータ - authUserCd 、 アカウントコンテキストのユーザコードをもとにした、フローの組織処理権限情報の取得に失敗した場合 |
| 3000 | 申請設定情報が存在しません。管理者に連絡してください。 | 申請ノードのノード設定情報が見つからなかった場合 |
| 3001 | 申請基準日時点で無効なフローです。 | 当該フローのバージョンが見つからない場合や、ユーザ無効にされている場合 |
| 3002 | ルート情報が不正です。管理者に連絡してください。 | フロー定義に紐づくルート情報が見つからない場合（マスタ不正） |
| 3003 | ルート情報が不正です。管理者に連絡してください。 | 申請ノードの定義情報が見つからない場合（マスタ不正） |
| 3004 | フロー情報の取得に失敗しました。管理者に連絡してください。 | 申請ノードのノード設定情報取得に失敗した場合 |
| 0011 | 権限者組織情報が不正です。 | 以下のいずれかに合致する場合
リクエストボディ - 処理パラメータ - authUserDepartmentInfo - companycd が未指定の場合
リクエストボディ - 処理パラメータ - authUserDepartmentInfo - departmentSetCd が未指定の場合
リクエストボディ - 処理パラメータ - authUserDepartmentInfo - departmentCd が未指定の場合
|
| 0012 | 指定された所属組織情報は処理権限がありません。 | リクエスト情報に含まれる権限組織情報（ リクエストボディ - 処理パラメータ - authUserDepartmentInfo - companycd , departmentSetCd , departmentCd ）では、当該案件に対する処理権限がない場合 |
| 1063 | 申請基準日チェックに必要な情報が取得できませんでした。 | チェックに必要なフロー、フローバージョン、フロー詳細情報が見つからなかった場合 |
| 1064 | 申請基準日チェック処理でエラーが発生しました。 | チェックに必要なフロー、フローバージョン、フロー詳細情報の取得に失敗した場合 |
| 1065 | 申請できない申請基準日です。 | フロー設定で「システム日で対象者を展開する」 の設定が有効であるが、 リクエストボディ - 処理パラメータ - applyBaseDate の値が現在日ではない場合 |
| 1051 | 案件名が許可された最大文字数を超えています。 | リクエストボディ - 処理パラメータ - matterName の値が、ワークフローパラメータ「 matter-name-size （ 入力項目の設定 ）」で指定されたサイズを超えている場合 |
| 1052 | 案件名のチェック処理でエラーが発生しました。管理者に連絡してください。 |
| 1025 | コメントが許可された最大文字数を超えています。 | リクエストボディ - 処理パラメータ - processComment の値が、ワークフローパラメータ「 confirm-comment-size （ 入力項目の設定 ）」で指定されたサイズを超えている場合 |
| 1026 | コメントのチェック処理でエラーが発生しました。管理者に連絡してください。 |
| 1055 | 存在しない優先度が指定されています。 | 「CodeList」 のコード値以外の値が指定されている場合 |
| 1018 | 指定できる分岐開始ノードが存在しません。 | 処理対象のノードが分岐先設定可能ノードとして一つも設定されていない場合 |
| 1019 | 分岐先ノードが未指定です。 | 処理対象のノードが分岐先設定可能ノードとして設定されているが、 リクエストボディ - 処理パラメータ - branchSelects が未指定の場合 |
| 1020 | 設定が必須な分岐先ノード数と指定された分岐先ノード数が異なります。 | 処理対象のノードが分岐先設定可能ノードとして設定されている数と、 リクエストボディ - 処理パラメータ - branchSelects の要素数が異なっている場合 |
| 1021 | 分岐先ノードの入力情報に不備があります。 | 以下のいずれかに合致する場合
リクエストボディ - 処理パラメータ - branchSelects - branchStartNodeId が未指定の場合
リクエストボディ - 処理パラメータ - branchSelects - forwardNodeIds が未指定の場合
リクエストボディ - 処理パラメータ - branchSelects - forwardNodeIds に null 、 ブランク 等の値が指定されている場合
|
| 1022 | 同一の分岐先ノード対して指定が重複しています。 | リクエストボディ - 処理パラメータ - branchSelects - branchStartNodeId に重複が存在する場合 |
| 1023 | 選択可能なルートは単一であるのに対し分岐先ノードが複数指定されています。 | 処理対象のノードでは分岐先選択可能数として単一が指定されているが、 リクエストボディ - 処理パラメータ - branchSelects - forwardNodeIds の要素数が2以上である場合 |
| 1024 | 指定できない分岐先ノードが指定されています。 | リクエストボディ - 処理パラメータ - branchSelects - forwardNodeIds に分岐先として指定できないノードが指定されている場合 |
| 1027 | 指定できる確認ノードが存在しません。 | 処理対象のノードが確認対象者設定可能ノードとして一つも設定されていない場合 |
| 1028 | 設定可能なノード数以上の確認ノードが指定されています。 | 処理対象のノードが確認対象者設定可能ノードとして設定されている数より、 リクエストボディ - 処理パラメータ - confirmNodeConfigs の要素数が多い場合 |
| 1029 | 確認ノードの入力情報に不備があります。 | 以下のいずれかに合致する場合
リクエストボディ - 処理パラメータ - confirmNodeConfigs の各要素のいずれかに null が指定されている場合
リクエストボディ - 処理パラメータ - confirmNodeConfigs - nodeId が未指定の場合
|
| 1030 | 同一の確認ノード対して指定が重複しています。 | リクエストボディ - 処理パラメータ - confirmNodeConfigs - nodeId に重複がある場合 |
| 1031 | 指定できない確認ノードが指定されています。 | リクエストボディ - 処理パラメータ - confirmNodeConfigs - nodeId に確認対象者設定可能ノードとして設定を行っていない確認ノードが指定されている場合 |
| 1032 | 指定できる動的承認ノードが存在しません。 | 処理対象のノードが処理対象者設定可能ノードとして一つも設定されていない場合 |
| 1033 | 動的承認ノードが未指定です。 | 処理対象のノードが処理対象者設定可能ノードとして設定されているが、 リクエストボディ - 処理パラメータ - dynamicNodeConfigs が未指定の場合 |
| 1034 | 設定が可能な動的承認ノード数と指定された動的承認ノード数が異なります。 | 処理対象のノードが処理対象者設定可能ノードとして設定されている数と、 リクエストボディ - 処理パラメータ - dynamicNodeConfigs の要素数が異なる場合 |
| 1035 | 動的承認ノードの入力情報に不備があります。 | 以下のいずれかに合致する場合
リクエストボディ - 処理パラメータ - dynamicNodeConfigs の各要素のいずれかに null が指定されている場合
リクエストボディ - 処理パラメータ - dynamicNodeConfigs - nodeId が未指定の場合
|
| 1036 | 同一の動的承認ノードに対して指定が重複しています。 | リクエストボディ - 処理パラメータ - dynamicNodeConfigs - nodeId に重複がある場合 |
| 1037 | 削除できない動的承認ノードに対して処理対象者の指定がされていません。 | 設定対象の動的承認ノードが削除禁止であるが、 リクエストボディ - 処理パラメータ - dynamicNodeConfigs - processTargetConfigs が未指定の場合
詳細は 動的承認・横配置・縦配置ノード設定 を参照してください。
|
| 1038 | 指定できない動的承認ノードが指定されています。 | リクエストボディ - 処理パラメータ - dynamicNodeConfigs - nodeId に処理対象者設定可能ノードとして設定を行っていない承認ノードが指定されている場合 |
| 1039 | 指定できる横配置ノードが存在しません。 | 処理対象のノードが処理対象者設定可能ノードとして一つも設定されていない場合 |
| 1040 | 横配置ノードが未指定です。 | 処理対象のノードが処理対象者設定可能ノードとして設定されているが、 リクエストボディ - 処理パラメータ - horizontalNodeConfigs が未指定の場合 |
| 1041 | 設定が可能な横配置ノード数と指定された横配置ノード数が異なります。 | 処理対象のノードが処理対象者設定可能ノードとして設定されている数と、 リクエストボディ - 処理パラメータ - horizontalNodeConfigs の要素数が異なる場合 |
| 1042 | 横配置ノードの入力情報に不備があります。 | 以下のいずれかに合致する場合
リクエストボディ - 処理パラメータ - horizontalNodeConfigs の各要素のいずれかに null が指定されている場合
リクエストボディ - 処理パラメータ - horizontalNodeConfigs - nodeId が未指定の場合
|
| 1043 | 同一の横配置ノード対して指定が重複しています。 | リクエストボディ - 処理パラメータ - horizontalNodeConfigs - nodeId に重複がある場合 |
| 1044 | 指定できない横配置ノードが指定されています。 | リクエストボディ - 処理パラメータ - horizontalNodeConfigs - nodeId に処理対象者設定可能ノードとして設定を行っていない承認ノードが指定されている場合 |
| 1045 | 指定できる縦配置ノードが存在しません。 | 処理対象のノードが処理対象者設定可能ノードとして一つも設定されていない場合 |
| 1046 | 縦配置ノードが未指定です。 | 処理対象のノードが処理対象者設定可能ノードとして設定されているが、 リクエストボディ - 処理パラメータ - verticalNodeConfigs が未指定の場合 |
| 1047 | 設定が可能な縦配置ノード数と指定された縦配置ノード数が異なります。 | 処理対象のノードが処理対象者設定可能ノードとして設定されている数と、 リクエストボディ - 処理パラメータ - verticalNodeConfigs の要素数が異なる場合 |
| 1048 | 縦配置ノードの入力情報に不備があります。 | 以下のいずれかに合致する場合
リクエストボディ - 処理パラメータ - verticalNodeConfigs の各要素のいずれかに null が指定されている場合
リクエストボディ - 処理パラメータ - verticalNodeConfigs - nodeId が未指定の場合
|
| 1049 | 同一の縦配置ノード対して指定が重複しています。 | リクエストボディ - 処理パラメータ - verticalNodeConfigs - nodeId に重複がある場合 |
| 1050 | 指定できない縦配置ノードが指定されています。 | リクエストボディ - 処理パラメータ - verticalNodeConfigs - nodeId に処理対象者設定可能ノードとして設定を行っていない承認ノードが指定されている場合 |
| 1069 | 確認ノードの指定に不備があります。 | ルート定義や以前の処理で既に設定対象ノードに対して確認対象者が設定されており、かつ、以下のいずれかに合致する場合
リクエストボディ - 処理パラメータ - confirmNodeConfigs の各要素のいずれかに null が指定されている場合
リクエストボディ - 処理パラメータ - confirmNodeConfigs - nodeId が未指定の場合
|
| 1070 | 動的承認ノードの指定に不備があります。 | ルート定義や以前の処理で既に設定対象ノードに対して処理対象者が設定されており、かつ、以下のいずれかに合致する場合
リクエストボディ - 処理パラメータ - dynamicNodeConfigs の各要素のいずれかに null が指定されている場合
リクエストボディ - 処理パラメータ - dynamicNodeConfigs - nodeId が未指定の場合
|
| 1071 | 横配置ノードの指定に不備があります。 | ルート定義や以前の処理で既に設定対象ノードに対して処理対象者が設定されており、かつ、以下のいずれかに合致する場合
リクエストボディ - 処理パラメータ - horizontalNodeConfigs の各要素のいずれかに null が指定されている場合
リクエストボディ - 処理パラメータ - horizontalNodeConfigs - nodeId が未指定の場合
|
| 1072 | 縦配置ノードの指定に不備があります。 | ルート定義や以前の処理で既に設定対象ノードに対して処理対象者が設定されており、かつ、以下のいずれかに合致する場合
リクエストボディ - 処理パラメータ - verticalNodeConfigs の各要素のいずれかに null が指定されている場合
リクエストボディ - 処理パラメータ - verticalNodeConfigs - nodeId が未指定の場合
|
| 1073 | 指定可能な展開ノード数ではありません。 | リクエストボディ - 処理パラメータ - horizontalNodeConfigs - matterNodeExpansions の要素数が割当可能ノード数の範囲外である場合 |
| 1074 | 展開ノードの処理設定が未指定です。 | リクエストボディ - 処理パラメータ - horizontalNodeConfigs - matterNodeExpansions の各要素のいずれかに null が指定されている場合 |
| 1075 | 展開ノードのノード名が未指定です | リクエストボディ - 処理パラメータ - horizontalNodeConfigs - matterNodeExpansions - nodeName が未指定の場合 |
| 1053 | 処理対象者情報が未指定です。 | リクエストボディ - 処理パラメータ - [confirmNodeConfigs] / [dynamicNodeConfigs] / [horizontalNodeConfigs - matterNodeExpansions] / [verticalNodeConfigs - matterNodeExpansions] - processTargetConfigs が未指定の場合 |
| 1054 | 処理対象者情報に不備があります。 | 以下のいずれかに合致する場合
リクエストボディ - 処理パラメータ - [confirmNodeConfigs] / [dynamicNodeConfigs] / [horizontalNodeConfigs - matterNodeExpansions] / [verticalNodeConfigs - matterNodeExpansions] - processTargetConfigs - extensionPointId が未指定の場合
リクエストボディ - 処理パラメータ - [confirmNodeConfigs] / [dynamicNodeConfigs] / [horizontalNodeConfigs - matterNodeExpansions] / [verticalNodeConfigs - matterNodeExpansions] - processTargetConfigs - pluginId が未指定の場合
リクエストボディ - 処理パラメータ - [confirmNodeConfigs] / [dynamicNodeConfigs] / [horizontalNodeConfigs - matterNodeExpansions] / [verticalNodeConfigs - matterNodeExpansions] - processTargetConfigs - parameter が未指定の場合
|
| 1083 | 設定により無効化されている処理対象者情報が指定されています。 | 設定対象のノードのプラグイン設定で無効化されているプラグインが指定されている場合
詳細は 「動的承認・横配置・縦配置ノード設定」 または 「確認ノード設定」 を参照してください。
|
| 7002 | 根回し機能は設定により利用できません。管理者に連絡してください。 | 以下に合致する場合
リクエストボディ - 処理パラメータ - nego に値が指定されている
|
| 7003 | 根回しのチェック処理でエラーが発生しました。管理者に連絡してください。 |
| 1066 | 添付ファイルの追加は禁止されています。 | 以下に合致する場合
リクエストボディ - 処理パラメータ - temporaryDirectoryKey の値が指定されている
処理対象のノードでファイルの添付が禁止されている
|
| 1067 | 添付ファイルの格納領域が見つかりませんでした。 | リクエストボディ - 処理パラメータ - temporaryDirectoryKey の値をキーとした格納領域が見つからなかった場合
|
| 1068 | 添付ファイルの格納領域の取得に失敗しました。管理者に連絡してください。 |
| 1057 | 印影情報に不備があります。 | リクエストボディ - optionalParameter - userParameter - imwStampId の値が文字列ではない場合や null 、 ブランク 等の値が指定されている場合 |
| 7004 | 印影機能は設定により利用できません。管理者に連絡してください。 | 以下に合致する場合
リクエストボディ - optionalParameter - userParameter - imwStampId に値が指定されている
|
| 1058 | このフローまたは案件は印影を利用できません。 | 以下に合致する場合
フロー定義または、案件で印影が設定されていない
リクエストボディ - optionalParameter - userParameter に値が指定されている
|
| 1059 | 権限者の印影設定情報が存在しません。 | ログインユーザの印影情報が存在しない場合 |
| 1060 | 権限者の印影として利用できない印影が指定されています。 | リクエストボディ - optionalParameter - userParameter - imwStampId の値がログインユーザの印影情報として存在しない場合 |
| 1061 | 印影チェック処理でエラーが発生しました。管理者に連絡してください。 |
| 3011 | ユーザデータIDの重複チェックに失敗しました。管理者に連絡してください。 | |
| 3013 | ユーザデータIDは案件で使用済みです。 | リクエストボディ - 処理パラメータ - userDataId の値が、既に申請されている案件で利用されている場合 |
| 9000 | 処理に失敗しました。 | 案件処理プラグイン紐付け未定義のシステムエラー |
| 9001 | （アクション処理エラーメッセージ） | アクション処理で設定したエラーメッセージ
または、IM-FormaDesigner ／ IM-BIS の内部処理でシステムエラーが発生した場合
|
| 9010 | （入力チェックエラーメッセージ） | IM-FormaDesigner の入力チェックエラーメッセージ
IM-FormaDesigner ／ IM-BIS で作成したワークフローの場合のみ
|
| 9011 | 入力チェックでシステムエラーが発生しました。 | IM-FormaDesigner の入力チェックでシステムエラー
IM-FormaDesigner ／ IM-BIS で作成したワークフローの場合のみ
|