描述

根据条件查询流程实例对象的列表

请求说明

请求方式 ：POST + application/json

请求路径 ：https://${填入所在云的域名}/cgi/crm/v2/data/query?thirdTraceId=${随机字符串}

请求头填写 ：参考公共参数填写

请求参数

参数	类型	是否必填	说明
includeNull	Boolean	否	是否包含 null 字段,false:不返回,true:返回，不传默认为false
data	Map	是	数据map
dataObjectApiName	String	是	对象的api_name，固定取值：BpmInstance
find_explicit_total_num	Boolean	否	是否返回总数(true->返回total,false->不返回total总数。默认true。设置为false可以加快接口响应速度)
search_query_info	Map	是	查询条件说明
limit	Int	是	分页条数(最大值为100)
offset	Int	是	偏移量(从0开始、数值必须为limit的整数倍)
filters	List	是	过滤条件列表
field_name	String	是	字段名
field_values	List[String]	是	字段值
operator	String	是	操作符，详细见下方[operator参数说明]
orders	List	是	查询条件
fieldName	String	是	字段名
isAsc	Boolean	是	是否升序(如果是true，按照升序排列，如果是false，则按照倒序排列)
fieldProjection	List[String]	是	返回字段列表,取值对象字段中的apiName
data	Map	是
dataObjectApiName	String	是	对象的api_name
find_explicit_total_num	Boolean	是	true:返回total,false:不返回total总数。默认true。设置为false可以加快接口响应速度
search_query_info	Map	是	查询条件说明
limit	Int	是	获取数据条数, 最大值为100
filters		否	过滤条件列表
field_name	String	是	字段名
field_values	List	是	取值范围
operator	String	是	支持操作
orders	List	否	排序
fieldName	String	是	字段名
isAsc	Boolean	是	如果是true，按照升序排列，如果是false，则按照倒序排列
fieldProjection	List	是	返回字段列表
offset	Int	是	偏移量，从0开始、数值必须为limit的整数倍

operator 参数说明

可以直接使用对象列表页面中的查询条件，查看如何获取列表中的查询条件

参数	参数含义	说明	参数	参数含义	说明
EQ	等于		N	不等于	可以查出空值
GT	大于		GTE	大于等于
LT	小于		LTE	小于等于
LIKE	包含		NLIKE	不包含
IS	为空		ISN	不为空
IN	属于		NIN	不属于
BETWEEN	介于		NBETWEEN	不介于
STARTWITH	开始于		ENDWITH	结束于
HASANYOF	有重叠元素		NHASANYOF	没有重叠

请求示例

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

返回参数

参数	类型	说明
traceId	string	请求唯一ID
errorDescription	string	错误描述
data	Map	参数详细信息请调用查询对象描述接口
errorMessage	string	错误信息
errorCode	Int	查看错误码

返回示例

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

注意事项

• 不能使用返回值的message字段做逻辑判断，errorMessage会有变化；
• 如果字段的值为空，则不返回这个字段;

• operator参数说明

此接口对应的返回值即为对象相关字段，详情见关于流程实例对象对象字段的说明下列参数为本接口特有返回值 返回错误代码请参见。全局返回错误码 |参数 |参数含义 |参数 |参数含义 | |:--| |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 包含 | | |