电脑桌面
添加蚂蚁七词文库到电脑桌面
安装后可以在桌面快捷访问

查询操作接口

来源:金蝶云社区作者:金蝶2024-09-233

查询操作接口

1 接口介绍

查询操作服务是通过在url参数中指定返回字段及过滤条件等参数,调用服务查询业务对象中的数据,返回结果同时支持分页查询和排序。


2 注意事项

1)查询服务支持大批量业务数据查询,返回数据时先展示字段信息(header),再统一将值在rows中返回;

2)查询时通过url携带的select参数和过滤条件表达式,指定需要返回的数据。

3)当存在多个同级的filter条件时,建议在条件中添加括号来保障优先级,否则系统会按先后顺序解析filter条件并进行拼接。


查询类API参数说明:

参数名称

参数说明

select

输出的字段列表,以英文逗号分隔,如:number,name

accessToken

用户认证后的访问令牌

orderby

排序表达式,默认升序,若在排序字段后添加 DESC,则返回结果倒序

page_no

分页参数,查询页码

page_size

分页参数,分页数量

filter

过滤表达式,样式:{exp} and/or ({exp} and/or {exp})
{exp}:基本表达式,格式是 {field} {op} {value}
{field}:字段名
{op}:比较符,不区分大小写,支持的比较符如下:
      EQ //等于        例:billno EQ 'CGDD-20210303'
      NQ //不等       例:billtype.number NQ '100'
      LT //小于         例:createtime LT '2021-02-05'
      BT //大于         例:billentity.qty BT '500'
      LQ //小于等于
      BQ //大于等于
      IN //包含          例:number IN ('demo1','demo2')

      NI //不包含       例:number NI ('demo1','demo2')

      CS //字符串的模糊匹配        例:billno CS 'demo%25'
      BG //字符串开始位置匹配    例:billno BG 'demo%25'
{value}:比较值。当比较符为‘IN’、‘NI’,比较值可用‘,’分隔。



3 接口示例

采购订单查询

URL:{{host}}/kapi/sys/pm_purorderbill/query?select=org,org.number,billno,billtype.name,comment,billentry.id,billentry.entrycomment&filter=billno eq 'CGDD-202109-152232'  and billstatus in ('A','B','C') and createtime LT '2021-09-25'


请求方式:GET


请求Header参数:

Content-Type=application/json

accessToken: xxxxxxxxxxxxx


请求结果(成功

{

   "success": "true",

   "data": {

       "count": 1,

       "header": [

           {

               "name": "org",

               "caption": "采购组织",

               "type": "long"

           },

           {

               "name": "org.number",

               "caption": "编码",

               "type": "String"

           },

           {

               "name": "billno",

               "caption": "单据编号",

               "type": "S

查询操作接口

1 接口介绍查询操作服务是通过在url参数中指定返回字段及过滤条件等参数,调用服务查询业务对象中的数据,返回结果同时支持分页查询和排序...
点击下载文档文档为doc格式

声明:除非特别标注,否则均为本站原创文章,转载时请以链接形式注明文章出处。如若本站内容侵犯了原著者的合法权益,可联系本站删除。

确认删除?
回到顶部
客服QQ
  • 客服QQ点击这里给我发消息
QQ群
  • 答案:my7c点击这里加入QQ群
支持邮箱
微信
  • 微信