查询对象数据列表

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

注意：当字段是关联字段类型时，关联对象的主属性名称字段未：{关联字段ApiName}__r，例如，对象中的关联字段：account_id，它对应的关联对象的主属性字段为：account_id__r

请求示例

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": "PaymentObj",
        "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"]
        }
    }
}'

响应示例

200 - 成功 - 成功示例

{
    "data": {
        "total": 4,
        "offset": 0,
        "dataList": [
            {
                "payment_time": 1517328000000,
                "remark": "测试更新02",
                "account_id__r": "测试",
                "is_deleted": false,
                "attachment": [],
                "order_data_id": "974789b4d13040fcbb9d0ae35cxxxxxx",
                "total_num": 4,
                "owner_department": "董事会",
                "owner": [
                    "FSUID_0253C6D7FC0E3A2CBB19F336CEXXXXXX"
                ],
                "lock_status": "0",
                "last_modified_time": 1519986766107,
                "create_time": 1519985373616,
                "payment_term": "2",
                "life_status": "normal",
                "payment_amount": "300.00",
                "last_modified_by": [
                    "FSUID_0253C6D7FC0E3A2CBB19F336CEXXXXXX"
                ],
                "created_by": [
                    "FSUID_7B8A3925E40FA68630C0D7E9C3XXXXXX"
                ],
                "record_type": "default__c",
                "notification_time": 1517241600000,
                "account_id": "2d58af2dbb4d4ecd931e80ef18xxxxxx",
                "name": "20180302-000004",
                "_id": "5a9922dd742c2ff572xxxxxx",
                "order_id": "20180302-000002"
            },
            {
                "payment_time": 1521561600000,
                "account_id__r": "测试",
                "is_deleted": true,
                "attachment": [],
                "order_data_id": "974789b4d13040fcbb9d0ae35cxxxxxx,cff4ca67f38c49639df64f50d3xxxxxx",
                "total_num": 4,
                "owner_department": "董事会",
                "owner": [
                    "FSUID_7B8A3925E40FA68630C0D7E9C3XXXXXX"
                ],
                "lock_status": "0",
                "last_modified_time": 1519984004508,
                "create_time": 1519978401106,
                "life_status": "invalid",
                "payment_amount": "20.00",
                "last_modified_by": [
                    "FSUID_0253C6D7FC0E3A2CBB19F336CEXXXXXX"
                ],
                "created_by": [
                    "FSUID_7B8A3925E40FA68630C0D7E9C3XXXXXX"
                ],
                "record_type": "default__c",
                "account_id": "2d58af2dbb4d4ecd931e80ef18xxxxxx",
                "name": "20180302-000002",
                "_id": "5a9907a1f125ae0a1axxxxxx",
                "order_id": "20180302-000002,20180302-000001"
            }
        ],
        "limit": 5
    },
    "errorCode": 0,
    "errorMessage": "OK",
    "errorDescription": "success"
}

请求参数

Body 参数application/json

corpAccessToken

string

必需

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

corpId

string

企业ID

必需

currentOpenUserId

string

必需

当前操作人OpenUserID

data

object (date)

查询条件

必需

search_query_info

object

查询条件列表

必需

dataObjectApiName

string

必需

对象的api_name

find_explicit_total_num

boolean

可选

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

示例

返回响应

🟢200成功

application/json

Body

data

object (返回date)

查询结果

必需

total

integer

实际总记录数

必需

offset

integer

偏移量

必需

dataList

array [object {29}]

数据列表

必需

limit

string

查询数据的条数

必需

errorCode

integer

返回码

必需

errorMessage

string

必需

对返回码的文本描述内容

errorDescription

string

必需

对返回码的文本描述内容

🟢200错误

修改于 2022-03-07 02:50:16

更新对象数据

根据Id查询数据详情