1.2.1. apply¶
imWorkflow.process.apply(Object parameter) : Promise<Object>
ワークフローを申請します。
Contents
1.2.1.1. サンプルコード¶
imWorkflow.process.apply({
processParameter: {
flowId: "",
userDataId: "",
matterName: "",
applyBaseDate: "",
applyAuthUserCd: "",
authUserDepartmentInfo: {},
processComment: "",
priorityLevel: "",
temporaryDirectoryKey: "",
branchSelects: [],
dynamicNodeConfigs: [],
confirmNodeConfigs: [],
horizontalNodeConfigs: [],
verticalNodeConfigs: [],
nego: {}
},
optionalParameter: {}
})
.then(function(result) {
// success
})
.catch(function(error) {
// error
});
1.2.1.2. パラメータ¶
parameter : Object
parameter.processParameter : Object(下記参照)申請用パラメータ情報オブジェクト parameter.optionalParameter : Object(下記参照)ユーザパラメータ、および、Forma用ユーザパラメータを内包するオブジェクト
1.2.1.2.1. processParameter¶
項目名 | 必須/任意 | 型(最大バイト数) | 説明 |
---|---|---|---|
flowId | 任意 | 文字列 | フローID
「申請一覧」「案件一覧(一時保存)」画面から遷移した場合は、一覧で選択したフローIDが設定されるため不要
「申請一覧」「案件一覧(一時保存)」画面以外から遷移した場合は、必須
|
userDataId | 任意 | 文字列(20) | |
matterName | 任意 | 文字列(200) | 案件名
未指定の場合、以下の優先度で決定して申請
1.一時保存時に指定した案件名(一時保存からの申請の場合)
2.フロー名
|
applyBaseDate | 任意 | 文字列 | 申請基準日
未指定の場合、「申請一覧」「案件一覧(一時保存)」画面から遷移した場合は、一覧で選択した申請基準日が設定される
「申請一覧」「案件一覧(一時保存)」画面以外から遷移した場合は、アカウントコンテキストのタイムゾーンにおける現在日付で申請
“yyyy/MM/dd”形式の文字列で指定
|
applyAuthUserCd | 任意 | 文字列 | 申請権限者コード
未指定の場合、以下の優先度で決定して申請
1.「申請一覧」「案件一覧(一時保存)」画面から遷移した場合は、一覧で選択した申請者
2.実行ユーザ
|
authUserDepartmentInfo | 任意 | 下記参照 | 権限者所属組織情報
未指定の場合、以下の優先順位で該当する組織情報で申請
1.カレント組織(代理設定の場合は除く)
2.主所属
3.「会社コード」「組織セットコード」「組織コード」の昇順で1つ目の組織情報
4.所属なし
|
processComment | 任意 | 文字列(2000) | 処理コメント |
priorityLevel | 任意 | 文字列 | |
temporaryDirectoryKey | 任意 | 文字列 | 添付ファイル一時領域ディレクトリキー |
branchSelects | 任意 | 下記参照 | 分岐先選択情報
分岐先設定可能ノードの場合指定必須
|
dynamicNodeConfigs | 任意 | 下記参照 | 動的承認ノード設定情報
処理対象者設定可能ノードに設定されている場合に指定
未指定の場合、以下の優先度で決定して申請
1.ルート定義で設定した処理対象者で申請
2.ルート定義で「指定なし」の場合、削除可ノードであればノードを削除、削除不可の場合はエラー
|
confirmNodeConfigs | 任意 | 下記参照 | 確認ノード設定情報
確認対象者設定可能ノードに設定されている場合に指定
未指定の場合、以下の優先度で決定して申請
1.ルート定義で設定した処理対象者で申請
|
horizontalNodeConfigs | 任意 | 下記参照 | 横配置ノード設定情報
処理対象者設定可能ノードに設定されている場合に指定
未指定の場合、以下の優先度で決定して申請
1.ルート定義で設定した処理対象者で申請
2.ルート定義で「指定なし」の場合、割当可能ノード数の最小0であればノードを削除、0以外の場合はエラー
|
verticalNodeConfigs | 任意 | 下記参照 | 縦配置ノード設定情報
処理対象者設定可能ノードに設定されている場合に指定
未指定の場合、以下の優先度で決定して申請
1.ルート定義で設定した処理対象者で申請
2.ルート定義で「指定なし」の場合、割当可能ノード数の最小0であればノードを削除、0以外の場合はエラー
|
nego | 任意 | 下記参照 | 根回し情報 |
1.2.1.2.1.1. authUserDepartmentInfo¶
所属なしユーザを指定する場合は、当オブジェクト配下のプロパティに空文字を指定してください。
{
departmentInfo: {
companyCd: "string",
departmentSetCd: "string",
departmentCd: "string"
}
}
項目名 | 必須/任意 | 型 | 説明 |
---|---|---|---|
companyCd | 必須 | 文字列 | 会社コードを指定します。
|
departmentSetCd | 必須 | 文字列 | 組織セットコードを指定します。
|
departmentCd | 必須 | 文字列 | 組織コードを指定します。
|
1.2.1.2.1.2. branchSelects¶
{
branchSelects: [
{
branchStartNodeId: "string",
forwardNodeIds: [
"string"
]
}
]
}
項目名 | 必須/任意 | 型 | 説明 |
---|---|---|---|
branchStartNodeId | 必須 | 文字列 | 初期値を指定するルート選択の分岐開始ノードのノードIDを指定します。
|
forwardNodeIds | 必須 | 配列(文字列) | 初期値として選択するノードのノードIDを配列で指定します。
単一選択の場合は1つ、複数選択の場合は選択するすべてのノードのノードIDを設定してください。
|
1.2.1.2.1.3. dynamicNodeConfigs¶
ノードを削除する場合、processTargetConfigsに何も設定しないでください。 利用可能なプラグインIDについては「 処理権限者プラグイン一覧 」を参照してください。
{
dynamicNodeConfigs: [
{
nodeId: "string",
processTargetConfigs: [
{
pluginId: "string",
parameter: "string"
}
]
}
]
}
項目名 | 必須/任意 | 型 | 説明 |
---|---|---|---|
nodeId | 必須 | 文字列 | 設定対象のノードIDを指定します。
|
processTargetConfigs | 任意 | オブジェクト | 処理対象プラグイン情報を指定します。
詳細は「 動的処理対象者設定機能 」を参照してください。
|
1.2.1.2.1.4. confirmNodeConfigs¶
確認対象者なしとする場合、processTargetConfigsに何も設定しないでください。 利用可能なプラグインIDについては「 処理権限者プラグイン一覧 」を参照してください。
{
confirmNodeConfigs: [
{
nodeId: "string",
processTargetConfigs: [
{
pluginId: "string",
parameter: "string"
}
]
}
]
}
項目名 | 必須/任意 | 型 | 説明 |
---|---|---|---|
nodeId | 必須 | 文字列 | 設定対象のノードIDを指定します。
|
processTargetConfigs | 任意 | オブジェクト | 処理対象プラグイン情報を指定します。
詳細は「 動的処理対象者設定機能 」を参照してください。
|
1.2.1.2.1.5. horizontalNodeConfigs¶
ノードを削除する場合、matterNodeExpansionsに何も設定しないでください。 利用可能なプラグインIDについては「 処理権限者プラグイン一覧 」を参照してください。
{
horizontalNodeConfigs: [
{
nodeId: "string",
matterNodeExpansions: [
{
nodeName: "string",
processTargetConfigs: [
{
pluginId: "string",
parameter: "string"
}
]
}
]
}
]
}
項目名 | 必須/任意 | 型(最大バイト数) | 説明 |
---|---|---|---|
nodeId | 必須 | 文字列 | 設定対象のノードIDを指定します。
|
matterNodeExpansions | 任意 | オブジェクト | ノード展開情報を指定します。展開するノード数分オブジェクトを定義します。
詳細は「 動的処理対象者設定機能 」を参照してください。
|
1.2.1.2.1.6. verticalNodeConfigs¶
ノードを削除する場合、matterNodeExpansionsに何も設定しないでください。 利用可能なプラグインIDについては「 処理権限者プラグイン一覧 」を参照してください。
{
verticalNodeConfigs: [
{
nodeId: "string",
matterNodeExpansions: [
{
nodeName: "string",
processTargetConfigs: [
{
pluginId: "string",
parameter: "string"
}
]
}
]
}
]
}
項目名 | 必須/任意 | 型(最大バイト数) | 説明 |
---|---|---|---|
nodeId | 必須 | 文字列 | 設定対象のノードIDを指定します。
|
matterNodeExpansions | 任意 | オブジェクト | ノード展開情報を指定します。展開するノード数分オブジェクトを定義します。
詳細は「 動的処理対象者設定機能 」を参照してください。
|
コラム
1.2.1.2.1.7. nego¶
{
nego: {
userCdsTo: [
"string"
],
userCdsCc: [
"string"
],
userCdsBcc: [
"string"
],
subject: "string",
text: "string"
}
}
項目名 | 必須/任意 | 型 | 説明 |
---|---|---|---|
userCdsTo | 任意 | 配列(文字列) | 宛先に指定するユーザのユーザコードを指定します。(複数指定可)
|
userCdsCc | 任意 | 配列(文字列) | Ccに指定するユーザのユーザコードを指定します。(複数指定可)
|
userCdsBcc | 任意 | 配列(文字列) | Bccに指定するユーザのユーザコードを指定します。(複数指定可)
|
subject | 任意 | 文字列 | 送信するメールの件名を指定します。
|
text | 任意 | 文字列 | メール定義で設定した内容の「根回し時のコメント」として追記したい内容を指定します。
メール定義については、「 IM-Workflow 管理者操作ガイド 」を参照してください。
|
1.2.1.2.2. optionalParameter¶
{
optionalParameter: {
userParameter: {
imwStampId: "string",
xxxx: "string"
},
formaParam: {
items: {
textbox1: "string"
}
}
}
}
1.2.1.3. 返却値¶
Promise<Object>返却オブジェクト(下記参照) 当APIはPromiseを返します。処理が成功した場合はpromise.then()で返却値を受け取ってください。処理が失敗した場合はpromise.catch()で返却値を受け取ってください。
項目名 | 型 | 説明 |
---|---|---|
matterNumber | 文字列 | 案件番号
処理が成功した場合に設定されます。
|
systemMatterId | 文字列 | システム案件ID
処理が成功した場合に設定されます。
|
userDataId | 文字列 | ユーザデータID
処理が成功した場合に設定されます。
|
workflowResult.data.errorCode | 文字列 | エラーコード
処理が失敗した場合に設定されます。
|
workflowResult.data.localizedErrorMessage | 文字列 | エラーメッセージ
処理が失敗した場合に設定されます。
|
1.2.1.3.1. エラーコード¶
エラーコード | エラーメッセージ | 備考 |
---|---|---|
0003 | 指定したフロー、申請基準日、権限者に対する申請権限がありません。 | |
0004 | 申請権限のチェックに失敗しました。管理者に連絡してください。 | |
0005 | 申請可能な組織権限がありません。 | |
0006 | 組織権限情報の取得に失敗しました。管理者に連絡してください。 | |
0011 | 権限者組織情報が不正です。 | |
0012 | 指定された所属組織情報は処理権限がありません。 | |
1005 | 申請情報が未指定です。 | |
1015 | フローIDが未指定です。 | |
1018 | 指定できる分岐開始ノードが存在しません。 | |
1019 | 分岐先ノードが未指定です。 | |
1020 | 設定が必須な分岐先ノード数と指定された分岐先ノード数が異なります。 | |
1021 | 分岐先ノードの入力情報に不備があります。 | |
1022 | 同一の分岐先ノード対して指定が重複しています。 | |
1023 | 選択可能なルートは単一であるのに対し分岐先ノードが複数指定されています。 | |
1024 | 指定できない分岐先ノードが指定されています。 | |
1025 | コメントが許可された最大文字数を超えています。 | |
1026 | コメントのチェック処理でエラーが発生しました。管理者に連絡してください。 | |
1027 | 指定できる確認ノードが存在しません。 | |
1028 | 設定可能なノード数以上の確認ノードが指定されています。 | |
1029 | 確認ノードの入力情報に不備があります。 | |
1030 | 同一の確認ノード対して指定が重複しています。 | |
1031 | 指定できない確認ノードが指定されています。 | |
1032 | 指定できる動的承認ノードが存在しません。 | |
1033 | 動的承認ノードが未指定です。 | |
1034 | 設定が可能な動的承認ノード数と指定された動的承認ノード数が異なります。 | |
1035 | 動的承認ノードの入力情報に不備があります。 | |
1036 | 同一の動的承認ノードに対して指定が重複しています。 | |
1037 | 削除できない動的承認ノードに対して処理対象者の指定がされていません。 | |
1038 | 指定できない動的承認ノードが指定されています。 | |
1039 | 指定できる横配置ノードが存在しません。 | |
1040 | 横配置ノードが未指定です。 | |
1041 | 設定が可能な横配置ノード数と指定された横配置ノード数が異なります。 | |
1042 | 横配置ノードの入力情報に不備があります。 | |
1043 | 同一の横配置ノード対して指定が重複しています。 | |
1044 | 指定できない横配置ノードが指定されています。 | |
1045 | 指定できる縦配置ノードが存在しません。 | |
1046 | 縦配置ノードが未指定です。 | |
1047 | 設定が可能な縦配置ノード数と指定された縦配置ノード数が異なります。 | |
1048 | 縦配置ノードの入力情報に不備があります。 | |
1049 | 同一の縦配置ノード対して指定が重複しています。 | |
1050 | 指定できない縦配置ノードが指定されています。 | |
1051 | 案件名が許可された最大文字数を超えています。 | |
1052 | 案件名のチェック処理でエラーが発生しました。管理者に連絡してください。 | |
1053 | 処理対象者情報が未指定です。 | |
1054 | 処理対象者情報に不備があります。 | |
1055 | 存在しない優先度が指定されています。 | |
1056 | 処理種別定義チェック処理に失敗しました。管理者に連絡してください。 | |
1057 | 印影情報に不備があります。 | |
1058 | このフローまたは案件は印影を利用できません。 | |
1059 | 権限者の印影設定情報が存在しません。 | |
1060 | 権限者の印影として利用できない印影が指定されています。 | |
1061 | 印影チェック処理でエラーが発生しました。管理者に連絡してください。 | |
1062 | 不正な申請基準日が指定されています。 | |
1063 | 申請基準日チェックに必要な情報が取得できませんでした。 | |
1064 | 申請基準日チェック処理でエラーが発生しました。 | |
1065 | 申請できない申請基準日です。 | |
1066 | 添付ファイルの追加は禁止されています。 | |
1067 | 添付ファイルの格納領域が見つかりませんでした。 | |
1068 | 添付ファイルの格納領域の取得に失敗しました。管理者に連絡してください。 | |
1069 | 確認ノードの指定に不備があります。 | |
1070 | 動的承認ノードの指定に不備があります。 | |
1071 | 横配置ノードの指定に不備があります。 | |
1072 | 縦配置ノードの指定に不備があります。 | |
1073 | 指定可能な展開ノード数ではありません。 | |
1074 | 展開ノードの処理設定が未指定です。 | |
1075 | 展開ノードのノード名が未指定です。 | |
1082 | 申請基準日のフォーマットが不正です。 | |
1083 | 設定により無効化されている処理対象者情報が指定されています。 | |
1084 | 設定により無効化されているため、指定された処理を行うことはできません。 | |
2000 | 権限者組織情報の補完に必要な情報の取得に失敗しました。管理者に連絡してください。 | |
2001 | 案件名の補完に必要な情報の取得に失敗しました。管理者に連絡してください。 | |
3000 | 申請設定情報が存在しません。管理者に連絡してください。 | |
3001 | 申請基準日時点で無効なフローです。 | |
3002 | ルート情報が不正です。管理者に連絡してください。 | |
3003 | ルート情報が不正です。管理者に連絡してください。 | |
3004 | フロー情報の取得に失敗しました。管理者に連絡してください。 | |
3005 | 根回しアドレス情報を生成するためのユーザ情報の取得に失敗しました。 | |
3011 | ユーザデータIDの重複チェックに失敗しました。管理者に連絡してください。 | |
3012 | ユーザデータIDは一時保存案件で使用済みです。 | |
3013 | ユーザデータIDは案件で使用済みです。 | |
7002 | 根回し機能は設定により利用できません。管理者に連絡してください。 | |
7003 | 根回しのチェック処理でエラーが発生しました。管理者に連絡してください。 | |
7004 | 印影機能は設定により利用できません。管理者に連絡してください。 | |
9000 | 処理に失敗しました。 | 案件処理プラグイン紐付け未定義のシステムエラー |
9001 | (アクション処理エラーメッセージ) | アクション処理で設定したエラーメッセージ
または、IM-FormaDesigner / IM-BIS の内部処理でシステムエラーが発生した場合
|
9002 | 処理に失敗しました。案件に対して他の操作が実行されているため処理できません。 | ワークフロー排他制御エラー |
9010 | (入力チェックエラーメッセージ) | IM-FormaDesigner の入力チェックエラーメッセージ
IM-FormaDesigner / IM-BIS で作成したワークフローの場合のみ
|
9011 | 入力チェックでシステムエラーが発生しました。 | IM-FormaDesigner の入力チェックでシステムエラー
IM-FormaDesigner / IM-BIS で作成したワークフローの場合のみ
|