6.1.9.16.2. 申請時用ワークフロープラグイン情報取得¶
申請ノードにおいて、指定したノードに対して設定可能な処理対象者または確認対象者プラグインの名称情報を取得します。
申請ノードでのみ利用可能です。
6.1.9.16.2.1. HTTP リクエスト¶
POST /api/workflow/plugins/master-nodes
6.1.9.16.2.2. リクエストボディ¶
6.1.9.16.2.2.1. JSON¶
{
"applyAuthUserCd": "string",
"applyBaseDate": "string",
"flowId": "string",
"nodeConfigs": [
{
"nodeId": "string",
"plugins": [
{
"parameter": "string",
"pluginId": "string"
}
]
}
]
}
6.1.9.16.2.2.2. 詳細¶
| プロパティ名 | 論理名 | 型 | 必須 | デフォルト値 | 説明 |
|---|---|---|---|---|---|
| applyAuthUserCd | 申請権限者コード | string | 必須 | - | |
| applyBaseDate | 申請基準日 | string | 必須 | - | |
| flowId | フローID | string | 必須 | - | |
| nodeConfigs | 取得対象ノード情報 | array<object> | 必須 | - | |
| - nodeId | 取得対象ノードID | string | 必須 | - | |
| - plugins | プラグイン情報 | array<object> | 必須 | - | |
| - parameter | パラメータ | string | 必須 | - | プラグインに対するパラメータを指定してください。
詳細は「処理権限者プラグインの指定方法」を参照してください。
|
| - pluginId | プラグインID | string | 必須 | - | 取得対象のノードに対応するプラグインIDを指定してください。
詳細は「処理権限者プラグインの指定方法」を参照してください。
|
6.1.9.16.2.3. レスポンスデータ¶
6.1.9.16.2.3.1. JSON¶
"data": {
"nodeConfigs": [
{
"nodeId": "string",
"plugins": [
{
"parameter": "string",
"pluginDataName": "string",
"pluginId": "string",
"pluginName": "string"
}
]
}
]
}
6.1.9.16.2.3.2. 詳細¶
| プロパティ名 | 論理名 | 型 | 説明 |
|---|---|---|---|
| nodeConfigs | ノード設定情報 | array<object> | |
| - nodeId | ノードID | string | |
| - plugins | プラグイン情報 | array<object> | |
| - parameter | パラメータ | string | |
| - pluginDataName | プラグインデータ名 | string | 拡張ポイントID/プラグインID/パラメータ の組み合わせで一意に特定される情報の名称
例: 「青柳辰巳」、「サンプル課１１」など
|
| - pluginId | プラグインID | string | |
| - pluginName | プラグイン名 | string | 拡張ポイントID/プラグインID の組み合わせで一意に特定される情報の名称
例: 「ユーザ」、「組織」など
|
6.1.9.16.2.4. エラーコード¶
| エラーコード | エラーメッセージ | 備考 |
|---|---|---|
| 4003 | フロー、基準日に対する権限がありません。 | 指定したフローID、申請基準日に対しての権限がない場合 |
| 4004 | フロー、基準日に対する権限チェックでエラーが発生しました。 | 指定したフローID、申請基準日に対しての権限チェックに失敗した場合 |
| 5076 | フローが未指定です。 | リクエストボディ - flowId が未指定の場合 |
| 5077 | 基準日が未指定です。 | リクエストボディ - applyBaseDate が未指定の場合 |
| 5078 | 基準日のフォーマットが不正です。 | リクエストボディ - applyBaseDate のフォーマットが'yyyy/MM/dd'でない場合 |
| 5079 | 不正なプラグインが指定されています。 | 指定したプラグイン情報が有効でない場合 |
| 5080 | プラグインパラメータノード設定が未指定です。 | リクエストボディ - nodeConfigs が未指定の場合 |
| 5081 | 設定対象ノードが未指定です。 | リクエストボディ - nodeConfigs - nodeId が未指定の場合 |
| 5082 | プラグイン情報が未指定です。 | リクエストボディ - nodeConfigs - plugins が未指定の場合 |
| 5083 | プラグインIDが未指定です。 | リクエストボディ - nodeConfigs - plugins - pluginId が未指定の場合 |
| 5084 | プラグインパラメータが未指定です。 | リクエストボディ - nodeConfigs - plugins - parameter が未指定の場合 |
| 5085 | 設定不可能なノードが指定されています。 | 指定した取得対象ノードが設定不可能なノードの場合 |
| 5086 | 権限者が未指定です。 | リクエストボディ - applyAuthUserCd が未指定の場合 |
| 5087 | パラメータが未指定です。 | リクエストボディ が未指定の場合 |
| 6225 | プラグイン情報の取得でエラーが発生しました。 | 申請時用ワークフロープラグイン情報の取得処理に失敗した場合 |
| 8802 | プラグインデータ名の取得に失敗しました。 | 指定したプラグイン情報からプラグインデータ名の取得に失敗した場合 |
| 8803 | プラグイン名の取得に失敗しました。 | 指定したプラグイン情報からプラグイン名の取得に失敗した場合 |