intra-mart Accel Platform IM-Workflow 仕様書 第37版 2024-04-01

6.1.9.1.10. 引戻しに必要な情報取得

引戻しを行う際に必要な以下の情報を取得します。

  • 引戻し先として指定可能なノード情報リスト
  • 根回し機能の設定情報

6.1.9.1.10.1. HTTP リクエスト

GET /api/workflow/active-matters-processed/{systemMatterId}/pull-back

6.1.9.1.10.2. パスパラメータ

プロパティ名 論理名 説明
systemMatterId システム案件ID 処理対象のシステム案件IDを指定してください。

6.1.9.1.10.3. レスポンスデータ

6.1.9.1.10.3.1. JSON

{
  "data": {
    "pullBackDestinationNodes": [
      {
        "authUserCd": "string",
        "authUserName": "string",
        "authOrgzName": "string",
        "executeUserName": "string",
        "nodeId": "string",
        "nodeName": "string",
        "nodeType": "string",
        "statusTypeName": "string",
        "endDate": "string",
        "defaultFormatEndDate": "string",
        "delegation": true,
        "status": "string"
      }
    ],
    "negotiateValidity": true,
    "negotiateCcBcc": true,
    "negotiateSubject ": true
  }
}

6.1.9.1.10.3.2. 詳細

プロパティ名 論理名 説明
pullBackDestinationNodes 引戻し先ノード情報リスト array<object> 引戻し先として選択可能なノードのリスト
- authUserCd 処理権限者コード string 案件処理時の処理権限者のユーザコード
- authUserName 処理権限者名 string 案件処理時の処理権限者の名前
- authOrgzName 担当組織名 string  
- executeUserName 実行者コード string 実行者のユーザコード
- nodeId ノードID string  
- nodeName ノード名 string  
- nodeType ノード種別 string  
- statusTypeName 処理種別名 string  
- endDate 処理日時 string
アカウントコンテキストの日付表示形式の値
アカウントのタイムゾーンへ変換しています。
- defaultFormatEndDate 処理日時(デフォルトフォーマット) string yyyy/MM/dd HH:mm:ss.SSS 形式の値
- delegation 代理フラグ boolean 代理者による実行の場合は true がセットされます。
- status タスクステータス string  
negotiateValidity 根回しの有効性 boolean ワークフローパラメータ「 negotiate-type根回しの設定 )」、「 notice-type通知の設定(メール/ IMBox 定義) )」、「 use-messagehub-nego-reminder-transferIM-MessageHub機能を利用した通知機能の使用可否 )」の設定内容とフロー定義のメッセージの設定内容により、根回しが有効な場合は true がセットされます。
negotiateCcBcc 根回しのCc/Bccの利用可否 boolean negotiateValiditytrue の場合に、Cc/Bccが利用可能な場合は true がセットされます。
negotiateSubject 根回しの件名の利用可否 boolean negotiateValiditytrue の場合に、件名が利用可能な場合は true がセットされます。

6.1.9.1.10.4. エラーコード

エラーコード エラーメッセージ 備考
6337 指定された案件の未完了案件情報の取得に失敗しました。 systemMatterId に対応する未完了案件情報の取得に失敗した場合
6338 指定された案件の未完了案件情報が存在しません。 systemMatterId に対応する未完了案件情報が存在しなかった場合
6339 引戻しに必要な情報の取得に失敗しました。 引戻しに必要な情報の取得に失敗した場合
6340 引戻し先情報の取得に失敗しました。 引戻し先に指定可能なノード情報の取得に失敗した場合
6341 引戻し先情報が存在しません。
以下のいずれかの場合
実行者に案件に対する引戻し先ノードに対する処理権限がない場合
引戻し実行前に案件が処理されたなどにより、引戻しが実行できない場合
処理設定により引戻しが無効化されている場合