6.1.9.16.1. 案件処理時用ワークフロープラグイン情報取得¶
処理ノードにおいて、指定したノードに対して設定可能な処理対象者または確認対象者プラグインの名称情報を取得します。
処理ノード（申請ノード以外）で利用可能です。
6.1.9.16.1.1. HTTP リクエスト¶
POST /api/workflow/plugins
6.1.9.16.1.2. リクエストボディ¶
6.1.9.16.1.2.1. JSON¶
{
"nodeConfigs": [
{
"nodeId": "string",
"plugins": [
{
"parameter": "string",
"pluginId": "string"
}
]
}
],
"nodeId": "string",
"systemMatterId": "string"
}
6.1.9.16.1.2.2. 詳細¶
| プロパティ名 | 論理名 | 型 | 必須 | デフォルト値 | 説明 |
|---|---|---|---|---|---|
| nodeConfigs | 取得対象ノード情報 | array<object> | 必須 | - | |
| - nodeId | 取得対象ノードID | string | 必須 | - | |
| - plugins | プラグイン情報 | array<object> | 必須 | - | |
| - parameter | パラメータ | string | 必須 | - | プラグインに対するパラメータを指定してください。
詳細は「処理権限者プラグインの指定方法」を参照してください。
|
| - pluginId | プラグインID | string | 必須 | - | 取得対象のノードに対応するプラグインIDを指定してください。
詳細は「処理権限者プラグインの指定方法」を参照してください。
|
| nodeId | 処理ノードID | string | 必須 | - | 本APIを実行するノードを指定してください。 |
| systemMatterId | システム案件ID | string | 必須 | - |
6.1.9.16.1.3. レスポンスデータ¶
6.1.9.16.1.3.1. JSON¶
"data": {
"nodeConfigs": [
{
"nodeId": "string",
"plugins": [
{
"parameter": "string",
"pluginDataName": "string",
"pluginId": "string",
"pluginName": "string"
}
]
}
]
}
6.1.9.16.1.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.1.4. エラーコード¶
| エラーコード | エラーメッセージ | 備考 |
|---|---|---|
| 4001 | 案件、ノードに対する権限がありません。 | 指定した案件、ノードに対しての権限がない場合 |
| 4002 | 案件、ノードに対する権限チェックでエラーが発生しました。 | 指定した案件、ノードに対しての権限チェックに失敗した場合 |
| 5073 | パラメータが未指定です。 | リクエストボディ が未指定の場合 |
| 5074 | 案件が未指定です。 | リクエストボディ - systemMatterId が未指定の場合 |
| 5075 | ノードが未指定です。 | リクエストボディ - nodeId が未指定の場合 |
| 5079 | 不正なプラグインが指定されています。 | 指定したプラグイン情報が有効でない場合 |
| 5080 | プラグインパラメータノード設定が未指定です。 | リクエストボディ - nodeConfigs が未指定の場合 |
| 5081 | 設定対象ノードが未指定です。 | リクエストボディ - nodeConfigs - nodeId が未指定の場合 |
| 5082 | プラグイン情報が未指定です。 | リクエストボディ - nodeConfigs - plugins が未指定の場合 |
| 5083 | プラグインIDが未指定です。 | リクエストボディ - nodeConfigs - plugins - pluginId が未指定の場合 |
| 5084 | プラグインパラメータが未指定です。 | リクエストボディ - nodeConfigs - plugins - parameter が未指定の場合 |
| 5085 | 設定不可能なノードが指定されています。 | 指定した取得対象ノードが設定不可能なノードの場合 |
| 6224 | プラグイン情報の取得でエラーが発生しました。 | 案件処理時用ワークフロープラグイン情報の取得処理に失敗した場合 |
| 8802 | プラグインデータ名の取得に失敗しました。 | 指定したプラグイン情報からプラグインデータ名の取得に失敗した場合 |
| 8803 | プラグイン名の取得に失敗しました。 | 指定したプラグイン情報からプラグイン名の取得に失敗した場合 |
| 8804 | 指定された案件・ノードで利用すべき基準日の解決に失敗しました。 | 指定した案件、ノードに対しての基準日取得に失敗した場合 |