1.2.4. approveEnd¶
imWorkflow.process.approveEnd(Object parameter) : Promise<Object>
ワークフローの案件を承認終了します。
1.2.4.1. サンプルコード¶
imWorkflow.process.approveEnd({
processParameter: {
systemMatterId: "",
nodeId: "",
authUserCd: "",
authUserDepartmentInfo: {},
processComment: "",
temporaryDirectoryKey: "",
fileIdsForDelete: [],
nego: {}
},
optionalParameter: {}
})
.then(function() {
// success
})
.catch(function(error) {
// error
});
1.2.4.2. パラメータ¶
parameter : Object
parameter.processParameter : Object(下記参照)承認終了用パラメータ情報オブジェクト parameter.optionalParameter : Object(下記参照)ユーザパラメータ、および、Forma用ユーザパラメータを内包するオブジェクト
1.2.4.2.1. processParameter¶
項目名 | 必須/任意 | 型(最大バイト数) | 説明 |
---|---|---|---|
systemMatterId | 任意 | 文字列 | システム案件ID
「案件一覧」画面から遷移した場合は、一覧で選択したタスクのシステム案件IDが設定されるため不要
「案件一覧」画面以外から遷移した場合は、必須
|
nodeId | 任意 | 文字列 | ノードID
「案件一覧」画面から遷移した場合は、一覧で選択したタスクのノードIDが設定されるため不要
「案件一覧」画面以外から遷移した場合は、必須
|
authUserCd | 任意 | 文字列 | 権限者コード
未指定の場合、実行ユーザで処理
|
authUserDepartmentInfo | 任意 | 下記参照 | 権限者所属組織情報
未指定の場合、以下の優先順位で該当する組織情報で処理
1.カレント組織(代理設定の場合は除く)
2.主所属
3.「会社コード」「組織セットコード」「組織コード」の昇順で1つ目の組織情報
4.所属なし
|
processComment | 任意 | 文字列(2000) | 処理コメント |
temporaryDirectoryKey | 任意 | 文字列 | 添付ファイル一時領域ディレクトリキー |
fileIdsForDelete | 任意 | 配列(文字列) | 削除対象ファイル(ファイルID)
ファイルIDを指定
|
nego | 任意 | 下記参照 | 根回し情報 |
1.2.4.2.1.1. authUserDepartmentInfo¶
所属なしユーザを指定する場合は、当オブジェクト配下のプロパティに空文字を指定してください。
{
departmentInfo: {
companyCd: "string",
departmentSetCd: "string",
departmentCd: "string"
}
}
項目名 | 必須/任意 | 型 | 説明 |
---|---|---|---|
companyCd | 必須 | 文字列 | 会社コードを指定します。
|
departmentSetCd | 必須 | 文字列 | 組織セットコードを指定します。
|
departmentCd | 必須 | 文字列 | 組織コードを指定します。
|
1.2.4.2.1.2. nego¶
{
nego: {
userCdsTo: [
"string"
],
userCdsCc: [
"string"
],
userCdsBcc: [
"string"
],
subject: "string",
text: "string"
}
}
項目名 | 必須/任意 | 型 | 説明 |
---|---|---|---|
userCdsTo | 任意 | 配列(文字列) | 宛先に指定するユーザのユーザコードを指定します。(複数指定可)
|
userCdsCc | 任意 | 配列(文字列) | Ccに指定するユーザのユーザコードを指定します。(複数指定可)
|
userCdsBcc | 任意 | 配列(文字列) | Bccに指定するユーザのユーザコードを指定します。(複数指定可)
|
subject | 任意 | 文字列 | 送信するメールの件名を指定します。
|
text | 任意 | 文字列 | メール定義で設定した内容の「根回し時のコメント」として追記したい内容を指定します。
メール定義については、「 IM-Workflow 管理者操作ガイド 」を参照してください。
|
1.2.4.2.2. optionalParameter¶
userParameterには、アクション処理に受け渡したいパラメータを指定してください。
formaParamは IM-FormaDesigner / IM-BIS で作成したワークフローの場合のみ有効です。
印影を指定する場合、imwStampIdを指定してください。
印影を利用していて、imwStampIdを指定しない場合、常用印が利用されます。
{
optionalParameter: {
userParameter: {
imwStampId: "string",
xxxx: "string"
},
formaParam: {
items: {
textbox1: "string"
}
}
}
}
1.2.4.3. 返却値¶
Promise<Object>返却オブジェクト(下記参照) 当APIはPromiseを返します。処理が成功した場合の返却値はありません。処理が失敗した場合はpromise.catch()で返却値を受け取ってください。
項目名 | 型 | 説明 |
---|---|---|
workflowResult.data.errorCode | 文字列 | エラーコード
処理が失敗した場合に設定されます。
|
workflowResult.data.localizedErrorMessage | 文字列 | エラーメッセージ
処理が失敗した場合に設定されます。
|
1.2.4.3.1. エラーコード¶
エラーコード | エラーメッセージ | 備考 |
---|---|---|
1007 | 案件終了情報が未指定です。 | |
0011 | 権限者組織情報が不正です。 | |
0012 | 指定された所属組織情報は処理権限がありません。 | |
0013 | 指定した案件、処理ノード、権限者に対する処理権限がありません。 | |
0014 | 処理権限のチェックに失敗しました。管理者に連絡してください。 | |
0015 | 処理可能な組織権限がありません。 | |
0016 | 組織権限情報の取得に失敗しました。管理者に連絡してください。 | |
1025 | コメントが許可された最大文字数を超えています。 | |
1026 | コメントのチェック処理でエラーが発生しました。管理者に連絡してください。 | |
1056 | 処理種別定義チェック処理に失敗しました。管理者に連絡してください。 | |
1057 | 印影情報に不備があります。 | |
1058 | このフローまたは案件は印影を利用できません。 | |
1059 | 権限者の印影設定情報が存在しません。 | |
1060 | 権限者の印影として利用できない印影が指定されています。 | |
1061 | 印影チェック処理でエラーが発生しました。管理者に連絡してください。 | |
1066 | 添付ファイルの追加は禁止されています。 | |
1067 | 添付ファイルの格納領域が見つかりませんでした。 | |
1068 | 添付ファイルの格納領域の取得に失敗しました。管理者に連絡してください。 | |
1076 | 削除対象ファイル情報に不備があります。 | |
1077 | このノードではファイルを削除できません。 | |
1078 | システム案件IDが未指定です。 | |
1079 | ノードIDが未指定です。 | |
2000 | 権限者組織情報の補完に必要な情報の取得に失敗しました。管理者に連絡してください。 | |
2002 | 案件が存在しないため、案件名を補完できませんでした。 | |
2003 | 案件の取得に失敗しました。管理者に連絡してください。 | |
3005 | 根回しアドレス情報を生成するためのユーザ情報の取得に失敗しました。 | |
3006 | 処理設定情報を取得できませんでした。管理者に連絡してください。 | |
3007 | 処理設定情報の取得に失敗しました。管理者に連絡してください。 | |
7002 | 根回し機能は設定により利用できません。管理者に連絡してください。 | |
7003 | 根回しのチェック処理でエラーが発生しました。管理者に連絡してください。 | |
7004 | 印影機能は設定により利用できません。管理者に連絡してください。 | |
9000 | 処理に失敗しました。 | 案件処理プラグイン紐付け未定義のシステムエラー |
9001 | (アクション処理エラーメッセージ) | アクション処理で設定したエラーメッセージ
または、IM-FormaDesigner / IM-BIS の内部処理でシステムエラーが発生した場合
|
9002 | 処理に失敗しました。案件に対して他の操作が実行されているため処理できません。 | ワークフロー排他制御エラー |
9010 | (入力チェックエラーメッセージ) | IM-FormaDesigner の入力チェックエラーメッセージ
IM-FormaDesigner / IM-BIS で作成したワークフローの場合のみ
|
9011 | 入力チェックでシステムエラーが発生しました。 | IM-FormaDesigner の入力チェックでシステムエラー
IM-FormaDesigner / IM-BIS で作成したワークフローの場合のみ
|