Description

Query a list of process instance objects based on specified conditions.

Request Specification

Request Method: POST + application/json

Request Path: https://${Cloud Domain}/cgi/crm/v2/data/query?thirdTraceId=${Random String}

Request Headers: Refer to Common Parameters

Request Parameters

Parameter	Type	Required	Description
includeNull	Boolean	No	Whether to include null fields. false: not returned, true: returned. Default is false
data	Map	Yes	Data map
dataObjectApiName	String	Yes	Object's API name (fixed value: BpmInstance)
find_explicit_total_num	Boolean	No	Whether to return the total count (true -> returns total; false -> does not return total count. Default: true. Setting to false improves response speed)
search_query_info	Map	Yes	Query Condition Specification
limit	Int	Yes	Pagination limit (max value: 100)
offset	Int	Yes	Offset (starts from 0; must be a multiple of limit)
filters	List	Yes	Filter conditions list
field_name	String	Yes	Field name
field_values	List[String]	Yes	Field values
operator	String	Yes	Operator (see [operator parameter details] below)
orders	List	Yes	Query conditions
fieldName	String	Yes	Field name
isAsc	Boolean	Yes	Sort order (true: ascending; false: descending)
fieldProjection	List[String]	Yes	Return field list (values correspond to the object's apiName)

Operator Parameter Details

Directly use query conditions from the object list page. Refer to How to Retrieve List Query Conditions.

Parameter	Meaning	Description	Parameter	Meaning	Description
EQ	Equal		N	Not Equal	Can query null values
GT	Greater Than		GTE	Greater Than or Equal
LT	Less Than		LTE	Less Than or Equal
LIKE	Contains		NLIKE	Does Not Contain
IS	Is Null		ISN	Is Not Null
IN	Belongs To		NIN	Does Not Belong To
BETWEEN	Between		NBETWEEN	Not Between
STARTWITH	Starts With		ENDWITH	Ends With
HASANYOF	Has Overlapping Elements		NHASANYOF	No Overlap

Request Example

{  
  "includeNull": true,  
  "data": {  
    "find_explicit_total_num": "",  
    "search_query_info": {  
      "limit": 5.0,  
      "orders": [  
        {  
          "fieldName": "payment_amount",  
          "isAsc": false  
        }  
      ],  
      "fieldProjection": [  
        "_id",  
        "name"  
      ],  
      "filters": {  
        "operator": "IN",  
        "field_name": "owner",  
        "field_values": [  
          "FSUID_7B8A3925E40FA68630C0D7E9C3XXXXXX"  
        ]  
      }  
    },  
    "dataObjectApiName": "BpmInstance"  
  },  
  "offset": 0.0,  
}

Response Parameters

Parameter	Type	Description
traceId	string	Unique request ID
errorDescription	string	Error description
data	Map	Parameter details (call Query Object Description API for specifics)
errorMessage	string	Error message
errorCode	Int	Error Codes

Response Example

{  
  "traceId": "E-O.827xxxxxx",  
  "errorDescription": "success",  
  "data": {  
    "created_by__r": {},  
    "lock_status": "0",  
    "is_deleted": false,  
    "create_time": 1612247399397,  
    "name": "xxxxxx",  
    "_id": "69046aexxxxxxx"  
  },  
  "errorMessage": "OK",  
  "errorCode": 0  
}

Notes

• Do not use the message field in the response for logical judgments, as errorMessage may change.
• If a field's value is empty, it will not be returned.

• Operator Parameter Details

  The response corresponds to object-related fields. For details, refer to Process Instance Object Field Specifications. The following parameters are unique to this API. For error codes, see Global Error Codes.

Parameter	Meaning	Parameter	Meaning
EQ	=	GT	>
LT	<	GTE	>=
LTE	<=	N	<>
LIKE	LIKE	NLIKE	NOT LIKE
IS	IS	ISN	IS NOT
IN	IN	NIN	NOT IN
BETWEEN	BETWEEN	NBETWEEN	NOT BETWEEN
STARTWITH	LIKE%	ENDWITH	%LIKE
CONTAINS	Array Contains