1 接口介绍

查询操作API是通过在系统中维护接口基本信息、配置请求参数、查询条件及返回参数来定义查询接口具体的功能。


2 注意事项

另外,关于提升查询接口性能,有以下优化建议:


3 接口示例

3.1 根据工号查询人员信息

路径:【开放服务云】→【OpenAPI】→【API管理】→【API开发】,列表点击“新增”按钮,进入“零代码开发”模式。



依次维护API编码、名称、请求方式等信息,如业务对象选择“人员”,操作方式选择“查询”。然后维护请求参数,通过“添加属性”按钮可以快速添加参数,也可以点击“增行”按钮,手工录入参数,参数名称支持完全自定义。


 

维护请求参数后,接着维护查询条件和返回参数,比较业务字段和请求参数,常见的比较方式有等于、不等于、包含...等等。

备注:当查询条件比较方式为“在...中”或“不在...中”时,对应比较变量的参数类型必须为Array数组。此时可以选择Array、Array、Array、Array这四种数组类型。



维护完返回参数后,接口就开发完毕了,接下来点击“API测试”,开始调试你的接口吧!


  

3.2 自由组合查询条件,查询人员信息

在上个场景中, 用户通过“添加属性”返回外部系统需要的字段,并且配置非常灵活。那么如果想要更加灵活的请求参数组合,应该怎么做呢?

您只需要在定义查询条件时,配置多组不同的查询条件即可。例如,根据人员状态、创建时间和性别来查询人员信息。



若需要在调用API时,调用方不传请求参数时忽略参数对应的过滤条件,按其他条件过滤,只需要将参数设为非必填,并且设置默认值为“*”,当然也可以给其他有具体含义的默认值。


 

若在此时调试API,调用方只传入了必填参数,接口会忽略默认值为*的参数对应的查询条件,并组合默认值为其他值的查询条件。


 

 

3.3 指定固定常量或脚本查询人员信息

在实际应用中,可能还有一个场景,比如A系统对B系统开放查询接口,但出于数据安全考虑,只允许对方查到A组织或来源于B供应商的采购订单,那么可以通过添加常量查询条件来达到这个目的。


 

只需要在查询条件中配置常量过滤条件,无需维护任何请求参数,如果我们测试API,那么接口会根据固定查询条件返回对应的数据。

 


3.4 分录过滤,例如:根据物料编码查询数据

1)维护API基本信息,如API编码、API名称、业务对象、操作方式、详细描述等,系统自动生成API请求地址。



2)维护请求参数和查询条件,配置查询条件时注意,采购订单分录中的物料编码比较特殊,必须用主物料编码和请求参数进行比较,参数标识为:billentry.material.masterid.number

  1. 点击增行,添加自定义查询参数;

  2. 配置自定义查询信息;

  3. 点击条件字段,选择物料编码,注意,条件字段必须是分录最内层的物料编码,带masterid;

  4. 配置比较方式;

  5. 配置比较变量为自定义查询参数。


3)定义返回参数,点击“添加属性”按钮,勾选需要返回的参数,若要返回物料编码字段,必须勾选分录最里层的物料编码和名称。确认后点击“保存”按钮,API维护完成。




如果我们测试API,就可以根据物料编码查询到对应的采购订单信息了。




4 更多资讯

关于OpenAPI的更多资讯,请随时关注OpenAPI(开放平台)新特性汇总