1.2.5. confirm¶
imWorkflow.process.confirm(Object parameter) : Promise<Object>
ワークフローの案件を確認します。
1.2.5.1. サンプルコード¶
imWorkflow.process.confirm({
processParameter: {
systemMatterId: "",
nodeId: "",
authUserDepartmentInfo: {},
confirmComment: "",
}
})
.then(function() {
// success
})
.catch(function(error) {
// error
});
1.2.5.2. パラメータ¶
parameter : Object
parameter.processParameter : Object(下記参照)確認用パラメータ情報オブジェクト
1.2.5.2.1. processParameter¶
項目名 | 必須/任意 | 型(最大バイト数) | 説明 |
---|---|---|---|
systemMatterId | 任意 | 文字列 | システム案件ID
「案件一覧」画面から遷移した場合は、一覧で選択したタスクのシステム案件IDが設定されるため不要
「案件一覧」画面以外から遷移した場合は、必須
|
nodeId | 任意 | 文字列 | ノードID
「案件一覧」画面から遷移した場合は、一覧で選択したタスクのノードIDが設定されるため不要
「案件一覧」画面以外から遷移した場合は、必須
|
authUserDepartmentInfo | 任意 | 下記参照 | 権限者所属組織情報
未指定の場合、以下の優先順位で該当する組織情報で確認
1.カレント組織(代理設定の場合は除く)
2.主所属
3.「会社コード」「組織セットコード」「組織コード」の昇順で1つ目の組織情報
4.所属なし
|
confirmComment | 任意 | 文字列(2000) | 確認コメント |
1.2.5.2.1.1. authUserDepartmentInfo¶
所属なしユーザを指定する場合は、当オブジェクト配下のプロパティに空文字を指定してください。
{
departmentInfo: {
companyCd: "string",
departmentSetCd: "string",
departmentCd: "string"
}
}
項目名 | 必須/任意 | 型 | 説明 |
---|---|---|---|
companyCd | 必須 | 文字列 | 会社コードを指定します。
|
departmentSetCd | 必須 | 文字列 | 組織セットコードを指定します。
|
departmentCd | 必須 | 文字列 | 組織コードを指定します。
|
1.2.5.3. 返却値¶
Promise<Object>返却オブジェクト(下記参照) 当APIはPromiseを返します。処理が成功した場合の返却値はありません。処理が失敗した場合はpromise.catch()で返却値を受け取ってください。
項目名 | 型 | 説明 |
---|---|---|
workflowResult.data.errorCode | 文字列 | エラーコード
処理が失敗した場合に設定されます。
|
workflowResult.data.localizedErrorMessage | 文字列 | エラーメッセージ
処理が失敗した場合に設定されます。
|
1.2.5.3.1. エラーコード¶
エラーコード | エラーメッセージ | 備考 |
---|---|---|
1004 | 未完了案件の確認情報が未指定です。 | |
0001 | 確認可能な組織権限がありません。 | |
0002 | 組織権限情報の取得に失敗しました。管理者に連絡してください。 | |
1003 | 完了案件確認情報が未指定です。 | |
0007 | 確認可能な組織権限がありません。 | |
0008 | 組織権限情報の取得に失敗しました。管理者に連絡してください。 | |
0009 | 指定した案件、処理ノードに対する確認権限がありません。 | |
0010 | 確認権限のチェックに失敗しました。管理者に連絡してください。 | |
1016 | システム案件IDが未指定です。 | |
1017 | ノードIDが未指定です。 | |
1025 | コメントが許可された最大文字数を超えています。 | |
1026 | コメントのチェック処理でエラーが発生しました。管理者に連絡してください。 | |
0013 | 指定した案件、処理ノード、権限者に対する処理権限がありません。 | |
6051 | 案件が見つかりませんでした。 | |
6052 | 案件情報が取得できません。 | |
6053 | 権限がありません。 |