检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
在线方式:在应用设计态上在线查看。 如需查看应用完整的全量数据服务API,需将应用部署至数据建模引擎后,前往应用运行态查看,具体操作请参见部署应用和全量数据服务。 前提条件 已登录应用设计态。
如何调用API 构造请求 认证鉴权 返回结果
接口说明 iDME当前提供的API如表1所示,暂未提供数字主线引擎(LinkX Foundation,简称LinkX-F)的API。 表1 iDME接口说明 类型 说明 应用管理 包括应用的创建、删除、编辑等接口。 运行服务管理 包括应用的部署、卸载等接口。
API 应用管理 运行服务管理 数据建模引擎 流程引擎
iDME Open API SDK参考 工业数字模型驱动引擎管理面SDK参考 工业数字模型驱动引擎典型API SDK参考
查询指定API 操作场景 默认情况下,应用设计态的“数据服务管理 > 全量数据服务”展示的是当前应用下用户构建数据模型时预生成的接口。
在“分类”操作栏中,根据实际业务需求,导出全部数据模型API或者选中的数据模型API。 全部导出:单击“导出批量操作 > 全部导出”。 图1 全部导出 导出选中项:勾选需要导出的API或分类,单击“导出批量操作 > 导出选中项”。
查看设备API 操作场景 本文指导您如何查看当前选择的应用租户下的所有设备API。 操作步骤 登录LinkX-F系统首页。 选择“基础数据管理 > 设备API”,进入“设备API”页面。 列表默认展示所有设备API。
设备API 创建设备API 查看设备API 修改设备API 删除设备API 父主题: 基础数据管理
是否批量接口 是否是查询批量设备OT数据的接口。 默认值为“否”。 API英文名称 设备API的英文名,必填且不能重复,必须以大写字母开头,且只能包含字母、数字、下划线。 API中文名称 设备API的中文名,非必填,必须以中文或者字母开头,且只能包含中文、字母、数字、下划线。
如需使用iDME典型API组件的API Explorer接口和SDK代码,请在“工业数字模型驱动引擎(典型API体验)”服务下获取。 在线生成SDK代码 API Explorer能根据需要动态生成SDK代码功能,降低您使用SDK的难度,推荐使用。
修改设备API 操作场景 您可根据需要更新设备API信息。本文指导您如何修改设备API。 如果待修改的设备API有被数据实体映射引用,则只支持修改部分字段。 前提条件 已获取开发人员及以上权限用户的账号和密码。 操作步骤 登录LinkX-F系统首页。
通过API方式下载文件 功能介绍 通过“文件管理”接口“file_downloadFile”可以下载已上传的文件。
选择“基础数据管理 > 设备API”,进入“设备API”页面。 勾选一个或多个设备API后,单击列表上方的“删除”,弹出提示框。 单击“确定”。 父主题: 设备API
源系统API 创建源系统API 查看源系统API 修改源系统API 删除源系统API 父主题: 基础数据管理
填写基本信息,如表1所示: 表1 基本信息 字段 说明 API类型 必填,下拉选择API类型: 普通API:代表无外键依赖的实体数据API,包括源端API和对象实体API。 外键依赖API:代表外键依赖的实体数据API。
查看源系统API 操作场景 本文指导您如何查看当前选择的应用租户下的所有源系统API。 操作步骤 登录LinkX-F系统首页。 选择“基础数据管理 > 源系统API”,进入“源系统API”页面。 列表默认展示所有源系统API。
修改源系统API 操作场景 您可根据需要更新源系统API信息。本文指导您如何修改源系统API。 前提条件 已获取开发人员及以上权限用户的账号和密码。 操作步骤 登录LinkX-F系统首页。 选择“基础数据管理 > 源系统API”,进入“源系统API”页面。
API参考 iDME提供在线查询API功能(即全量数据服务功能)和REST API的详细说明文档,详细介绍了各API的基本信息、请求参数、响应参数等信息,帮助您顺利使用API完成二次开发。 SDK参考 iDME SDK的详细使用指导,包括服务端SDK和客户端SDK。
选择“基础数据管理 > 源系统API”,进入“源系统API”页面。 勾选一个或多个源系统API后,单击列表上方的“删除”,弹出提示框。 单击“确定”。 父主题: 源系统API