5.2.1.8.19. プロセスインスタンス検索¶
プロセスインスタンスを検索するタスクです。
5.2.1.8.19.1. 入力値¶
im_bpmQueryProcessInstances <object>
├─ excludeSubprocesses <boolean>
├─ finished <boolean>
├─ finishedAfter <date>
├─ finishedBefore <date>
├─ includeProcessVariables <boolean>
├─ involvedGroups <string[]>
├─ involvedUser <string>
├─ pagination <object>
│ ├─ limit <integer>
│ └─ offset <integer>
├─ processBusinessKey <string>
├─ processBusinessKeyLike <string>
├─ processDefinitionCategory <string>
├─ processDefinitionCategoryLike <string>
├─ processDefinitionId <string>
├─ processDefinitionKey <string>
├─ processDefinitionKeyLike <string>
├─ processDefinitionName <string>
├─ processDefinitionNameLike <string>
├─ processDefinitionType <string>
├─ processDefinitionVersion <integer>
├─ processInstanceId <string>
├─ processInstanceIds <string[]>
├─ sort <object>
│ ├─ order <string>
│ ├─ secondOrder <string>
│ ├─ secondSort <string>
│ └─ sort <string>
├─ startedAfter <date>
├─ startedBefore <date>
├─ startedBy <string>
├─ superProcessInstanceId <string>
├─ variables <object[]>
│ ├─ name <string>
│ ├─ operation <string>
│ ├─ type <string>
│ └─ value <any>
└─ withException <boolean>
項目名 | 必須/任意 | 型 | 配列/リスト | 説明 |
---|---|---|---|---|
im_bpmQueryProcessInstances | 任意 | object | なし | 検索条件 |
excludeSubprocesses | 任意 | boolean | なし | サブプロセスの除外 |
finished | 任意 | boolean | なし | 終了済み |
finishedAfter | 任意 | date | なし | 終了日時(以後) |
finishedBefore | 任意 | date | なし | 終了日時(以前) |
includeProcessVariables | 任意 | boolean | なし | プロセスインスタンス変数の情報を結果に含める |
involvedGroups | 任意 | string | リスト | 関係者グループ |
involvedUser | 任意 | string | なし | 関係者 |
pagination | 任意 | object | なし | ページング条件 |
limit | 任意 | integer | なし | 取得するデータの最大レコード数を設定してください(0以上。0の場合、offset以降の全件)。 |
offset | 任意 | integer | なし | 取得するデータの開始レコード位置を設定してください(1以上を設定してください)。 |
processBusinessKey | 任意 | string | なし | 業務キー |
processBusinessKeyLike | 任意 | string | なし | 業務キー(部分一致) |
processDefinitionCategory | 任意 | string | なし | カテゴリ |
processDefinitionCategoryLike | 任意 | string | なし | カテゴリ(部分一致) |
processDefinitionId | 任意 | string | なし | プロセス定義ID |
processDefinitionKey | 任意 | string | なし | プロセス定義キー |
processDefinitionKeyLike | 任意 | string | なし | プロセス定義キー(部分一致) |
processDefinitionName | 任意 | string | なし | プロセス定義名 |
processDefinitionNameLike | 任意 | string | なし | プロセス定義名(部分一致) |
processDefinitionType | 任意 | string | なし | 定義種別
以下のいずれかの値を設定してください。
プロセスの場合、PROCESS
ケースの場合、CASE
|
processDefinitionVersion | 任意 | integer | なし | プロセス定義バージョン |
processInstanceId | 任意 | string | なし | プロセスインスタンスID |
processInstanceIds | 任意 | string | リスト | プロセスインスタンスIDリスト |
sort | 任意 | object | なし | ソート条件 |
order | 任意 | string | なし | 第一ソートキーのソート順
以下のいずれかの値を設定してください(設定なしの場合、ソート順はasc(昇順)です)。
asc, desc
|
secondOrder | 任意 | string | なし | 第二ソートキーのソート順
以下のいずれかの値を設定してください(設定なしの場合、ソート順はasc(昇順)です)。
asc, desc
|
secondSort | 任意 | string | なし | 第二ソートキー
以下のいずれかの値を設定してください(第一ソートキーが設定されていない場合は無効です)。
businessKey, duration, endTime, processDefinitionId, processDefinitionKey, processDefinitionName, processDefinitionType, processInstanceId, startTime
|
sort | 任意 | string | なし | 第一ソートキー
以下のいずれかの値を設定してください。
businessKey, duration, endTime, processDefinitionId, processDefinitionKey, processDefinitionName, processDefinitionType, processInstanceId, startTime
|
startedAfter | 任意 | date | なし | 開始日時(以後) |
startedBefore | 任意 | date | なし | 開始日時(以前) |
startedBy | 任意 | string | なし | 開始ユーザコード |
superProcessInstanceId | 任意 | string | なし | 親プロセスインスタンスID |
variables | 任意 | 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 | なし | 値 |
withException | 任意 | boolean | なし | 例外を伴う
true : 障害中のプロセスインスタンスのみを検索対象とします。
false : 障害の有無を問わずに検索を行います。
設定しない場合はfalseとして検索を行います。
|
コラム
部分一致検索項目では、ワイルドカード(”%”、”_”など)を使用できます。ワイルドカードを使用しない場合、完全一致の検索条件として検索が実行されます。
例: キーワード を含む文字列を部分一致検索する場合
‘%キーワード%‘
コラム
第一ソートキーが指定されており、第一ソートキー、第二ソートキーでソート結果が一意とならない場合、processInstanceIdが暗黙ソートキーとして追加で指定されます。
5.2.1.8.19.2. 出力値¶
im_bpmQueryProcessInstances <object>
├─ metaData <object>
│ └─ total <long>
└─ queryProcessInstancesResults <object[]>
├─ deleteReason <string>
├─ durationInMillis <long>
├─ endActivityId <string>
├─ finishTime <date>
├─ isError <boolean>
├─ processBusinessKey <string>
├─ processDefinitionId <string>
├─ processDefinitionKey <string>
├─ processDefinitionName <string>
├─ processDefinitionType <string>
├─ processDefinitionVersion <integer>
├─ processInstanceId <string>
├─ startActivityId <string>
├─ startTime <date>
├─ startUserName <string>
├─ startedBy <string>
├─ superProcessInstanceId <string>
├─ variables <object[]>
│ ├─ name <string>
│ ├─ scope <string>
│ ├─ type <string>
│ └─ value <any>
└─ variablesMap <map>
項目名 | 型 | 配列/リスト | 説明 |
---|---|---|---|
im_bpmQueryProcessInstances | 任意 | object | なし |
metaData | object | なし | 検索結果メタデータ |
total | long | なし | 検索条件に合致する総件数
ページング条件の影響は受けません。
|
queryProcessInstancesResults | object | リスト | 検索結果 |
deleteReason | string | なし | 削除理由 |
durationInMillis | long | なし | 開始時間から終了時間までのミリ秒 |
endActivityId | string | なし | 終了アクティビティID |
finishTime | date | なし | 終了日時 |
isError | boolean | なし | 障害の有無
プロセスインスタンスが障害中の場合、true
プロセスインスタンスが障害中ではない場合、false
|
processBusinessKey | string | なし | 業務キー |
processDefinitionId | string | なし | プロセス定義ID |
processDefinitionKey | string | なし | プロセス定義キー |
processDefinitionName | string | なし | プロセス定義名 |
processDefinitionType | string | なし | 定義種別
プロセスの場合、PROCESS
ケースの場合、CASE
|
processDefinitionVersion | integer | なし | プロセス定義バージョン |
processInstanceId | string | なし | プロセスインスタンスID |
startActivityId | string | なし | 開始アクティビティID |
startTime | date | なし | 開始日時 |
startUserName | string | なし | 開始ユーザ名 |
startedBy | string | なし | 開始ユーザコード |
superProcessInstanceId | string | なし | 親プロセスインスタンスID |
variables | object | リスト | 変数 |
name | string | なし | 変数名 |
scope | string | なし | スコープ
globalとlocalがあります。
|
type | string | なし | タイプ
string, integer, long, short, double, boolean, dateがあります。
|
value | any | なし | 値 |
variablesMap | map | なし | 変数マップ
key:変数名、value:値
|