1.2.11. saveTemporary¶
imWorkflow.process.saveTemporary(Object parameter) : Promise<Object>
ワークフローを一時保存します。
Contents
1.2.11.1. サンプルコード¶
imWorkflow.process.saveTemporary({
processParameter: {
userDataId: "",
flowId: "",
matterName: "",
applyBaseDate: "",
applyAuthUserCd: "",
processComment: ""
},
optionalParameter: {}
})
.then(function(result) {
// success
})
.catch(function(error) {
// error
});
1.2.11.2. パラメータ¶
parameter : Object
parameter.processParameter : Object(下記参照)一時保存用パラメータ情報オブジェクト parameter.optionalParameter : Object(下記参照)ユーザパラメータ、および、Forma用ユーザパラメータを内包するオブジェクト
1.2.11.2.1. processParameter¶
項目名 | 必須/任意 | 型(最大バイト数) | 説明 |
---|---|---|---|
userDataId | 任意 | 文字列(20) | ユーザデータID
「案件一覧」画面から遷移した場合は、一覧で選択した一時保存情報のユーザデータIDが設定されるため不要
未指定の場合、Identifier.get()で一時保存情報を新規作成
指定した場合、当該キーで特定される一時保存情報が存在しない場合、一時保存情報を新規作成
当該キーで特定される一時保存情報が存在する場合、一時保存情報を更新
|
flowId | 任意 | 文字列 | フローID
一時保存情報を新規作成時は必須
一時保存情報を更新時は不要
|
matterName | 任意 | 文字列(200) | 案件名
未指定の場合、以下の優先度で決定して一時保存
1.一時保存時に指定した案件名(一時保存情報更新の場合)
2.フロー名
|
applyBaseDate | 任意 | 文字列 | 申請基準日
未指定の場合、「申請一覧」「案件一覧(一時保存)」画面から遷移した場合は、一覧で選択した申請基準日が設定される
「申請一覧」「案件一覧(一時保存)」画面以外から遷移した場合は、アカウントコンテキストのタイムゾーンにおける現在日付で一時保存
“yyyy/MM/dd”形式の文字列で指定
|
applyAuthUserCd | 任意 | 文字列 | 申請権限者コード
未指定の場合、実行ユーザで一時保存
|
processComment | 任意 | 文字列(2000) | 処理コメント |
1.2.11.2.2. optionalParameter¶
userParameterには、アクション処理に受け渡したいパラメータを指定してください。
formaParamは IM-FormaDesigner / IM-BIS で作成したワークフローの場合のみ有効です。
印影を指定する場合、imwStampIdを指定してください。
印影を利用していて、imwStampIdを指定しない場合、常用印が利用されます。
{
optionalParameter: {
userParameter: {
imwStampId: "string",
xxxx: "string"
},
formaParam: {
items: {
textbox1: "string"
}
}
}
}
1.2.11.3. 返却値¶
Promise<Object>返却オブジェクト(下記参照) 当APIはPromiseを返します。処理が成功した場合はpromise.then()で返却値を受け取ってください。処理が失敗した場合はpromise.catch()で返却値を受け取ってください。
項目名 | 型 | 説明 |
---|---|---|
userDataId | 文字列 | ユーザデータID
処理が成功した場合に設定されます。
|
workflowResult.data.errorCode | 文字列 | エラーコード
処理が失敗した場合に設定されます。
|
workflowResult.data.localizedErrorMessage | 文字列 | エラーメッセージ
処理が失敗した場合に設定されます。
|
1.2.11.3.1. エラーコード¶
エラーコード | エラーメッセージ | 備考 |
---|---|---|
1001 | 一時保存情報が未指定です。 | |
1002 | 一時保存情報が未指定です。 | |
6000 | 一時保存情報の取得に失敗しました。 | |
6001 | 一時保存情報が存在しません。 | |
6002 | 一時保存情報に関連する案件プロパティの取得に失敗しました。 | |
7000 | 一時保存機能は設定により利用できません。管理者に連絡してください。 | |
7001 | 一時保存機能の利用可否設定情報の取得に失敗しました。管理者に連絡してください。 | |
0017 | 指定したフロー、申請基準日、権限者に対する一時保存情報登録処理権限がありません。 | |
0018 | 申請権限のチェックに失敗しました。管理者に連絡してください。 | |
0019 | 指定した一時保存情報、権限者に対する一時保存情報更新権限がありません。 | |
0020 | 申請権限のチェックに失敗しました。管理者に連絡してください。 | |
1025 | コメントが許可された最大文字数を超えています。 | |
1026 | コメントのチェック処理でエラーが発生しました。管理者に連絡してください。 | |
1051 | 案件名が許可された最大文字数を超えています。 | |
1052 | 案件名のチェック処理でエラーが発生しました。管理者に連絡してください。 | |
1080 | フローIDが未指定です。 | |
1081 | ユーザデータIDが未指定です。 | |
2004 | 案件名の補完用情報フロー名取得に失敗しました。 | |
3008 | ユーザデータIDの採番に失敗しました。 | |
3009 | 更新対象の一時保存情報が見つかりませんでした。 | |
3010 | 更新対象の一時保存情報取得に失敗しました。管理者に連絡してください。 | |
3011 | ユーザデータIDの重複チェックに失敗しました。管理者に連絡してください。 | |
3012 | ユーザデータIDは一時保存案件で使用済みです。 | |
3013 | ユーザデータIDは案件で使用済みです。 | |
6000 | 一時保存情報の取得に失敗しました。 | |
6001 | 一時保存情報が存在しません。 | |
6002 | 一時保存情報に関連する案件プロパティの取得に失敗しました。 | |
9001 | (内部処理エラーメッセージ) | IM-FormaDesigner / IM-BIS の内部処理でシステムエラーが発生した場合 |
9010 | (入力チェックエラーメッセージ) | IM-FormaDesigner の入力チェックエラーメッセージ
IM-FormaDesigner / IM-BIS で作成したワークフローの場合のみ
|
9011 | 入力チェックでシステムエラーが発生しました。 | IM-FormaDesigner の入力チェックでシステムエラー
IM-FormaDesigner / IM-BIS で作成したワークフローの場合のみ
|