Deprecated Interface - Not Recommended for Use!!!

Description

Query ERP object list

Request Specification

Method: POST + application/json

Endpoint: https://${cloud domain}/cgi/crm/erp/data/list?thirdTraceId=${Random String}

Request Parameters

Parameter	Type	Required	Remarks
corpAccessToken	String	Yes	Enterprise application access token for company validation
corpId	String	Yes	Enterprise ID
currentOpenUserId	String	Yes	Current operator's OpenUserID
data	Object	Yes	Query conditions
data.dataObjectApiName	String	Yes	Object's api_name
data.search_query_info	Object	Yes	Query conditions list
data.search_query_info.limit	int	Yes	Number of records to fetch, maximum value is 100
data.search_query_info.offset	int	Yes	Offset value, must start from 0 and be an integer multiple of limit
data.search_query_info.filters	List	Yes	Filter conditions list
data.search_query_info.filters.field_name	String	Yes	Field name
data.search_query_info.filters.field_values	List	Yes	Value range
data.search_query_info.filters.operator	String	Yes	Supported operators
data.search_query_info.orders	List	Yes	Sorting
data.search_query_info.orders.fieldName	String	Yes	Field name
data.search_query_info.orders.isAsc	boolean	Yes	true for ascending order, false for descending order
data.search_query_info.fieldProjection	List	No	Fields to return
data.find_explicit_total_num	Boolean	No	true->returns total count, false->doesn't return total. Default is true. Setting false can improve response speed

Operator Parameter Description

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

Request Example

{
    "corpAccessToken": "98747229F3B372F9F2120789FC55ED6F",
    "corpId": "FSCID_902A6E6771D07046EB44E20025355DDB",
    "currentOpenUserId": "FSUID_C6384C8A5942F92C691BC1339D367877",
    "data": {
        "dataObjectApiName": "ErpStockObj",
        "search_query_info": {
            "offset": 0,
            "limit": 100,
            "filters": [
                {
                    "field_name": "owner",
                    "field_values": [
                        "FSUID_C6384C8A5942F92C691BC1339D367877"
                    ],
                    "operator": "EQ"
                }
            ],
            "orders": [
                {
                    "fieldName": "last_modified_time",
                    "isAsc": true
                }
            ]
        }
    }
}

Response Parameters

Parameter	Required	Description
data	Yes	Query results
data.total	Yes	Actual total record count
data.offset	Yes	Offset value
data.limit	Yes	Number of records queried
data.dataList	Yes	Data list
errorCode	Yes	Return code
errorMessage	Yes	Text description of the return code
errorDescription	Yes	Text description of the return code

Note: When a field is a relationship field type, the primary attribute name field of the related object is: {relationship field ApiName}__r. For example, if the relationship field in the object is: account_id, its corresponding primary attribute field of the related object is: account_id__r

Response Example

{
    "data": {
        "total": 4,
        "offset": 0,
        "dataList": [
            {
                "payment_time": 1517328000000,
                "remark": "Test update 02",
                "account_id__r": "Test",
                "is_deleted": false,
                "attachment": [],
                "order_data_id": "974789b4d13040fcbb9d0ae35cxxxxxx",
                "total_num": 4,
                "owner_department": "Board of Directors",
                "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": "Test",
                "is_deleted": true,
                "attachment": [],
                "order_data_id": "974789b4d13040fcbb9d0ae35cxxxxxx,cff4ca67f38c49639df64f50d3xxxxxx",
                "total_num": 4,
                "owner_department": "Board of Directors",
                "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"
}

Notes

• Do not use the message field in the response for logical judgment, as errorMessage may change;