华为云用户手册

  • 响应参数 表3 响应Body参数 参数 参数类型 描述 result String 调用是否成功。 SUC CES S:成功 FAIL:失败 data List of data 调用的返回结果。 errors List 异常信息列表。 表4 data 参数 参数类型 描述 data.id Long 事务型任务ID。 data.status String 事务型任务的提交状态。 not start:未提交 executing:执行中 success:提交成功 fail:提交失败,步骤2:执行iDME原子接口执行的任一原子接口若执行失败,均表示事务型任务提交失败。 data.tasks List of task 事务型任务下的原子接口列表。 表5 tasks 参数 参数类型 描述 data.tasks.result String 原子接口的执行详情。 data.tasks.task_no Integer 原子接口的执行序号。 data.tasks.task_status String 原子接口的执行状态。 success:成功 fail:失败 not start:未执行
  • 请求示例 根据事务型任务ID,查询该事务型任务的执行结果。 GET https://dme.cn-north-4.huaweicloud.com/rdm_fce01234567d41828cf3473b07fa7ae2_app/services/rdm/basic/api/v1/transaction-apis/transactions/538322343718555649 X-Auth-Token: ABCDEFJ....
  • URI URI格式: GET http://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/v1/transaction-apis/transactions/{transaction-id} 参数说明: 表1 URI参数说明 参数 是否必填 参数类型 描述 Endpoint 是 String 承载REST服务端点的服务器域名或IP地址。 appID 是 String 应用ID。 transaction-id 是 Long 事务型任务ID,即步骤1:创建事务型任务返回的transactionId。
  • 响应示例 { "result": "SUCCESS", "data": [ { "id": 538322343718555649, "status": "success", "tasks": [ { "result": "{\"id\": 538327077254860800, \"tenant\": {\"id\": -1, \"code\": \"basicTenant\", \"name\": \"basicTenant\", \"creator\": \"xdmAdmin\", \"modifier\": \"xdmAdmin\", \"className\": \"Tenant\", \"createTime\": 1688108575000, \"dataSource\": \"DefaultDataSource\", \"rdmVersion\": 1, \"description\": \"默认租户\", \"disableFlag\": false, \"rdmDeleteFlag\": 0, \"securityLevel\": \"internal\", \"lastUpdateTime\": 1688108575000, \"rdmExtensionType\": \"Tenant\"}, \"creator\": \"XDM_Developer 93172bbfd0f64437956d4c9de9345386\", \"extAttrs\": [{\"name\": \"ExtString\", \"type\": \"STRING\", \"value\": \"0123\"}, {\"name\": \"ExtDouble\", \"type\": \"DECIMAL\"}], \"modifier\": \"XDM_Developer 93172bbfd0f64437956d4c9de9345386\", \"className\": \"ExtDataModel\", \"createTime\": 1693367976851, \"extAttrMap\": {}, \"rdmVersion\": 1, \"rdmDeleteFlag\": 0, \"lastUpdateTime\": 1693367976851, \"rdmExtensionType\": \"ExtDataModel\"}", "task_no": 1, "task_status": "success" }, { "result": "{\"id\": 535837830857887744, \"tenant\": {\"id\": -1, \"code\": \"basicTenant\", \"name\": \"basicTenant\", \"creator\": \"xdmAdmin\", \"modifier\": \"xdmAdmin\", \"className\": \"Tenant\", \"createTime\": 1688108575000, \"dataSource\": \"DefaultDataSource\", \"rdmVersion\": 1, \"description\": \"默认租户\", \"disableFlag\": false, \"rdmDeleteFlag\": 0, \"securityLevel\": \"internal\", \"lastUpdateTime\": 1688108575000, \"rdmExtensionType\": \"Tenant\"}, \"creator\": \"XDM_Developer 93172bbfd0f64437956d4c9de9345386\", \"extAttrs\": [{\"name\": \"ExtString\", \"type\": \"STRING\", \"value\": \"1234056789\"}, {\"name\": \"ExtDouble\", \"type\": \"DECIMAL\"}], \"modifier\": \"XDM_Developer 93172bbfd0f64437956d4c9de9345386\", \"className\": \"ExtDataModel\", \"createTime\": 1692774494000, \"extAttrMap\": {}, \"rdmVersion\": 38, \"rdmDeleteFlag\": 0, \"lastUpdateTime\": 1693367978040, \"rdmExtensionType\": \"ExtDataModel\"}", "task_no": 2, "task_status": "success" } ], "task_count": 2 } ], "errors": [] }
  • 入参示例 POST http://dme.cn-north-4.huaweicloud.com/rdm_01a2b2c4764d4e00f123g345fd9baa9f_app/services/dynamic/api/People/list/20/1 { "params": { "sorts": [ { "sort": "DESC", "orderBy": "name" }, { "sort": "DESC", "orderBy": "age" } ], "filter": { "joiner": "and", "conditions": [ { "conditionName": "sex", "operator": "=", "conditionValues": [ "男" ] } ] }, "isNeedTotal": true } }
  • 出参示例 { "result": "SUCCESS", "data": [ { "id": "455304645330341888", "creator": "test1 3c03e719256a427eb9277b64fcXXXXXX", "createTime": "2023-01-13T01:38:07.000+00:00", "modifier": "test1 3c03e719256a427eb9277b64fcXXXXXX", "lastUpdateTime": "2023-01-13T01:38:07.000+00:00", "rdmVersion": 1, "rdmExtensionType": "People", "rdmDeleteFlag": 0, "tenant": { //tenant为参考对象 "id": "-1", "clazz": "Tenant" }, "className": "People", "name": "李四", "description": null, "kiaguid": null, "securityLevel": "internal", "sex": "男", "age": 20 }, { "id": "455304534248394752", "creator": "test1 3c03e719256a427eb9277b64fcXXXXXX", "createTime": "2023-01-13T01:37:40.000+00:00", "modifier": "test1 3c03e719256a427eb9277b64fcXXXXXX", "lastUpdateTime": "2023-01-13T01:37:40.000+00:00", "rdmVersion": 1, "rdmExtensionType": "People", "rdmDeleteFlag": 0, "tenant": { //tenant为参考对象 "id": "-1", "clazz": "Tenant" }, "className": "People", "name": "张三", "description": null, "kiaguid": null, "securityLevel": "internal", "sex": "男", "age": 18 } ], "errors": [], "pageInfo": { "curPage": 1, "pageSize": 20, "totalRows": 2, "totalPages": 1 } }
  • 入参 POST http://{Endpoint}/rdm_{appID}_app/services/dynamic/api/{entityName}/list/pageSize/curPage { "params": { "sorts": [ { "sort": "DESC", "orderBy": "属性名称" } ], "filter": { ...... }, "isNeedTotal": true } } {Endpoint}表示数据建模引擎所在域名或IP地址,{appID}表示应用ID,{entityName}表示实体的英文名称。 在URL上填写待查询的页码(curPage)和每页可显示的数据量(pageSize)。 在JSON代码中的设置sorts字段和filter字段。 sorts:填写需要按哪个字段进行排序,可为空。 filter:填写过滤条件,可为空。
  • 概述 树形结构指的是数据元素之间存在着“一对多”的树形关系的数据结构,是一类重要的非线性数据结构。在树形结构中,树根节点没有前驱节点,其余每个节点有且只有一个前驱节点。叶子节点没有后续节点,其余每个节点的后续节点数可以是一个也可以是多个。 为了便于用户维护数据之间的父子关系,工业数字模型驱动引擎(Industrial Digital Model Engine,简称iDME)提供树形结构功能。用户可在应用设计态创建数据实体时,在功能列表中勾选“树形结构”,即可使用此功能。 具有树形结构功能的数据实体会自动生成五个系统属性“ParentNode”、“LeafFlag”、“RawFullPath”、“RootNode”和“FullPath”,同时对外提供如下7个树形相关接口。 表1 树形结构相关接口 接口名称 描述 GetAllParentList 获取所有父节点(前驱节点):获取该叶子节点之上的所有父节点,可往上查到顶层父节点。 BatchRemoveChildNode 批量移除叶子节点。 BatchAddChildNode 批量添加叶子节点/批量更新叶子节点的父节点。 GetChildList 获取单层叶子节点。 GetParent 获取单层父节点。 Refresh 刷新所有叶子节点。 GetRoot 获取根节点/顶层父节点。 更多树形结构的接口信息请参见全量数据服务。
  • 使用说明 如果数据实体的父模型存在树形结构,该数据实体自动继承树形结构功能,且不可去勾选。如果后续父模型删除了树形结构功能,该数据实体将不再继承父模型的树形结构功能,但可以自己重新勾选树形结构功能。 如果数据实体为Master-Version模型实体(即“父模型”选择为“VersionObject”),则只能在Master模型上选择树形结构功能,Version模型和Branch模型不支持选择树形结构功能。
  • 示例场景 常见的应用系统(如ERP、采购、财务等)中都会包含人员管理,而人员管理往往都是以组织的形式进行管理和展示。这种场景下,树形结构是此功能的基础核心,所有人员的权限操作都是依附于组织。 图1 某企业组织架构图 某企业的组织架构如图1所示,根据树形结构进行分析,可得知: 黄色方框的部门没有父节点,即为根节点。 红色方框的部门没有子节点,即为叶子节点。 绿色方框的部门均有子节点。 为此,我们可在构建数据模型时,创建一个具有“树形结构”功能的数据实体用于管理此企业的组织。而后在其数据实体实例化时,通过指定“ParentNode”的属性值来实现组织管理。 如下操作步骤仅指导您如何通过可视化页面使用树形结构功能。关于如何通过API方式使用树形结构功能请参见全量数据服务。
  • 示例场景 假设在iDME应用运行态有如下数据实体和关系实体,并基于这些实体创建了若干实例。希望自定义一个API,该API可根据票价和余票的具体值,查询票价≤票价具体值,余票≥余票具体值的电影院和影片信息,分页显示。例如,查询票价≤19.9,余票≥8的电影院ID、影片ID、票价和余票信息。 表1 实体 实体类型 实体名称 说明 数据实体 英文名称:Cinema 中文名称:电影院 用于存储电影院信息,如部门、收入等。 英文名称:Film 中文名称:影片 用于存储影片信息,如电影导演、主演、简介、语言、片长、类型等。 关系实体 英文名称:Play 中文名称:上映 为Cinema(源数据实体)和Film(目标数据实体)建立多对多关系。 关系实体属性包含票价(price)和余票(remain),均为数值型属性。
  • 步骤3:使用服务编排API 根据QueryByPriceRemain API的详细信息,在用户应用的管理系统中构造如下请求示例: POST http://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/customservice/QueryByPriceRemain/execute/20/1 Content-Type: Application/Json Content-Length: Content Length X-AUTH-TOKEN: XXXXXXXXXX { "params": { "price": 19.9, "remain": 8, "returnTotalCountFlag": true, } } 其中,{Endpoint}表示数据建模引擎所在域名或IP地址,{appID}表示应用ID。
  • 功能对比 表1 数据实体查询接口 接口 适用场景 查询效率 多字段排序 Get 适用于通过实体或实例的ID,获取某实体或实例所有信息的场景。 模型越复杂,参考对象和扩展属性越多,查询效率越慢。 不支持。 Batchget 适用于通过实体或实例的ID,获取多个实体或实例所有信息的场景。 模型越复杂,参考对象和扩展属性越多,查询效率越慢。 不支持。 List 适用于只查询数据模型自身信息的场景。 不支持参考模型属性作为查询条件。 查询效率较快。 可通过sorts字段进行多字段排序,通过filter字段进行数据过滤。 Find 适用于通过指定查询条件,获取符合条件的所有数据模型的所有信息的场景。 模型越复杂,参考对象和扩展属性越多,查询效率越慢。 可通过sorts字段进行多字段排序,通过filter字段进行数据过滤。 Query 适用于只查询数据模型所有的列表属性信息的场景。 只返回符合查询条件的对象及列表属性。 查询效率相较于find更快一些。 可通过sorts字段进行多字段排序,通过filter字段进行数据过滤。 Count 适用于通过指定查询条件,获取符合条件的数据模型总数的场景。 只返回符合查询条件的对象的记录总数。 查询效率较快。 可通过sorts字段进行多字段排序,通过filter字段进行数据过滤。 Select 适用于只查询数据模型指定属性数据的场景。 查询效率较快。 可通过sorts字段进行多字段排序,通过filter字段进行数据过滤。但数据过滤时,还需通过selectedField字段指定属性查询数据。 list、find、query和select接口的分页偏移量不能大于50000。 表2 关系实体查询接口 接口 描述 queryRelatedObjects 用于查询源或目标实体的属性。 batchQueryRelatedObjects 用于批量查询源或目标实体的属性。 queryRelationship 用于查询关系实例的数据。 queryTarget 用于查询目标实体的数据。 deleteTarget 用于删除关系实例。
  • 排序规则说明 数据实体、关系实体的接口,涉及排序的,根据数据库类型不同,字段首字母排序遵循如下规则: 如果是PostgreSQL数据库,在升降序排序时,先根据字母大小写,然后再根据英文字母顺序进行升降序排序显示。如升序排序时,字段首字母排序显示为B、X、Z、a、b、c。 如果是MySQL数据库,在升降序排序时,先根据英文字母顺序,然后再根据字母大小写进行升降序排序显示。如升序排序时,字段首字母排序显示为a、B、b、c、X、Z。
  • 入参示例 根据源端RelationRight的ID为454580805678901111的关系实例,查询符合条件的全部数据。 { "params":{ "objectId":454580805678901111, "role":"source", "latestOnly":false } }
  • 出参示例 { "result": "SUCCESS", "data": [ { "id": "454580805678901111", "creator": "xdm_pub_validation f9828b63ee074aa69a2b3fb30aXXXXXX", "modifier": "xdm_pub_validation f9828b63ee074aa69a2b3fb30aXXXXXX", "createTime": "2023-01-12T11:56:55.551+0000", "lastUpdateTime": "2023-01-12T11:56:55.551+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "RelationTest", "tenant": { "id": "-1", "creator": "xdmAdmin", "modifier": "xdmAdmin", "createTime": "2022-09-22T04:10:48.543+0000", "lastUpdateTime": "2022-09-22T04:10:48.543+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "Tenant", "tenant": null, "className": "Tenant", "name": "basicTenant", "description": "默认租户", "kiaguid": null, "securityLevel": "internal", "code": "basicTenant", "disableFlag": false, "dataSource": "DefaultDataSource" }, "className": "RelationTest", "source": { "id": "454580805678901111", "creator": "xdm_pub_validation f9828b63ee074aa69a2b3fb30aXXXXXX", "modifier": "xdm_pub_validation f9828b63ee074aa69a2b3fb30aXXXXXX", "createTime": "2023-01-12T11:55:22.797+0000", "lastUpdateTime": "2023-01-12T11:55:22.797+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "RelationLeft", "tenant": { "id": "-1", "creator": "xdmAdmin", "modifier": "xdmAdmin", "createTime": "2022-09-22T04:10:48.543+0000", "lastUpdateTime": "2022-09-22T04:10:48.543+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "Tenant", "tenant": null, "className": "Tenant", "name": "basicTenant", "description": "默认租户", "kiaguid": null, "securityLevel": "internal", "code": "basicTenant", "disableFlag": false, "dataSource": "DefaultDataSource" }, "className": "RelationLeft", "name": null, "description": null, "kiaguid": null, "securityLevel": "internal", "stuId": null, "right": { "id": "427473106174128128", "clazz": "RelationRight" }, "stuName": null }, "target": { "id": "454580805678903333", "creator": "xdm_pub_validation f9828b63ee074aa69a2b3fb30aXXXXXX", "modifier": "xdm_pub_validation f9828b63ee074aa69a2b3fb30aXXXXXX", "createTime": "2023-01-12T11:55:43.192+0000", "lastUpdateTime": "2023-01-12T11:55:43.192+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "RelationRight", "tenant": { "id": "-1", "creator": "xdmAdmin", "modifier": "xdmAdmin", "createTime": "2022-09-22T04:10:48.543+0000", "lastUpdateTime": "2022-09-22T04:10:48.543+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "Tenant", "tenant": null, "className": "Tenant", "name": "basicTenant", "description": "默认租户", "kiaguid": null, "securityLevel": "internal", "code": "basicTenant", "disableFlag": false, "dataSource": "DefaultDataSource" }, "className": "RelationRight", "name": null, "description": null, "kiaguid": null, "securityLevel": "internal", "stuId": null, "courseId": null, "relationLeftList": null }, "name": null, "description": null }, { "id": "455098158066700288", "creator": "xdm_pub_validation f9828b63ee074aa69a2b3fb30aXXXXXX", "modifier": "xdm_pub_validation f9828b63ee074aa69a2b3fb30aXXXXXX", "createTime": "2023-01-12T11:57:36.198+0000", "lastUpdateTime": "2023-01-12T11:57:36.198+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "RelationTest", "tenant": { "id": "-1", "creator": "xdmAdmin", "modifier": "xdmAdmin", "createTime": "2022-09-22T04:10:48.543+0000", "lastUpdateTime": "2022-09-22T04:10:48.543+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "Tenant", "tenant": null, "className": "Tenant", "name": "basicTenant", "description": "默认租户", "kiaguid": null, "securityLevel": "internal", "code": "basicTenant", "disableFlag": false, "dataSource": "DefaultDataSource" }, "className": "RelationTest", "source": { "id": "454580805678901111", "creator": "xdm_pub_validation f9828b63ee074aa69a2b3fb30aXXXXXX", "modifier": "xdm_pub_validation f9828b63ee074aa69a2b3fb30aXXXXXX", "createTime": "2023-01-12T11:55:22.797+0000", "lastUpdateTime": "2023-01-12T11:55:22.797+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "RelationLeft", "tenant": { "id": "-1", "creator": "xdmAdmin", "modifier": "xdmAdmin", "createTime": "2022-09-22T04:10:48.543+0000", "lastUpdateTime": "2022-09-22T04:10:48.543+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "Tenant", "tenant": null, "className": "Tenant", "name": "basicTenant", "description": "默认租户", "kiaguid": null, "securityLevel": "internal", "code": "basicTenant", "disableFlag": false, "dataSource": "DefaultDataSource" }, "className": "RelationLeft", "name": null, "description": null, "kiaguid": null, "securityLevel": "internal", "stuId": null, "right": { "id": "427473106174128128", "clazz": "RelationRight" }, "stuName": null }, "target": { "id": "454580805678904444", "creator": "xdm_pub_validation f9828b63ee074aa69a2b3fb30aXXXXXX", "modifier": "xdm_pub_validation f9828b63ee074aa69a2b3fb30aXXXXXX", "createTime": "2023-01-12T11:55:47.918+0000", "lastUpdateTime": "2023-01-12T11:55:47.918+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "RelationRight", "tenant": { "id": "-1", "creator": "xdmAdmin", "modifier": "xdmAdmin", "createTime": "2022-09-22T04:10:48.543+0000", "lastUpdateTime": "2022-09-22T04:10:48.543+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "Tenant", "tenant": null, "className": "Tenant", "name": "basicTenant", "description": "默认租户", "kiaguid": null, "securityLevel": "internal", "code": "basicTenant", "disableFlag": false, "dataSource": "DefaultDataSource" }, "className": "RelationRight", "name": null, "description": null, "kiaguid": null, "securityLevel": "internal", "stuId": null, "courseId": null, "relationLeftList": null }, "name": null, "description": null } ], "errors": [], "pageInfo": { "curPage": 1, "pageSize": 20, "totalRows": 2, "totalPages": 1 } }
  • 入参 { "params":{ "objectId": XXXX, "role":"source", "latestOnly":false } } objectId:对象ID。 role:角色,源数据模型或目标数据模型。 latestOnly:目标对象是否仅返回源对象关联的最新版本目标对象,默认为false。(仅对M-V模型有效,即返回所有版本)
  • 示例场景 假设有一个源端为RelationLeft,目标端为RelationRight的关系实体(RelationTest)。其中, RelationLeft有两个关系实例,唯一编码为454580805678901111和454580805678902222。 RelationRight有两个关系实例,唯一编码为454580805678903333和454580805678904444。 并创建了如下唯一编码的关系实例: 1313:源端为454580805678901111,目标端为454580805678903333。 2424:源端为454580805678902222,目标端为454580805678904444。 1414:源端为454580805678901111,目标端为454580805678904444。
  • 操作步骤 进入HarddiskTracing_GetDetailList服务详情页切换至“服务测试”页签。 在用例列表上方单击“新增用例”,弹出“新增测试用例”窗口。 填写测试用例信息,如表1所示: 表1 测试用例信息 参数 说明 用例信息 用例名称 test。 标签 支持用户自定义标签,可不填。 入参信息 PurchaserSN_BarCode 示例:102327137927。 Item_SN 示例:02354KMV-001。 pageSize 10。 每页条目数,即每页显示的数据条目数。 pageNumber 1。 分页页码,即返回指定页码的数据条目数。 returnTotalCountFlag false。 是否返回数据条目总数。 基于JSON识别入参 用户输入JSON脚本后,系统自动解析JSON脚本中的测试用例,并自动填充测试用例各字段,JSON参数名称区分大小写。 图1 新增测试用例 填写完后单击“确定”。 在用例列表中,勾选想要执行的test测试用例,单击列表上方的“执行用例”。 用例执行完成之后,您可查看下方“执行结果”,查看该条用例的执行结果详情。
  • 示例场景 某工业产品的开发流程如图1所示,先后经历了原型、试产、小批和量产四个阶段。 原型:对产品结构(如外貌、功能、用户体验等)进行规划和设计,期间会频繁修改。 试产:对产品设计的验证,期间材料结构不会变化,但会存在一些细节的变更。 小批:即小批量生产,将所有治具、夹具、机器、仪器、测试工具等按照量产的标准配置生产,用来验证产品是否能够量产。 量产:通过测试验证、规格审定后,大批量生产。 随着产品的迭代更新,会在原版本的产品上进行改良升级。此时,可分别在转试产的时间点、转小批量的时间点和转量产的时间点创建基线,每个基线分别记录当前基线成员的变化,便于对产品历史的追踪管理。 图1 基线
  • 使用说明 本方案以部分API为操作示例,如需了解更多基线管理API,请参见全量数据服务(“XDM基线对象”和“基线对象与被基线对象的关系”)。 基线对象锁定后,不能对该基线对象进行添加和删除基线成员、更新和删除基线对象的操作。 基线对象锁定后,不能对该基线对象下的基线成员进行撤销检出和删除的操作。 基线对象锁定后,支持对该基线对象下的基线成员进行修改、修订、检入和检出的操作。如果基线成员为其他基线对象且也被锁定,则不允许修改。 如需解锁已锁定的基线对象,可使用“XDM基线对象”的接口“BaseLine_enable”进行解锁。
  • 操作流程 本文通过iDME的基线管理功能,为您演示开发某工业产品场景下的基线管理流程。 表1 基线管理操作流程 主要操作流程 操作目的 创建数据模型及其实例数据 使用iDME的数据模型管理完成对业务数据对象的模型设计,并发布数据模型。 iDME会将应用设计态创建的数据模型部署至应用运行态,完成数据模型的实例化、API调用等操作。 创建基线对象 使用iDME的全量数据服务API完成基线对象的创建。 为基线对象添加基线成员 使用iDME的全量数据服务API,将数据模型的实例化数据与基线对象进行关联。 锁定基线对象 使用iDME的全量数据服务API完成基线对象的锁定,不允许修改该基线对象。
  • 响应参数 同步提交 表4 响应Body参数 参数 参数类型 描述 result String 调用是否成功。 SUCCESS:成功 FAIL:失败 data List of data 调用的返回结果。 errors List 异常信息列表。 表5 data 参数 参数类型 描述 data.id Long 事务型任务ID。 data.status String 事务型任务是否提交成功。步骤2:执行iDME原子接口执行的任一原子接口若执行失败,均表示事务型任务提交失败。 success:成功 fail:失败 data.tasks List of task 事务型任务下的原子接口列表。 表6 tasks 参数 参数类型 描述 data.tasks.result String 原子接口的执行详情。 data.tasks.task_no Integer 原子接口的执行序号。 data.tasks.task_status String 原子接口的执行状态。 success:成功 fail:失败 异步提交 表7 响应Body参数 参数 参数类型 描述 result String 调用是否成功。 SUCCESS:成功 FAIL:失败 data List 调用的返回结果,默认为空。 errors List 异常信息列表。
  • 响应示例 同步提交 { "result": "SUCCESS", "data": [ { "id": 538322343718555649, "status": "success", "tasks": [ { "result": "{\"id\": 538327077254860800, \"tenant\": {\"id\": -1, \"code\": \"basicTenant\", \"name\": \"basicTenant\", \"creator\": \"xdmAdmin\", \"modifier\": \"xdmAdmin\", \"className\": \"Tenant\", \"createTime\": 1688108575000, \"dataSource\": \"DefaultDataSource\", \"rdmVersion\": 1, \"description\": \"默认租户\", \"disableFlag\": false, \"rdmDeleteFlag\": 0, \"securityLevel\": \"internal\", \"lastUpdateTime\": 1688108575000, \"rdmExtensionType\": \"Tenant\"}, \"creator\": \"XDM_Developer 93172bbfd0f64437956d4c9de9345386\", \"extAttrs\": [{\"name\": \"ExtString\", \"type\": \"STRING\", \"value\": \"0123\"}, {\"name\": \"ExtDouble\", \"type\": \"DECIMAL\"}], \"modifier\": \"XDM_Developer 93172bbfd0f64437956d4c9de9345386\", \"className\": \"ExtDataModel\", \"createTime\": 1693367976851, \"extAttrMap\": {}, \"rdmVersion\": 1, \"rdmDeleteFlag\": 0, \"lastUpdateTime\": 1693367976851, \"rdmExtensionType\": \"ExtDataModel\"}", "task_no": 1, "task_status": "success" }, { "result": "{\"id\": 535837830857887744, \"tenant\": {\"id\": -1, \"code\": \"basicTenant\", \"name\": \"basicTenant\", \"creator\": \"xdmAdmin\", \"modifier\": \"xdmAdmin\", \"className\": \"Tenant\", \"createTime\": 1688108575000, \"dataSource\": \"DefaultDataSource\", \"rdmVersion\": 1, \"description\": \"默认租户\", \"disableFlag\": false, \"rdmDeleteFlag\": 0, \"securityLevel\": \"internal\", \"lastUpdateTime\": 1688108575000, \"rdmExtensionType\": \"Tenant\"}, \"creator\": \"XDM_Developer 93172bbfd0f64437956d4c9de9345386\", \"extAttrs\": [{\"name\": \"ExtString\", \"type\": \"STRING\", \"value\": \"1234056789\"}, {\"name\": \"ExtDouble\", \"type\": \"DECIMAL\"}], \"modifier\": \"XDM_Developer 93172bbfd0f64437956d4c9de9345386\", \"className\": \"ExtDataModel\", \"createTime\": 1692774494000, \"extAttrMap\": {}, \"rdmVersion\": 38, \"rdmDeleteFlag\": 0, \"lastUpdateTime\": 1693367978040, \"rdmExtensionType\": \"ExtDataModel\"}", "task_no": 2, "task_status": "success" } ], "task_count": 2 } ], "errors": [] } 异步提交 { "result": "SUCCESS", "data": [], "errors": [] }
  • 请求示例 同步提交 PUT https://dme.cn-north-4.huaweicloud.com/rdm_fce01234567d41828cf3473b07fa7ae2_app/services/rdm/basic/api/v1/transaction-apis/transactions/538322343718555649 X-Auth-Token: ABCDEFJ.... 异步提交 v1版本请求示例: PUT https://dme.cn-north-4.huaweicloud.com/rdm_fce01234567d41828cf3473b07fa7ae2_app/services/rdm/basic/api/v1/transaction-apis/transactions/async/538322343718555649 X-Auth-Token: ABCDEFJ.... v2版本请求示例: PUT https://dme.cn-north-4.huaweicloud.com/rdm_fce01234567d41828cf3473b07fa7ae2_app/services/rdm/basic/api/v2/transaction-apis/transactions/async/538322343718555650?api_count=2 X-Auth-Token: ABCDEFJ....
  • URI 同步提交 URI格式: PUT http://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/v1/transaction-apis/transactions/{transaction-id} 参数说明: 表1 URI参数说明 参数 是否必填 参数类型 描述 Endpoint 是 String 承载REST服务端点的服务器域名或IP地址。 appID 是 String 应用ID。 transaction-id 是 Long 事务型任务ID,即步骤1:创建事务型任务返回的transactionId。 异步提交 URI格式: v1版本:PUT http://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/v1/transaction-apis/transactions/async/{transaction-id} v2版本:PUT http://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/v2/transaction-apis/transactions/async/{transaction_id}?api_count=N 参数说明: 表2 URI参数说明 参数 是否必填 参数类型 描述 Endpoint 是 String 承载REST服务端点的服务器域名或IP地址。 appID 是 String 应用ID。 transaction-id 是 Long 说明: 仅v1版本接口需要配置此参数。 事务型任务ID,即步骤1:创建事务型任务返回的transactionId。 transaction_id 是 Long 说明: 仅v2版本接口需要配置此参数。 事务型任务ID,即步骤1:创建事务型任务返回的transactionId。 api_count 是 Integer 说明: 仅v2版本接口需要配置此参数。 需要提交执行原子接口的数量。 该参数会以“?api_count=N”格式拼接在URI后面,其中“N”表示需要提交执行原子接口的数量。
  • 入参 POST http://{Endpoint}/rdm_{appID}_app/services/dynamic/api/batchGet { "params": { "ids": [ "XXXXXXXXXX", "XXXXXXXXXX" ] } } 其中,{Endpoint}表示数据建模引擎所在域名或IP地址,{appID}表示应用ID。
  • 入参示例 POST http://dme.cn-north-4.huaweicloud.com/rdm_01a2b2c4764d4e00f123g345fd9baa9f_app/services/dynamic/api/batchGet "params": { "ids": [ "455304697733976064", "455304645330341888" ] } }
  • 出参示例 { "result": "SUCCESS", "data": [ { "id": "455304645330341888", "creator": "test1 3c03e719256a427eb9277b64fcXXXXXX", "modifier": "test1 3c03e719256a427eb9277b64fcXXXXXX", "createTime": "2023-01-13T01:38:07.000+00:00", "lastUpdateTime": "2023-01-13T01:38:07.000+00:00", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "People", "tenant": { "id": "-1", "creator": "xdmAdmin", "modifier": "xdmAdmin", "createTime": "2022-08-03T11:27:44.000+00:00", "lastUpdateTime": "2022-08-03T11:27:44.000+00:00", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "Tenant", "tenant": null, "className": "Tenant", "name": "basicTenant", "description": "默认租户", "kiaguid": null, "securityLevel": "internal", "code": "basicTenant", "disableFlag": false, "dataSource": null }, "className": "People", "name": "李四", "description": null, "kiaguid": null, "securityLevel": "internal", "sex": "男", "age": 20 }, { "id": "455304697733976064", "creator": "test1 3c03e719256a427eb9277b64fcXXXXXX", "modifier": "test1 3c03e719256a427eb9277b64fcXXXXXX", "createTime": "2023-01-13T01:38:19.000+00:00", "lastUpdateTime": "2023-01-13T01:38:19.000+00:00", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "People", "tenant": { "id": "-1", "creator": "xdmAdmin", "modifier": "xdmAdmin", "createTime": "2022-08-03T11:27:44.000+00:00", "lastUpdateTime": "2022-08-03T11:27:44.000+00:00", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "Tenant", "tenant": null, "className": "Tenant", "name": "basicTenant", "description": "默认租户", "kiaguid": null, "securityLevel": "internal", "code": "basicTenant", "disableFlag": false, "dataSource": null }, "className": "People", "name": "李兰", "description": null, "kiaguid": null, "securityLevel": "internal", "sex": "女", "age": 18 } ], "errors": [] }
  • 操作步骤 进入HarddiskTracing_GetDetailList服务详情页切换至“服务开发”页签,可以看到系统已根据步骤1:服务定义中编排的自动生成高效的服务查询脚本。 图1 服务开发 单击“运行”,弹出输入请求参数窗口。 在“PurchaserSN_BarCode”、“PurchaserSN_Item_SN”输入框中输入值,单击“验证环境运行”或“生产环境运行”。 (可选)修改出参名称。 如果对出参展示名称不满意,可在脚本编辑框中进行修改后再次运行。
共100000条