快速配置动态生成查询API

栏目:云星瀚知识作者:金蝶来源:金蝶云社区发布:2024-09-23浏览:2

快速配置动态生成查询API

1 简介

1.1 功能介绍

人力资源系统是企业核心基础系统,人岗架数据是服务整个企业系统的数据底座,所以,人力资源系统,给企业周边生态系统提供数据服务已经成为最基本诉求。过程中涉及到的API需要较多二开工作量,查询API配置提供了一种快速配置API的功能,帮助现场顾问和开发快速生成查询API,降低二开交付成本。

功能列表:

查询API配置列表

展示配置的查询API配置,选中数据点击“发布查询API”,会将API发布到OpenAPI

1.2 应用场景

下游系统需要查询星人岗架数据,可以通过查询API配置功能配置出动态查询API,无需编码,提供给下游系统。

1.3 系统路径

HR交付工具云】→【HR交付平台→【HR数据集成服务HR数据集成服务→【查询API配置

1.4 关键字段/按钮说明

1.4.1 关键字段说明

字段名称

详细解释

API编码

定义API的编码

API名称

定义API的名称

主实体对象

查询的关键实体,其他实体信息都需要跟他关联

多实体关系分录

分录.实体对象默认为主实体对象

分录.关联实体对象不能为主实体对象且不能重复重复

分录.实体字段可选择实体对象对应的字段;

分录.关联实体字段可选择关联实体对象对应的字段;

查询字段分录

选择需要查询的字段

请求参数分录

配置API的请求参数,可以定义别名

过滤条件设置

可根据值或者参数设置过滤条件


1.4.2 关键按钮说明

按钮名称

详细解释

发布查询API

根据查询API配置发布API到OpenAPI

取消发布

将已发布到OpenAPI中的API删除


2 主要操作

2.1 发布API操作

2.1.1 前提条件

需要查询的实体已经准备好了

2.1.2 操作步骤

步骤1: 新增“查询API配置” 

步骤2: 配置主实体以及主实体和其他关联实体对象的关系

步骤3: 配置主实体和对应的字段,并配置排序

步骤4: 配置请求参数以及过滤条件

2.1.3 后续操作

下游系统调用API可以查询星的数据



变更记录

产品版本

(季度版本号/patch补丁号)

更新内容

更新时间

V6.0.10

初始版本

20244



快速配置动态生成查询API

1 简介1.1 功能介绍人力资源系统是企业核心基础系统,人岗架数据是服务整个企业系统的数据底座,所以,人力资源系统,给企业周边生态系统...
点击下载文档
确认删除?
回到顶部
客服QQ
  • 客服QQ点击这里给我发消息