5.2.1.8.20. タスク検索¶
タスクを検索するタスクです。
本タスクは処理結果が確定しているタスク情報の検索を行うタスクです。同一トランザクション内で処理を行っている未確定のタスク情報の検索を目的とした使用は想定されません。
5.2.1.8.20.1. 入力値¶
im_bpmQueryTasksForManagement <object>
├─ active <boolean>
├─ assignee <string>
├─ assigneeLike <string>
├─ candidateGroup <string>
├─ candidateGroupIn <string[]>
├─ candidateOrAssigned <string>
├─ candidateUser <string>
├─ createdAfter <date>
├─ createdBefore <date>
├─ createdOn <date>
├─ dueAfter <date>
├─ dueBefore <date>
├─ dueDate <date>
├─ executionId <string>
├─ includeProcessVariables <boolean>
├─ includeTaskLocalVariables <boolean>
├─ involvedUser <string>
├─ maximumPriority <integer>
├─ minimumPriority <integer>
├─ name <string>
├─ nameLike <string>
├─ pagination <object>
│ ├─ limit <integer>
│ └─ offset <integer>
├─ priority <integer>
├─ processDefinitionId <string>
├─ processDefinitionKey <string>
├─ processDefinitionKeyLike <string>
├─ processDefinitionName <string>
├─ processDefinitionNameLike <string>
├─ processInstanceBusinessKey <string>
├─ processInstanceBusinessKeyLike <string>
├─ processInstanceId <string>
├─ processInstanceVariables <object[]>
│ ├─ name <string>
│ ├─ operation <string>
│ ├─ type <string>
│ └─ value <any>
├─ sort <object>
│ ├─ order <string>
│ ├─ secondOrder <string>
│ ├─ secondSort <string>
│ └─ sort <string>
├─ taskCategory <string>
├─ taskDefinitionKey <string>
├─ taskDefinitionKeyLike <string>
├─ taskId <string>
├─ taskOrProcessInstanceVariables <object[]>
│ ├─ name <string>
│ ├─ operation <string>
│ ├─ type <string>
│ └─ value <any>
├─ taskVariables <object[]>
│ ├─ name <string>
│ ├─ operation <string>
│ ├─ type <string>
│ └─ value <any>
├─ unassigned <boolean>
└─ withoutDueDate <boolean>
| 項目名 | 必須/任意 | 型 | 配列/リスト | 説明 |
|---|---|---|---|---|
| im_bpmQueryTasksForManagement | 任意 | object | なし | 検索条件 |
| active | 任意 | boolean | なし | 有効状態 |
| assignee | 任意 | string | なし | 担当者 |
| assigneeLike | 任意 | string | なし | 担当者(部分一致) |
| candidateGroup | 任意 | string | なし | 関連グループ |
| candidateGroupIn | 任意 | string | リスト | 関連グループリスト |
| candidateOrAssigned | 任意 | string | なし | 関連者、または担当者 |
| candidateUser | 任意 | string | なし | 関連者 |
| createdAfter | 任意 | date | なし | 作成日時(以後) |
| createdBefore | 任意 | date | なし | 作成日時(以前) |
| createdOn | 任意 | date | なし | 作成日時 |
| dueAfter | 任意 | date | なし | 期限日時(以降) |
| dueBefore | 任意 | date | なし | 期限日時(以前) |
| dueDate | 任意 | date | なし | 期限日時 |
| executionId | 任意 | string | なし | エグゼキューションID |
| includeProcessVariables | 任意 | boolean | なし | プロセスインスタンス変数の情報を結果に含める |
| includeTaskLocalVariables | 任意 | boolean | なし | タスク変数の情報を結果に含める |
| involvedUser | 任意 | string | なし | 関係者 |
| maximumPriority | 任意 | integer | なし | 優先度(最大) |
| minimumPriority | 任意 | integer | なし | 優先度(最小) |
| name | 任意 | string | なし | タスク名 |
| nameLike | 任意 | string | なし | タスク名(部分一致) |
| pagination | 任意 | object | なし | ページング条件 |
| limit | 任意 | integer | なし | 取得するデータの最大レコード数を設定してください(0以上。0の場合、offset以降の全件)。 |
| offset | 任意 | integer | なし | 取得するデータの開始レコード位置を設定してください(1以上を設定してください)。 |
| priority | 任意 | integer | なし | 優先度 |
| processDefinitionId | 任意 | string | なし | プロセス定義ID |
| processDefinitionKey | 任意 | string | なし | プロセス定義キー |
| processDefinitionKeyLike | 任意 | string | なし | プロセス定義キー(部分一致) |
| processDefinitionName | 任意 | string | なし | プロセス定義名 |
| processDefinitionNameLike | 任意 | string | なし | プロセス定義名(部分一致) |
| processInstanceBusinessKey | 任意 | string | なし | 業務キー |
| processInstanceBusinessKeyLike | 任意 | string | なし | 業務キー(部分一致) |
| processInstanceId | 任意 | string | なし | プロセスインスタンスID |
| processInstanceVariables | 任意 | object | リスト | プロセスインスタンス変数 |
| name | 任意 | string | なし | 変数名 |
| operation | 任意 | string | なし | オペレーション
以下のいずれかの値を設定してください。
equals, notEquals, equalsIgnoreCase, notEqualsIgnoreCase, like, greaterThan, greaterThanOrEquals, lessThan, lessThanOrEquals
|
| type | 任意 | string | なし | タイプ
以下のいずれかの値を設定してください。
string, integer, long, short, double, boolean, date
|
| value | 任意 | any | なし | 値 |
| sort | 任意 | object | なし | ソート条件 |
| order | 任意 | string | なし | 第一ソートキーのソート順
以下のいずれかの値を設定してください(設定なしの場合、ソート順はasc(昇順)です)。
asc, desc
|
| secondOrder | 任意 | string | なし | 第二ソートキーのソート順
以下のいずれかの値を設定してください(設定なしの場合、ソート順はasc(昇順)です)。
asc, desc
|
| secondSort | 任意 | string | なし | 第二ソートキー
以下のいずれかの値を設定してください(第一ソートキーが設定されていない場合は無効です)。
id, name, description, dueDate, createTime, priority, executionId, processInstanceId, assignee, category, processDefinitionName, processInstanceBusinessKey
|
| sort | 任意 | string | なし | 第一ソートキー
以下のいずれかの値を設定してください。
id, name, description, dueDate, createTime, priority, executionId, processInstanceId, assignee, category, processDefinitionName, processInstanceBusinessKey
|
| taskCategory | 任意 | string | なし | カテゴリ |
| taskDefinitionKey | 任意 | string | なし | タスク定義キー(アクティビティID) |
| taskDefinitionKeyLike | 任意 | string | なし | タスク定義キー(アクティビティID)(部分一致) |
| taskId | 任意 | string | なし | タスクID |
| taskOrProcessInstanceVariables | 任意 | object | リスト | タスク変数、またはプロセスインスタンス変数 |
| name | 任意 | string | なし | 変数名 |
| operation | 任意 | string | なし | オペレーション
以下のいずれかの値を設定してください。
equals, notEquals, equalsIgnoreCase, notEqualsIgnoreCase, like, greaterThan, greaterThanOrEquals, lessThan, lessThanOrEquals
|
| type | 任意 | string | なし | タイプ
以下のいずれかの値を設定してください。
string, integer, long, short, double, boolean, date
|
| value | 任意 | any | なし | 値 |
| taskVariables | 任意 | object | リスト | タスク変数 |
| name | 任意 | string | なし | 変数名 |
| operation | 任意 | string | なし | オペレーション
以下のいずれかの値を設定してください。
equals, notEquals, equalsIgnoreCase, notEqualsIgnoreCase, like, greaterThan, greaterThanOrEquals, lessThan, lessThanOrEquals
|
| type | 任意 | string | なし | タイプ
以下のいずれかの値を設定してください。
string, integer, long, short, double, boolean, date
|
| value | 任意 | any | なし | 値 |
| unassigned | 任意 | boolean | なし | 担当者なし |
| withoutDueDate | 任意 | boolean | なし | 期限日時なし |
コラム
部分一致検索項目では、ワイルドカード(”%”、”_”など)を使用できます。ワイルドカードを使用しない場合、完全一致の検索条件として検索が実行されます。
例: キーワード を含む文字列を部分一致検索する場合
‘%キーワード%‘
コラム
第一ソートキーが指定されており、第一ソートキー、第二ソートキーでソート結果が一意とならない場合、idが暗黙ソートキーとして追加で指定されます。
5.2.1.8.20.2. 出力値¶
im_bpmQueryTasksForManagement <object>
├─ metaData <object>
│ └─ total <long>
└─ queryTasksResults <object[]>
├─ assignee <string>
├─ createTime <date>
├─ dueDate <date>
├─ executionId <string>
├─ formKey <string>
├─ name <string>
├─ priority <integer>
├─ processDefinitionId <string>
├─ processDefinitionName <string>
├─ processDefinitionType <string>
├─ processInstanceBusinessKey <string>
├─ processInstanceId <string>
├─ processInstanceVariablesMap <map>
├─ suspended <boolean>
├─ taskCategory <string>
├─ taskDefinitionKey <string>
├─ taskId <string>
├─ taskVariablesMap <map>
└─ variables <object[]>
├─ name <string>
├─ scope <string>
├─ type <string>
└─ value <any>
| 項目名 | 型 | 配列/リスト | 説明 |
|---|---|---|---|
| im_bpmQueryTasksForManagement | object | なし | |
| metaData | object | なし | 検索結果メタデータ |
| total | long | なし | 検索条件に合致する総件数
ページング条件の影響は受けません。
|
| queryTasksResults | object | リスト | 検索結果 |
| assignee | string | なし | 担当者 |
| createTime | date | なし | 作成日時 |
| dueDate | date | なし | 期限日時 |
| executionId | string | なし | エグゼキューションID |
| formKey | string | なし | フォームキー |
| name | string | なし | タスク名 |
| priority | integer | なし | 優先度 |
| processDefinitionId | string | なし | プロセス定義ID |
| processDefinitionName | string | なし | プロセス定義名 |
| processDefinitionType | string | なし | 定義種別
プロセスの場合、PROCESS
ケースの場合、CASE
|
| processInstanceBusinessKey | string | なし | 業務キー |
| processInstanceId | string | なし | プロセスインスタンスID |
| processInstanceVariablesMap | map | なし | プロセスインスタンス変数マップ
key:変数名、value:値
|
| suspended | boolean | なし | 中断 |
| taskCategory | string | なし | カテゴリ |
| taskDefinitionKey | string | なし | タスク定義キー(アクティビティID) |
| taskId | string | なし | タスクID |
| taskVariablesMap | map | なし | タスク変数マップ
key:変数名、value:値
|
| variables | object | リスト | 変数 |
| name | string | なし | 変数名 |
| scope | string | なし | スコープ
globalとlocalがあります。
|
| type | string | なし | タイプ
string, integer, long, short, double, boolean, dateがあります。
|
| value | any | なし | 値 |