Query Record¶

根据记录类型标识符等信息获取第三方记录数据。

请求格式¶

POST https://{api-gateway}/cds-record-service/v1.0/record?action=query

请求参数¶

名称	位置	必需/可选	数据类型	描述
orgId	Query	必需	String	记录所属的组织 ID。如何获取 orgId 信息>>
locale	Query	可选	String	中文：zh-CN, 英文：en-US, 日语：ja-JP，西班牙语：es-ES。默认为 en-US。
recordTypes	Body	必需	String	记录所属的记录类型的标识符，多个记录类型之间用英文逗号隔开。单次查询指定的记录类型数量不超过 100。如何获取 recordTypes 信息>>
fields	Body	必需	String	记录的字段，多个字段之间用英文逗号隔开。
filter	Body	可选	String	返回结果按记录的字段进行过滤。例如：[[{“field”:”field1”,”operator”:”>=”,”value”:”1”},{“field”:”field2”,”operator”:”<=”,”value”:”2”}],[{“field”:”field3”,”operator”:”==”,”value”:”3”}]]，该表达式含义为：(field1 >= 1 and field2 <= 2) or (field3=3)。
orderBy	Body	可选	String	返回结果按记录的字段进行排序。例如：[{“field”:”field1”,”order”:”ASC”}, {“field”:”field2”,”order”:”DESC”}]，该表达式含义为：一级排序为按 field1 升序、二级排序为按 field2 降序。
pageSize	Body	可选	Integer	分页查询时单页返回记录的条数，默认值为 100。
pageNo	Body	可选	Integer	分页查询时指定页码，默认值为 1。

返回内容类型¶

application/json; charset = UTF-8

响应参数¶

名称	必然/可能返回	数据类型	描述
recordType	必然返回	String	记录类型的标识符。
recordFields	必然返回	Object	记录的字段信息。
pagination	必然返回	Pagination 结构体	描述分页信息。参见 Pagination 结构体。

Pagination 结构体 ¶

名称	必然/可能返回	数据类型	描述
pageNo	必然返回	Integer	请求页数，从 1 开始。
pageSize	必然返回	Integer	每页的记录数。
totalSize	必然返回	Integer	记录总数。

返回码¶

参见通用数据服务 API 返回码.

示例¶

请求示例¶

#requestURI:
POST https://{api-gateway}/cds-record-service/v1.0/record?action=query&orgId=yourOrgId&locale=yourLocale
#requestBody:
{
    "recordTypes":"SR",
    "fields": "a,b,c",
    "filter": [[{"field":"field1","operator":">=","value":"1"},{"field":"field2","operator":"<=","value":"2"}],[{"field":"field3","operator":"==","value":"3"}]],
    "orderBy": [{"field":"field1","order":"ASC"}, {"field":"field2","order":"DESC"}],
    "pageSize": 100,
    "pageNo": 1
}

返回示例¶

{
    "data": [
        {
            "recordType":"SR",
            "field1": "",
            "field2":"",
            "field3":""
        },
        {
            "recordType":"SR",
            "field1": "",
            "field2":"",
            "field3":""
        }
    ],
   "pagination": {
         "pageNo": 1,
         "pageSize": 10,
         "totalSize": 100
    },
    "code": 0,
    "msg": "OK",
    "traceId": "1234567890abcdefghijkl0987654321"
}