查询单表数据

接口总述

栏目 说明 备注
所属服务/应用 lcp-data
接口地址 /v1/data/read/table
请求方式 POST
请求数据格式 JSON
返回数据格式 JSON
鉴权方式 IAC/JWT

请求头信息

参数名 数据类型 是否必填 说明 备注
x-app-id String 是 应用ID 也可以放入路径参数中
x-tenant-id String 是 租户ID 也可以放入路径参数中
x-auth-token String 否 JWT鉴权token
x-iac-token String 否 IAC鉴权token

入参说明

参数名 数据类型 是否必填 说明 备注
tableName String 是 表名
returnColumns List< String > 否 指定返回字段，默认返回所有字段
filters List< ParamsGroup > 否 查询条件
sortBy String 否 排序字段和规则
keyType String 否 指定返回字段名的命名方式 可选值：UPPER(大写)/LOWER(小写)/CAMEL(驼峰)，默认为UPPER
page Number 否 页码，默认为1
pageSize Number 否 分页大小，默认为20

ParamsGroup说明

参数名 数据类型 是否必填 说明 备注
andOr String 否 逻辑运算符 可选值：and/or，默认为and
paramsList List< Params > 是 查询条件列表

Params说明

参数名 数据类型 是否必填 说明 备注
attrApi String 是 属性编码（字段名） 大写
value Object 是 属性值
operator String 否 关系运算符 可选值：=/!=/>/>=/</<=/in/like，默认为=或in
andOr String 否 逻辑运算符 可选值：and/or，默认为and

入参示例

{
    "tableName": "LCP_PAGE_COMPONENTS",
    "filters": [
        {
            "paramsList": [
                {
                    "attrApi": "IS_DELETED",
                    "value": "0"
                }
            ]
        },
        {
            "paramsList": [
                {
                    "attrApi": "APPLY_TYPE",
                    "value": "form",
                    "operator": "like"
                },
                {
                    "attrApi": "CODE",
                    "value": "MULTI",
                    "andOr": "or",
                    "operator": "like"
                }
            ]
        }
    ],
    "sortBy": "CRT_TIME desc",
    "page": 1,
    "pageSize": 3,
    "keyType": "CAMEL"
}

出参说明

参数名 数据类型 是否必填 说明 备注
status String 是 状态码
message String 是 状态信息
data ObjPageResp 是

ObjPageResp说明

参数名 数据类型 是否必填 说明 备注
pagination Map<String, Object> 是 分页信息
content List<Map<String, Object>> 否 数据 字段名按入参keyType指定的方式命名

出参示例

{
    "status": "0",
    "message": "success",
    "data": {
        "pagination": {
            "total": 5,
            "totalPages": 2,
            "pageSize": 3,
            "page": 1
        },
        "content": [
            {
                "applyType": "form,table",
                "code": "COMMONSELECTCOMPONENT",
                "dversionNo": 2,
                "icon": "MenuOutlined",
                "crtName": "叶端旺",
                "updName": "叶端旺",
                "crtTime": 1661395312000,
                "updHost": "172.17.228.45",
                "label": "通用选择",
                "crtUser": "huangyunzhen",
                "lifecycle": "PRELIMINARY",
                "classId": "b6b466cd03804cd4812a66fcb9f6cfc2",
                "isDeleted": "0",
                "updUser": "yeduanwang",
                "exposesKey": "CommonSelectConfigs",
                "updTime": 1671508401316,
                "isEnabled": "1",
                "appId": "1269620726624013b98cf4baadaa759f",
                "tenantId": "c518f53d-b405-4111-afe1-5c082b284971",
                "crtHost": "172.17.228.45",
                "id": "2eb974e091ee41f0a8e29edbb711c8b9",
                "sourceName": "cir-csb-generator",
                "groupCode": "custom"
            },
            {
                "applyType": "table,form",
                "code": "MULTI_ORGANIZTION",
                "dversionNo": 2,
                "crtName": "叶端旺",
                "updName": "叶端旺",
                "crtTime": 1660036330000,
                "updHost": "172.17.228.45",
                "label": "组织多选",
                "crtUser": "huangyunzhen",
                "lifecycle": "PRELIMINARY",
                "classId": "b6b466cd03804cd4812a66fcb9f6cfc2",
                "isDeleted": "0",
                "updUser": "yeduanwang",
                "exposesKey": "LcpMultiOrgConfigs",
                "updTime": 1671508401316,
                "isEnabled": "1",
                "appId": "1269620726624013b98cf4baadaa759f",
                "tenantId": "c518f53d-b405-4111-afe1-5c082b284971",
                "crtHost": "172.17.228.45",
                "id": "3be0b1516c434bb0a4f5d7d0063e2f54",
                "sourceName": "cir-csb-generator",
                "groupCode": "advance"
            },
            {
                "applyType": "table,form",
                "code": "ORGANIZTION",
                "dversionNo": 2,
                "icon": "MehOutlined",
                "crtName": "叶端旺",
                "updName": "叶端旺",
                "crtTime": 1660034663000,
                "updHost": "172.17.228.45",
                "label": "组织单选",
                "crtUser": "huangyunzhen",
                "lifecycle": "PRELIMINARY",
                "classId": "b6b466cd03804cd4812a66fcb9f6cfc2",
                "isDeleted": "0",
                "updUser": "yeduanwang",
                "exposesKey": "LcpOrgConfigs",
                "updTime": 1671508401316,
                "isEnabled": "1",
                "appId": "1269620726624013b98cf4baadaa759f",
                "tenantId": "c518f53d-b405-4111-afe1-5c082b284971",
                "crtHost": "172.17.228.45",
                "id": "f946bc5ffd0b47cfafb57eded21647c5",
                "sourceName": "cir-csb-generator",
                "groupCode": "advance"
            }
        ]
    }
}
作者：黄泽彬  创建时间：2023-03-07 21:12
最后编辑：黄泽彬  更新时间：2024-12-11 10:09