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

The JSON of the search condition to be specified in the criteria parameter of the Case search API (such as/API/OR/ProcessInstance/list) or workitem API (such as /API/OR/Workitem/list).

Search Conditions

Key	Type	Description
processModelInfoId	Number	IDs of Apps Specify nothing or "-1" if you wish to search all Apps.
processInstanceState	Array<String>	The status of Cases Selected from below. Possible to specify multiple If not specified all states will be searched. `STARTED` Running Cases `ENDED` Cases completed successfully `FAILED` Cases completed unsuccessfully (cancelled, etc.)
processInstanceId (Workitem only)	Number	Case ID When specified searches Cases with the specified ID.
processInstanceTitle	Array<String>	Case Title When specified searches Cases with titles that include the specified value. Possible to specify multiple.
processInstanceStartDateFrom	String	Case Start Date (From) When specified searches Cases that were started on or after the specified value. In addition to absolute specification, relative specification is possible. E.g. `Date: 2001-01-01 Datetime: 2001-02-03 04:30 Variable: #now, #today.addDays(2)`
processInstanceStartDateTo	String	Case Start Date (To) When specified searches Cases that were started on or before the specified value. In addition to absolute specification, relative specification is possible.
processInstanceEndDateFrom	String	Case End Date (From) When specified searches Cases that were completed on or after the specified value. In addition to absolute specification, relative specification is possible. Does not include running Cases.
processInstanceEndDateTo	String	Case End Date (To) When specified searches Cases that were completed on or before the specified value. In addition to absolute specification, relative specification is possible. Does not include running Cases.
processInstanceInitQuserId	String	Case Start User Specify with ID of User or `#me`. When specified searches Cases started by the specified user.
processInstanceInitQgroupId	String	Case Start Organization Specify with ID of Organization. When specified searches Cases started by the specified organization.
tokenNodeNumber	Number	Number of Node (Task) retaining the token. When specified searches the specified Human Task, Timer Intermediate Event or Receive Task (form/HTTP/Webhook).
nodeNumber (Workitem only)	Number	Number of Node (Task). When specified searches the specified Task.
state (Workitem only)	Array<String>	The status of Tasks Selected from below. Possible to specify multiple If not specified all states will be searched. `OFFERED` Offered `ALLOCATED` Unprocessed `STARTED` Processing `ENDED` Finished `FAILED` Abended
allocatedQuserId (Workitem only)	String	Operator Specify with ID(Number) of User or `#me`. When specified searches Tasks allocated to the specified user.
offerDateFrom (Workitem only)	String	Task Offered Date (From) When specified searches Tasks that were started on or after the specified value. In addition to absolute specification, relative specification is possible. E.g. `Date: 2001-01-0 Datetime: 2001-02-03 04:30 Variable: #now, #today.addDays(2)`
offerDateTo (Workitem only)	String	Task Offered Date (To) When specified searches Tasks that were started on or before the specified value. In addition to absolute specification, relative specification is possible.
endDateFrom (Workitem only)	String	Task End Date (From) When specified searches Tasks that were finished on or after the specified value. In addition to absolute specification, relative specification is possible.
endDateTo (Workitem only)	String	Task End Date (To) When specified searches Tasks that were finished on or before the specified value. In addition to absolute specification, relative specification is possible.
timeLimitDateFrom (Workitem only)	String	Task Deadline (From) When specified searches Tasks whose deadlines were on or after the specified value. In addition to absolute specification, relative specification is possible.
timeLimitDateTo (Workitem only)	String	Task Deadline (To) When specified searches Tasks whose deadlines were on or before the specified value. In addition to absolute specification, relative specification is possible.
starred	Boolean	Starred Specifies the star of Cases to be searched. When not specified both starred and unstarred will be searched. `true` starred `false` unstarred
data	Array<Object>	Data Items Specify while an App is specified to add filtering conditions related to Data Items. E.g. Object `{"type": "decimal", "number": 0, "method":"less-equals","value":"10"}`
data[].type	String	Data-type Specifies the Data-type of the Data item to be specified in the filtering condition. (Table-type cannot be specified) Click here for details on each Data-type
data[].number	Number	Data Definition Number Specifies the Data Definition Number of the Data Item to be specified in the filtering condition.
data[].method	String	Conditions that can be specified for each Data-type Click here for details on each Data-type
data[].value	String	Specifies the value in the search condition Specify a value in the format corresponding to `type` or `method`. Click here for details on each Data-type
fields	Array<Object>	Includes the value in the specified Data Items in the response Only the specified Data Items will be included in the search results. Only valid for App-specific searches. E.g. Object: `{"type": "decimal", "number": 0}`
fields[].type	String	Data-type Specifies the Data-type of the Data Item to be included in the response. Click here for details on each Data-type
fields[].number	Number	Data Definition Number Specifies the Data Definition Number of the Data Item to be included in the response.
sortProperty	String	Sort Item Specifies the item to sort the response data. If not specified it will be sorted by Case Start Date in Case search and by Task Offered Date in Task search. `processInstanceTitle` Title `processInstanceStartDatetime` Case Start Datetime `processInstanceEndDatetime` Case End Datetime `offerDatetime` Task Offered Time (Workitem only) `endDatetime` Task End Time (Workitem only) `timeLimitDatetime` Deadline of Task (Workitem only) `allocatedQuserId` ID of allocated User (Workitem only) `nodeName` Task name (Workitem only)
sortDirection	String	Sort Order Specifies the order in which the items are sorted (ascending/descending). If not specified it will be sorted in descending order. `ASC` ascending `DESC` descending

* Workitem Only: Represents a Key or value that can only be specified in Task search (Workitem Search).

Below is the value to be set in data[].type/fields[].type for respective Data-type, and the filter condition (data[].method/data[].value) that can be specified in search.

Data-type	`type`	`method`	Description
String-Type	`string`	`empty`	No string has been input
		`not-empty`	Any string has been input
		`contains`	Contains the string specified in `value`
Numeric-Type	`decimal`	`equals`	Equals to the number (as string) specified in `value`
		`greater-equals`	Greater than or equals to the number (as string) specified in `value`
		`less-equals`	Less than or equals to the number (as string) specified in `value`
Select-Type	`select`	`selected`	The Choice ID specified by `value` is selected
Date-Type	`date`	`equals`	Equals to the date specified in `value`
		`after-equals`	Later than or equals to the date specified in `value`
		`before-equals`	Earlier than or equals to the date specified in `value`
Datetime-Type	`datetime`	`equals`	Equals to the date and time specified in `value`
		`after-equals`	Later than or equals to the date and time specified in `value`
		`before-equals`	Earlier than or wquals to the date and time specified in `value`
File-Type	`file`	`contains`	Contains the string specified in `value` in its filename
User-Type	`quser`	`equals`	Equals to `#me` or the User ID specified in `value`
Organization-Type	`qgroup`	`equals`	Equals to the Organization ID specified in `value`
Table-Type	`list`	N/A	`list` can be specified only in `field[].type`
Discussion-Type	`discussion`	`empty`	No string has been input
		`not-empty`	Any string has been input
		`contains`	Contains the string specified in `value`
*Format example for specifying a date or date and time Date Absolute：2001-01-23 Relative：#today.addDays(2) Datetime Absolute：2001-01-23 04:30 Relative：#now.addDays(2).getFirstTimeInDate().addHours(9)

Example Query

Conditions to be specified

App ID：123
Case Start Date: between the 1st and 31st of January, 2022
Case State: running
The value in the Numeric-type (0) is less than or equals 10
Data Items to be included
- Numeric-type, Data Definition Number: 0
- File-type, Data Definition Number: 5
Sort the search result by descending order of Start Date

{
  "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

Example Query

Related documents

Articles in this section

In-site Links

Search Conditions

Example Query

Related documents

Articles in this section

In-site Links

Related articles