R4180: Criteria JSON for Process-Instance / Workitem Search API

プロセス検索の API (/API/OR/ProcessInstance/list など) やタスク検索の API (/API/OR/Workitem/list など) で criteria パラメータに指定する検索条件の JSON です。

検索条件 / Search Conditions

Key	Type	Description
processModelInfoId	Number	アプリID 全てのアプリを対象に検索する場合は、指定しないか、「-1」を指定します。
processInstanceState	Array<String>	プロセス状態次の3つの状態から指定します。複数指定することもできます。未指定の場合、全ての状態が検索されます。 `STARTED` Running Processes / 未終了 `ENDED` Processes completed successfully / 終了 `FAILED` Processes completed unsuccessfully (Canceled, etc.) / 異常終了
processInstanceId (Workitem only)	Number	プロセスID 指定されたプロセスIDのタスクを検索します。
processInstanceTitle	Array<String>	プロセスの件名指定された文字列をプロセスの件名に含むタスクを検索します。複数指定することもできます。
processInstanceStartDateFrom	String	プロセス開始日（From）指定日（時）以降に開始されたプロセスを検索します。絶対指定に加え、相対指定も可能です。指定形式の例: `Date: 2001-01-01 Datetime: 2001-02-03 04:30 Variable: #now, #today.addDays(2)`
processInstanceStartDateTo	String	プロセス開始日（To）指定日（時）以前に開始されたプロセスを検索します。絶対指定に加え、相対指定も可能です。
processInstanceEndDateFrom	String	プロセス終了日（From）指定日（時）以降に開始されたプロセスを検索します。絶対指定に加え、相対指定も可能です。未終了のプロセスは含まれません。
processInstanceEndDateTo	String	プロセス終了日（To）指定日（時）以降に開始されたプロセスを検索します。絶対指定に加え、相対指定も可能です。未終了のプロセスは含まれません。
processInstanceInitQuserId	String	プロセス開始ユーザユーザID か `#me` で指定します。指定されたユーザで開始されたプロセスを検索します。
processInstanceInitQgroupId	String	プロセス開始組織組織ID で指定します。指定された組織で開始されたプロセスを検索します。
tokenNodeNumber	String	ノード番号（工程の番号）指定された工程にトークンがあるプロセス／タスクを検索します。検索対象は、ヒューマンタスク、タイマー中間イベント、受信タスク (HTTP／フォーム／Webhook)です。
nodeNumber (Workitem only)	Number	ノード番号（工程の番号）指定された工程（タスク）を検索します。
state (Workitem only)	Array<String>	タスク状態次の5つの状態から指定します。複数指定することもできます。未指定の場合、全ての状態が検索されます。 `OFFERED` /オファー中 `ALLOCATED` /割り当て済み `STARTED` /処理中 `ENDED` /処理完了 `FAILED` /処理失敗
allocatedQuserId (Workitem only)	String	処理担当者ユーザID か `#me` で指定します。指定されたユーザが担当者となっているタスクを検索します。
offerDateFrom (Workitem only)	String	タスク発生日（From）指定日（時）以降に生成されたタスクを検索します。絶対指定に加え、相対指定も可能です。指定形式の例: `Date: 2001-01-01 Datetime: 2001-02-03 04:30 Variable: #now, #today.addDays(2)`
offerDateTo (Workitem only)	String	タスク発生日（To）指定日（時）以前に生成されたタスクを検索します。絶対指定に加え、相対指定も可能です。
endDateFrom (Workitem only)	String	タスク処理完了日（From）指定日（時）以降に処理完了されたタスクを検索します。絶対指定に加え、相対指定も可能です。
endDateTo (Workitem only)	String	タスク処理完了日（To）指定日（時）以前に処理完了されたタスクを検索します。絶対指定に加え、相対指定も可能です。
timeLimitDateFrom (Workitem only)	String	タスク締切（From）締切が指定日（時）以降であるタスクを検索します。絶対指定に加え、相対指定も可能です。
timeLimitDateTo (Workitem only)	String	タスク締切（To）締切が指定日（時）以前であるタスクを検索します。絶対指定に加え、相対指定も可能です。
starred	Boolean	スタープロセスへのスターの有無で検索します。未指定の場合、スターの有無に関わらず検索されます。 `true` starred `false` unstarred
data	Array<Object>	データ項目に関する検索条件アプリを特定してデータ項目に関する検索条件（フィルタ）を追加する際に指定します。オブジェクト例: `{"type": "decimal", "number": 0, "method":"less-equals", "value":"10"}`
data[].type	String	データ型検索条件に指定するデータ項目のデータ型を指定します。（テーブル型は指定できません）データ型ごとの詳細はこちら
data[].number	Number	データ定義番号検索条件に指定するデータ項目のデータ定義番号を指定します。
data[].method	String	データ型ごとに指定できる条件データ型ごとの詳細はこちら
data[].value	String	検索条件に指定する値 `type` や `method` に対応した形式の値を指定します。データ型ごとの詳細はこちら
fields	Array<Object>	レスポンスに含めるデータ項目指定されたデータ項目のみが検索結果に含まれます。アプリを特定した検索でのみ有効です。オブジェクト例: `{"type": "decimal", "number": 0}`
fields[].type	String	データ型レスポンスに含めるデータ項目のデータ型を指定します。データ型ごとの詳細はこちら
fields[].number	Number	データ定義番号レスポンスに含めるデータ項目のデータ定義番号を指定します。
sortProperty	String	ソート項目レスポンスのデータをソートする項目を指定します。未指定の場合、プロセス検索では「プロセス開始日」、タスク検索では「タスク発生日」でソートされます。 `processInstanceTitle` 件名 / Title `processInstanceStartDatetime` プロセス開始日 / Process Start Datetime `processInstanceEndDatetime` プロセス終了日 / Process End Datetime `offerDatetime` タスク発生日 / Task Offered Time (Workitem Only) `endDatetime` タスク処理完了日 / Task End Time (Workitem Only) `timeLimitDatetime` タスク締切 / Deadline of Task (Workitem Only) `allocatedQuserId` 処理担当者のユーザID / ID of allocated User (Workitem Only) `nodeName` 工程名 / Task name (Workitem Only)
sortDirection	String	ソート順ソート項目をソートする順（昇順/降順）を指定します。未指定の場合、「降順」でソートされます。 `ASC` 昇順 / ascending `DESC` 降順 / descending

* Workitem Only: タスク検索（Workitem Search）でのみ指定できる Key や値を表します

データ型ごとのdata[].type/fields[].typeの値、および検索時に指定できるフィルタ条件（data[].method/data[].value）について記載します。

データ型	`type`	`method`	説明
文字型	`string`	`empty`	空である
		`not-empty`	空でない
		`contains`	`value` で指定された文字列を含む
数値型	`decimal`	`equals`	`value` で指定された数と等しい
		`greater-equals`	`value` で指定された数以上
		`less-equals`	`value` で指定された数以下
選択型	`select`	`selected`	`value` で指定された選択肢ID（の選択肢）が選択されている
日付型	`date`	`equals`	`value` で指定された日付と等しい
		`after-equals`	`value` で指定された日付以降
		`before-equals`	`value` で指定された日付以前
日時型	`datetime`	`equals`	`value` で指定された日時と等しい
		`after-equals`	`value` で指定された日時以降
		`before-equals`	`value` で指定された日時以前
ファイル型	`file`	`contains`	ファイル名に `value` で指定された文字列を含む
ユーザ型	`quser`	`equals`	`value` に指定された `#me` またはユーザ ID と等しい
組織型	`qgroup`	`equals`	`value` に指定された組織 ID　と等しい
テーブル型	`list`	N/A	（`list` は`fields[].type`にのみ指定できます）
掲示板型	`discussion`	`empty`	空である
		`not-empty`	空でない
		`contains`	`value` で指定された文字列を含む
*日付や日時を指定する際の書式例日付絶対指定：2001-01-23 相対指定：#today.addDays(2) 日時絶対指定：2001-01-23 04:30 相対指定：#now.addDays(2).getFirstTimeInDate().addHours(9)

サンプル / Sample Query

指定する条件

アプリID：123
プロセス開始日：2022年1月1日〜2022年1月31日
プロセス状態：未終了
数値型（0）の値が 10 以下
表示するデータ項目
- 数値型、データ定義番号: 0
- ファイル型、データ定義番号: 5
検索結果を「開始日」の「降順」でソートする

{
  "processModelInfoId":123,
  "processInstanceStartDateFrom":"2022-01-01",
  "processInstanceStartDateTo":"2022-01-31",
  "processInstanceState":["STARTED"],
  "data":[
    {
      "type":"decimal",
      "number":0,
      "method":"less-equals",
      "value":"10"
    }
  ],
  "fields":[
    {
      "type":"decimal",
      "number":0
    },
    {
      "type":"file",
      "number":5
    }
  ],
  "sortProperty":"processInstanceStartDatetime",
  "sortDirection":"DESC"
}

検索条件 / Search Conditions

サンプル / Sample Query

関連ドキュメント

このセクションの記事

Support Site 内リンク

検索条件 / Search Conditions

サンプル / Sample Query

関連ドキュメント

このセクションの記事

Support Site 内リンク

関連記事