intra-mart Accel Platform IM-Workflow プログラミングガイド 第25版 2021-08-01

1.2.9. reserve

imWorkflow.process.reserve(Object parameter) : Promise<Object>

ワークフローの案件を保留します。

1.2.9.1. サンプルコード

imWorkflow.process.reserve({
   processParameter: {
       systemMatterId: "",
       nodeId: "",
       authUserCd: "",
       processComment: "",
       nego: {}
   },
   optionalParameter: {}
})
.then(function() {
  // success
})
.catch(function(error) {
  // error
});

1.2.9.2. パラメータ

  • parameter : Object

  • parameter.processParameter : Object(下記参照)
    保留用パラメータ情報オブジェクト
  • parameter.optionalParameter : Object(下記参照)
    ユーザパラメータを内包するオブジェクト

1.2.9.2.1. processParameter

項目名 必須/任意 型(最大バイト数) 説明
systemMatterId 任意 文字列
システム案件ID
「案件一覧」画面から遷移した場合は、一覧で選択したタスクのシステム案件IDが設定されるため不要
「案件一覧」画面以外から遷移した場合は、必須
nodeId 任意 文字列
ノードID
「案件一覧」画面から遷移した場合は、一覧で選択したタスクのノードIDが設定されるため不要
「案件一覧」画面以外から遷移した場合は、必須
authUserCd 任意 文字列
権限者コード
未指定の場合、実行ユーザで処理
processComment 任意 文字列(2000) 処理コメント
nego 任意 下記参照 根回し情報

1.2.9.2.1.1. nego

{
  nego: {
    userCdsTo: [
      "string"
    ],
    userCdsCc: [
      "string"
    ],
    userCdsBcc: [
      "string"
    ],
    subject: "string",
    text: "string"
  }
}
項目名 必須/任意 説明
userCdsTo 任意 配列(文字列)
宛先に指定するユーザのユーザコードを指定します。(複数指定可)
userCdsCc 任意 配列(文字列)
Ccに指定するユーザのユーザコードを指定します。(複数指定可)
userCdsBcc 任意 配列(文字列)
Bccに指定するユーザのユーザコードを指定します。(複数指定可)
subject 任意 文字列
送信するメールの件名を指定します。
text 任意 文字列
メール定義で設定した内容の「根回し時のコメント」として追記したい内容を指定します。
メール定義については、「 IM-Workflow 管理者操作ガイド 」を参照してください。

1.2.9.2.2. optionalParameter

「userParameter」には、アクション処理に受け渡したいパラメータを指定してください。
印影を指定する場合、「imwStampId」を指定してください。
印影を利用していて、「imwStampId」を指定しない場合、常用印が利用されます。
{
  optionalParameter: {
      userParameter: {
          imwStampId: "string",
          xxxx: "string"
      }
  }
}

1.2.9.3. 返却値

  • Promise<Object>
    返却オブジェクト(下記参照)
  • 当APIはPromiseを返します。
    処理が成功した場合の返却値はありません。
    処理が失敗した場合はpromise.catch()で返却値を受け取ってください。
項目名 説明
workflowResult.data.errorCode 文字列
エラーコード
処理が失敗した場合に設定されます。
workflowResult.data.localizedErrorMessage 文字列
エラーメッセージ
処理が失敗した場合に設定されます。

1.2.9.3.1. エラーコード

エラーコード エラーメッセージ 備考
1013 保留情報が未指定です。  
0013 指定した案件、処理ノード、権限者に対する処理権限がありません。  
1025 コメントが許可された最大文字数を超えています。  
1026 コメントのチェック処理でエラーが発生しました。管理者に連絡してください。  
7002 根回し機能は設定により利用できません。管理者に連絡してください。  
7003 根回しのチェック処理でエラーが発生しました。管理者に連絡してください。  
9000 処理に失敗しました。 案件処理プラグイン紐付け未定義のシステムエラー
9001 (アクション処理エラーメッセージ) アクション処理で設定したエラーメッセージ
9002 処理に失敗しました。案件に対して他の操作が実行されているため処理できません。 ワークフロー排他制御エラー