根据条件查询子规则对象的列表

POST

https://open.fxiaoke.com/cgi/crm/v2/data/query

接口说明：根据条件查询子规则对象的列表

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 包含

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://open.fxiaoke.com/cgi/crm/v2/data/query' \
--header 'Content-Type: application/json' \
--data-raw '{
    "corpAccessToken": "CORP_ACCESS_TOKEN",
    "corpId": "CORP_ID",
    "currentOpenUserId": "FSUID_XXXXXX",
    "data": {
        "dataObjectApiName": "GoalRuleDetailObj",
        "search_query_info": {
            "limit": 5,
            "offset": 0,
            "filters": [
                {
                    "field_name": "owner",
                    "field_values": [
                        "FSUID_7B8A3925E40FA68630C0D7E9C3XXXXXX"
                    ],
                    "operator": "IN"
                }
            ],
            "orders": [
                {
                    "fieldName": "payment_amount",
                    "isAsc": false
                }
            ],
            "fieldProjection": ["_id","name"]
        }
    }
  }'

响应示例

{
  "errorDescription": "success",
  "data": {
    "total": 4,
    "offset": 0,
    "dataList": [
      {
        "tenant_id": "文本值",
        "subgoal_comparison": "文本值",
        "package": "文本值",
        "last_modified_time": 1608263757480,
        "create_time": 1608263757480,
        "goal_rule_id": "5acc72c42848bddbe00193f4",
        "subgoal_name": "文本值",
        "subgoal_value": "xxxxxxxxx;ssssssssss",
        "last_modified_by": "FSUID_XXXXXXXXXXXXXX",
        "out_tenant_id": "文本值",
        "version": 11,
        "created_by": "FSUID_XXXXXXXXXXXXXX",
        "subgoal_fieldtype": "文本值",
        "is_deleted": true,
        "data_own_department": 999999,
        "object_describe_api_name": "文本值",
        "name": "文本值",
        "order_by": 11,
        "out_owner": "FSUID_XXXXXXXXXXXXXX",
        "_id": "5acc72c42848bddbe00193f4"
      }
    ]
  },
  "errorMessage": "OK",
  "errorCode": "0"
}

请求参数

Body 参数application/json

corpAccessToken

string

必需

企业应用访问公司合法性凭证

corpId

string

企业ID

必需

currentOpenUserId

string

必需

当前操作人OpenUserID

data

object

查询条件

必需

dataObjectApiName

string

必需

对象的api_name

find_explicit_total_num

boolean

可选

true->返回total,false->不返回total总数。默认true。设置为false可以加快接口响应速度

search_query_info

object

查询条件列表

必需

示例

返回响应

🟢200成功

application/json

Body

errorDescription

string

必需

对返回码的文本描述内容

data

object

查询结果

必需

total

integer

实际总记录数

必需

offset

integer

偏移量

必需

dataList

array [object {20}]

数据列表

必需

limit

string

查询数据的条数

必需

errorMessage

string

必需

对返回码的文本描述内容

errorCode

string

返回码

必需

获取工作圈回复对象描述接口

获取子规则对象描述接口