CPS数据查询 api

CPS数据查询

接口描述: CPS数据查询

接口地址:/api/metadata-app/v1/thirdParty/search/page

请求方式：POST

consumes:["application/json"]

produces:["*/*"]

请求示例：

普通查询：

{
    "body": {
        "start": 0,
        "length": 20,
        "templateApiName": "template_HQ5Fg",
        "useLike": true,
        "filter": {
            "field_XcRZz__c": "A4"
        },
        "sorts": [
            {
                "fieldApiName": "field_XcRZz__c",
                "sortType": "DESC"
            }
        ]
    }
}

日期范围查询：

{
    "body": {
        "start": 0,
        "length": 20,
        "templateApiName": "template_HQ5Fg",
        "filter": {
            "createdTime": {
                "startTime": 1670515200000,
                "endTime": 1670774399999
            }
        },
        "sorts": [
            {
                "fieldApiName": "field_XcRZz__c",
                "sortType": "DESC"
            }
        ]
    }
}

请求参数：

参数名称	参数说明	是否必须	数据类型	参考值
start	分页参数:起始位置（从0开始）	true	integer
length	分页参数:页长	true	integer
templateApiName	表单apiName	true	string
parentTemplateApiName	父表单apiNam（查询子表数据时使用）	false	string
parentId	父单据id（查询子表数据时使用）	false	string
fieldApiNames	字段apiName集合（为空则返回表单所有字段）	false	array[string]
useLike	是否模糊查询，默认false	false	boolean
filter	过滤条件	false	object[Map]
sorts	排序条件	false	array[SortField]

filter key为字段apiName，value为值，其中value的数据类型只接收以下类型中的一种：
1、String：文本，数字，编号，关联属性；
2、Number: 日期(Unix毫秒时间戳)；
3、List<String>：选项；
4、Map<String, Object>：关联对象/时间范围；

public class SortField{
    String fieldApiName; // 排序字段的apiName
    String sortType; // ASC正序、DESC倒序
}

响应示例:

{
    "code": 200,
    "message": "",
    "data": {
        "list": [{},{},{}],
        "start": 0,
        "length": 20,
        "recordsTotal": 9
    }
}

响应参数:

参数名称	参数说明	类型
code	响应码	integer
message	错误信息	string
data.list	数据列表	array[object]
data.start	起始位置	integer
data.length	页长	integer
data.recordsTotal	总数据条数	integer

响应状态:

状态码	说明
200	success
其他	error