intra-mart Accel Platform IM-Workflow 仕様書 第36版 2023-10-01

6.1.9.3.6. 申請に必要なノード設定情報取得

申請を行う際に処理権限者等の設定が可能なノード情報を初期値で設定した処理権限者情報、ワークフローパラメータのノードに関する設定情報を取得します。

6.1.9.3.6.1. HTTP リクエスト

GET /api/workflow/applications/{flowId}/config-set

6.1.9.3.6.2. パスパラメータ

パラメータ 論理名 説明
flowId フローID  

6.1.9.3.6.3. クエリパラメータ

パラメータ 論理名 必須 説明
applyBaseDate 申請基準日 String 必須 「yyyy/MM/dd」フォーマット
applyAuthUserCd 申請権限者コード String 必須  

6.1.9.3.6.4. レスポンスデータ

6.1.9.3.6.4.1. JSON

{
  "data": {
   "attachmentFileConfig": "string",
   "attachmentFileNameSize": 0,
   "commentSize": 0,
   "configBranchStartNodes": [
     {
       "nodeId": "string",
       "nodeName": "string",
       "nodeType": "string",
       "forwardNodes": [
         {
           "nodeId": "string",
           "nodeName": "string",
           "nodeType": "string"
         }
       ],
       "multipleBranchEnabled": true
     }
   ],
   "configConfirmNodes": [
     {
       "nodeId": "string",
       "nodeName": "string",
       "nodeType": "string",
       "defaultConfirmTargets": [
         {
           "extensionPointId": "string",
           "parameter": "string",
           "pluginDataName": "string",
           "pluginId": "string",
           "pluginName": "string"
         }
       ],
       "pluginConfigPages": [
         {
           "applicationId": "string",
           "configPageType": "string",
           "pagePath": "string",
           "parameter": {},
           "path": "string",
           "pluginId": "string",
           "pluginName": "string",
           "serviceId": "string"
         }
       ],
       "pluginParametersDisable": [
         "string"
       ]
     }
   ],
   "configDynamicNodes": [
     {
       "nodeId": "string",
       "nodeName": "string",
       "nodeType": "string",
       "defaultDepartmentsDisable": [
         {
           "companyCd": "string",
           "departmentSetCd": "string"
         }
       ],
       "defaultProcessTargets": [
         {
           "extensionPointId": "string",
           "parameter": "string",
           "pluginDataName": "string",
           "pluginId": "string",
           "pluginName": "string"
         }
       ],
       "deleteDisabled": true,
       "pluginConfigPages": [
         {
           "applicationId": "string",
           "configPageType": "string",
           "pagePath": "string",
           "parameter": {},
           "path": "string",
           "pluginId": "string",
           "pluginName": "string",
           "serviceId": "string"
         }
       ],
       "pluginParametersDisable": [
         "string"
       ]
     }
   ],
   "configHorizontalNodes": [
     {
       "nodeId": "string",
       "nodeName": "string",
       "nodeType": "string",
       "defaultDepartmentsDisable": [
         {
           "companyCd": "string",
           "departmentSetCd": "string"
         }
       ],
       "defaultProcessTargets": [
         {
           "extensionPointId": "string",
           "parameter": "string",
           "pluginDataName": "string",
           "pluginId": "string",
           "pluginName": "string"
         }
       ],
       "dispatchNodeMax": 0,
       "dispatchNodeMin": 0,
       "pluginConfigPages": [
         {
           "applicationId": "string",
           "configPageType": "string",
           "pagePath": "string",
           "parameter": {},
           "path": "string",
           "pluginId": "string",
           "pluginName": "string",
           "serviceId": "string"
         }
       ],
       "pluginParametersDisable": [
         "string"
       ]
     }
   ],
   "configVerticalNodes": [
     {
       "nodeId": "string",
       "nodeName": "string",
       "nodeType": "string",
       "defaultDepartmentsDisable": [
         {
           "companyCd": "string",
           "departmentSetCd": "string"
         }
       ],
       "defaultProcessTargets": [
         {
           "extensionPointId": "string",
           "parameter": "string",
           "pluginDataName": "string",
           "pluginId": "string",
           "pluginName": "string"
         }
       ],
       "dispatchNodeMax": 0,
       "dispatchNodeMin": 0,
       "pluginConfigPages": [
         {
           "applicationId": "string",
           "configPageType": "string",
           "pagePath": "string",
           "parameter": {},
           "path": "string",
           "pluginId": "string",
           "pluginName": "string",
           "serviceId": "string"
         }
       ],
       "pluginParametersDisable": [
         "string"
       ]
     }
   ],
   "defaultDepartments": [
     {
       "companyCd": "string",
       "departmentSetCd": "string"
     }
   ],
   "expandNodeNameSize": 0,
   "flowWindowHeight": 0,
   "flowWindowWidth": 0,
   "matterNameSize": 0,
   "negoPluginConfig": {
     "defaultFormatTargetDate": "string",
     "pluginConfigPages": [
       {
         "applicationId": "string",
         "configPageType": "string",
         "pagePath": "string",
         "parameter": {},
         "path": "string",
         "pluginId": "string",
         "pluginName": "string",
         "serviceId": "string"
       }
     ],
     "targetDate": "string"
   },
   "negotiateEnabled": true,
   "nodeConfigNameSize": 0,
   "nodeName": "string",
   "nodeProcessName": "string",
   "noticeType": "string",
   "stampEnabled": true,
   "temporarySaveEnabled": true
 }
}

6.1.9.3.6.4.2. 詳細

プロパティ名 論理名 説明
attachmentFileConfig 添付ファイル設定 string CodeList 」のコード値がセットされます。
attachmentFileNameSize 添付ファイル名の入力可能文字数 number ワークフローパラメータ「 attach-file-name-size入力項目の設定 )」の設定内容がセットされます。
commentSize 申請・処理時コメントの入力可能文字数 number ワークフローパラメータ「 proc-comment-size入力項目の設定 )」の設定内容がセットされます。
configBranchStartNodes 設定対象分岐開始ノード情報のリスト array<object>
分岐開始ノード設定 -「申請/処理時に分岐先を選択する」による分岐情報がセットされます。
各プロパティの詳細は 分岐開始ノード情報 を参照してください。
configConfirmNodes 設定可能確認ノード情報リスト array<object>
確認ノード設定 の「 確認対象者設定可能ノード 」設定による確認ノード情報がセットされます。
各プロパティの詳細は 確認ノード情報 を参照してください。
configDynamicNodes 設定対象動的承認ノード情報のリスト array<object>
動的承認・横配置・縦配置ノード設定 の「 処理対象者設定可能ノード 」設定による動的承認ノード情報がセットされます。
各プロパティの詳細は 動的承認ノード情報 を参照してください。
configHorizontalNodes 設定対象横配置ノード情報のリスト array<object>
動的承認・横配置・縦配置ノード設定 の「 処理対象者設定可能ノード 」設定による横配置ノード情報がセットされます。
各プロパティの詳細は 横・縦配置ノード情報 を参照してください。
configVerticalNodes 設定対象縦配置ノード情報のリスト array<object>
動的承認・横配置・縦配置ノード設定 の「 処理対象者設定可能ノード 」設定による縦配置ノード情報がセットされます。
各プロパティの詳細は 横・縦配置ノード情報 を参照してください。
defaultDepartments 標準組織情報のリスト array<object>
フロー定義を登録・設定する のコラム「 標準組織の設定 」の設定内容がセットされます。
各プロパティの詳細は 標準組織情報 を参照してください。
expandNodeNameSize 展開するノード名の入力可能な文字数 number ワークフローパラメータ「 node-config-name-size入力項目の設定 )」の設定内容がセットされます。
flowWindowHeight フロー参照画面・フロー情報画面のポップアップウィンドウの高さ number ワークフローパラメータ「 imw-flow-window-heightポップアップウィンドウサイズの設定 )」の設定内容がセットされます。
flowWindowWidth フロー参照画面・フロー情報画面のポップアップウィンドウの幅 number ワークフローパラメータ「 imw-flow-window-widthポップアップウィンドウサイズの設定 )」の設定内容がセットされます。
matterNameSize 案件名の入力可能な文字数 number ワークフローパラメータ「 matter-name-size入力項目の設定 )」の設定内容がセットされます。
negoPluginConfig 根回し用プラグイン情報 object
negotiateEnabled が true の場合にセットされます。
各プロパティの詳細は 根回しプラグイン情報 を参照してください。
negotiateEnabled 根回し機能の使用可否 boolean ワークフローパラメータ「 negotiate-type根回しの設定 )」の設定内容がセットされます。
nodeConfigNameSize ノード設定名の入力可能な文字数 number ワークフローパラメータ「 node-config-name-size入力項目の設定 )」の設定内容がセットされます。
nodeName ノード名 string  
nodeProcessName 処理種別名 string  
noticeType 通知の設定 string ワークフローパラメータ「 notice-type通知の設定(メール/ IMBox 定義) )」の設定内容がセットされます。
stampEnabled 印影機能の使用可否 boolean ワークフローパラメータ「 stamp-enabled印影設定 )」の設定内容がセットされます。
temporarySaveEnabled 一時保存機能の使用可否 boolean ワークフローパラメータ「 temporary-save一時保存機能の設定 )」の設定内容がセットされます。
分岐開始ノード情報
プロパティ名 論理名 説明
nodeId ノードID string  
nodeName ノード名 string  
nodeType ノード種別 string CodeList 」の コード値 がセットされます。
forwardNodes 順方向ノード情報のリスト array<object> 各プロパティの詳細は ノード情報 を参照してください。
multipleBranchEnabled 分岐先複数設定可否 boolean 複数設定可能であれば true がセットされます。
確認ノード情報
プロパティ名 論理名 説明
nodeId ノードID string  
nodeName ノード名 string  
nodeType ノード種別 string CodeList 」の コード値 がセットされます。
defaultConfirmTargets 確認対象者初期情報のリスト array<object>
ルート詳細を設定する にて設定した確認対象者情報がセットされます。
各プロパティの詳細は 処理権限者プラグイン情報 を参照してください。
pluginConfigPages プラグインの設定情報リスト array<object>
確認対象者プラグイン一覧 の定義ファイル(plugin.xml)の内容がセットされます。
定義ファイルは 処理対象者プラグインを設定する の「 処理対象者プラグイン設定ファイル一覧 」から確認できます。
各プロパティの詳細は プラグイン情報 を参照してください。
pluginParametersDisable プラグイン設定(表示禁止プラグインID)のリスト array<string> 確認ノード設定 のプラグイン設定において無効化したプラグインのリストがセットされます。
動的承認ノード情報
プロパティ名 論理名 説明
nodeId ノードID string  
nodeName ノード名 string  
nodeType ノード種別 string CodeList 」の コード値 がセットされます。
defaultDepartmentsDisable 標準組織設定(表示禁止)のリスト array<object>
動的承認・横配置・縦配置ノード設定 の公開設定の内容がセットされます。
各プロパティの詳細は 標準組織情報 を参照してください。
defaultProcessTargets 処理対象者初期情報のリスト array<object>
ルート詳細を設定する にて設定した処理対象者情報がセットされます。
各プロパティの詳細は 処理権限者プラグイン情報 を参照してください。
deleteDisabled 削除禁止可否 boolean 削除禁止の場合 true がセットされます。
pluginConfigPages プラグインの設定情報リスト array<object>
処理権限者プラグイン一覧 の定義ファイル(plugin.xml)の内容がセットされます。
定義ファイルは 処理対象者プラグインを設定する の「 処理対象者プラグイン設定ファイル一覧 」から確認できます。
各プロパティの詳細は プラグイン情報 を参照してください。
pluginParametersDisable プラグイン設定(表示禁止プラグインID)のリスト array<string> 動的承認・横配置・縦配置ノード設定 のプラグイン設定において無効化したプラグインのリストがセットされます。
横・縦配置ノード情報
プロパティ名 論理名 説明
nodeId ノードID string  
nodeName ノード名 string  
nodeType ノード種別 string CodeList 」の コード値 がセットされます。
defaultDepartmentsDisable 標準組織設定(表示禁止)のリスト array<object>
動的承認・横配置・縦配置ノード設定 の公開設定の内容がセットされます。
各プロパティの詳細は 標準組織情報 を参照してください。
defaultProcessTargets 処理対象者初期情報のリスト array<object>
ルート詳細を設定する にて設定した処理対象者情報がセットされます。
各プロパティの詳細は 処理権限者プラグイン情報 を参照してください。
dispatchNodeMax 割当可能ノード数(最大) number 動的承認・横配置・縦配置ノード設定 の割当可能ノード数(最大)の値がセットされます。
dispatchNodeMin 割当可能ノード数(最小) number 動的承認・横配置・縦配置ノード設定 の割当可能ノード数(最小)の値がセットされます。
pluginConfigPages プラグインの設定情報リスト array<object>
処理権限者プラグイン一覧 の定義ファイル(plugin.xml)の内容がセットされます。
定義ファイルは 処理対象者プラグインを設定する の「 処理対象者プラグイン設定ファイル一覧 」から確認できます。
各プロパティの詳細は プラグイン情報 を参照してください。
pluginParametersDisable プラグイン設定(表示禁止プラグインID)のリスト array<string> 動的承認・横配置・縦配置ノード設定 のプラグイン設定において無効化したプラグインのリストがセットされます。
標準組織情報
プロパティ名 論理名 説明
companyCd 会社コード string  
departmentSetCd 組織セットコード string  
根回しプラグイン情報
プロパティ名 論理名 説明
defaultFormatTargetDate 基準日(デフォルトフォーマット) string
案件の申請基準日(applyBaseDate)がセットされます。
「yyyy/MM/dd」フォーマットの値
pluginConfigPages プラグインの設定情報リスト array<object> 各プロパティの詳細は プラグイン情報 を参照してください。
targetDate 基準日 string
案件の申請基準日(applyBaseDate)がセットされます。
アカウントコンテキストの「日付(標準表示)」フォーマットで整形された値
ノード情報
プロパティ名 論理名 説明
nodeId ノードID string  
nodeName ノード名 string  
nodeType ノード種別 string CodeList 」の コード値 がセットされます。
処理権限者プラグイン情報
プロパティ名 論理名 説明
extensionPointId 拡張ポイントID string  
parameter プラグインパラメータ string  
pluginDataName プラグインデータ名 string
処理権限者プラグイン一覧 を利用して設定した処理対象者の名称がセットされます。
アカウントコンテキストのロケールの名称がセットされます。
pluginId プラグインID string  
pluginName プラグイン名 string
処理権限者プラグイン一覧 のプラグイン名がセットされます。
アカウントコンテキストのロケールのプラグイン名がセットされます。
プラグイン情報
プロパティ名 論理名 説明
applicationId アプリケーションID string configPageType が javaee の場合のみセットされます。
configPageType プラグイン設定画面情報種別 string scriptjavaeeurl のいずれかがセットされます。
pagePath ページパス string configPageType が script の場合のみセットされます。
parmeter   string  
path パス string configPageType が url の場合のみセットされます。
pluginId プラグインID string  
pluginName プラグイン名 string  
serviceId サービスID string configPageType が javaee の場合のみセットされます。

6.1.9.3.6.5. エラーコード

エラーコード エラーメッセージ 備考
0014 申請権限がありません。  
0015 申請権限のチェックに失敗しました。管理者に連絡してください。  
0016 日付の認識に失敗しました。管理者に連絡してください。  
5001 申請基準日が未指定です。  
5002 申請権限者コードが未指定です。  
5050 日付の認識に失敗しました。管理者に連絡してください。  
6001 申請を行う際の設定が可能なノード情報取得に失敗しました。管理者に連絡してください。  
8802 プラグインデータ名の取得に失敗しました。  
8803 プラグイン名の取得に失敗しました。  
8805 処理には押印が必要ですが、印影情報が1件も登録されていません。印影情報を事前に登録してください。 実行ユーザの印影情報が存在しない場合