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

6.1.9.19.3. 申請時用利用者ノード設定ノード詳細情報取得

申請時用利用者ノード設定ノード詳細情報を取得します。
このAPIでは指定されたフローID、基準日時点でのフロー定義のノードに基づくチェックを行います。
案件作成前のノードに対する設定情報を取得する際はこのAPIを利用してください。

コラム

このAPIでは、システムとして無効なプラグイン情報は取得対象に含まれません。
例)
1. 2020/07/10 ユーザプラグインが有効な状態で、ユーザプラグインを含めた利用者ノード設定を保存
2. 2020/07/31 ユーザプラグインを無効に変更
3. 2020/08/01 このAPIを実行した際の取得結果に、ユーザプラグイン情報は含まれない

6.1.9.19.3.1. HTTP リクエスト

GET /api/workflow/user-node-configs/master-nodes/{nodeConfigId}

6.1.9.19.3.2. パスパラメータ

プロパティ名 論理名 説明
nodeConfigId 利用者ノード設定ID
利用対象のノードで設定可能な利用者ノード設定IDを指定してください。
利用者ノード設定基本情報取得」を利用して取得できます。

6.1.9.19.3.3. クエリパラメータ

プロパティ名 論理名 説明
flowId フローID string  
applyBaseDate 申請基準日 string  
nodeId ノードID string  

6.1.9.19.3.4. レスポンスデータ

6.1.9.19.3.4.1. JSON

"data": {
  "excluded": true,
  "nodes": [
    {
      "details": [
        {
          "execUserNo": "string",
          "extensionPointId": "string",
          "nodeConfigId": "string",
          "nodeNo": "string",
          "parameter": "string",
          "pluginDataName": "string",
          "pluginId": "string",
          "pluginName": "string"
        }
      ],
      "expandedNodeName": "string",
      "nodeConfigId": "string",
      "nodeNo": "string"
    }
  ]
}

6.1.9.19.3.4.2. 詳細

プロパティ名 論理名 説明
excluded プラグイン情報除外フラグ boolean ユーザが保存した設定情報に含まれるプラグインIDに、システムとして無効なものが存在した場合に true がセットされます。
nodes 利用者ノード設定ノード情報 array<object>  
- details 利用者ノード設定詳細情報 array<object>  
 - execUserNo 処理対象者連番 string
20桁の連番がセットされます。
(例)"00000000000000000001"
セットされる内容は「 利用者ノード設定情報登録API 」内の details 配列の要素順で連番です。
 - extensionPointId 拡張ポイントID string 詳細は「処理権限者プラグイン一覧 」または「確認対象者プラグイン一覧 」を参照してください。
 - nodeConfigId 利用者ノード設定ID string  
 - nodeNo ノード連番 string
20桁の連番がセットされます。
(例)"00000000000000000001"
セットされる内容は「 利用者ノード設定情報登録API 」内の nodes 配列の要素順で連番です。
 - parameter パラメータ string  
 - pluginDataName プラグインデータ名 string
拡張ポイントID/プラグインID/パラメータ の組み合わせで一意に特定される情報の名称
例: 「青柳辰巳」、「サンプル課11」など
 - pluginId プラグインID string  
 - pluginName プラグイン名 string
拡張ポイントID/プラグインID の組み合わせで一意に特定される情報の名称
例: 「ユーザ」、「組織」など
- expandedNodeName 展開済みノード名 string
ユーザが保存した設定情報のノード名
動的承認と確認では値は常に空です。
- nodeConfigId 利用者ノード設定ID string  
- nodeNo ノード連番 string
20桁の連番がセットされます。
(例)"00000000000000000001"
セットされる内容は「 利用者ノード設定情報登録API 」内の nodes 配列の要素順で連番です。

6.1.9.19.3.5. エラーコード

エラーコード エラーメッセージ 備考
1004 ノードが未指定です。 nodeId が未指定の場合
1005 フローが未指定です。 flowId が未指定の場合
1006 基準日が不正です。 applyBaseDate が不正の場合
1007 指定された基準日の有効なフロー情報が存在しません。 applyBaseDate に指定された日付時点で有効なフローが存在しない場合
1008 指定された基準日時点でのフローには該当するノードが存在しません。 applyBaseDate に指定された日付時点で有効なフローに該当するノードが存在しない場合
1009 指定された基準日時点でのフローで該当するノードは利用者ノード設定を保存できないノードです。 applyBaseDate に指定された日付時点で有効なフローに該当するノードが利用者ノード設定を保存できない場合
1016 利用者ノード設定IDが未指定です。 nodeConfigId が未指定の場合
1018 基準日が未指定です。 applyBaseDate が未指定の場合
3004 利用者ノード設定詳細情報の取得に失敗しました。 利用者ノード設定詳細情報の取得に失敗した場合
3005 マスタ情報が不正です。管理者に連絡してください。 動的ノード以外での利用、または、割当可能ノードが存在しない場合
8802 プラグインデータ名の取得に失敗しました。 プラグインデータ名の取得に失敗した場合
8803 プラグイン名の取得に失敗しました。 プラグイン名の取得に失敗した場合