# 全量数据服务查询类接口调用示例 #### 背景信息 某汽车整机厂商A通过工业数字模型驱动引擎-数据建模引擎（xDM Foundation，简称xDM-F）构建了一个汽车追溯系统（VehicleTraceabilitySystem），用于对汽车生产过程中的各个环节进行实时追踪和追溯，确保产品质量和供应链的透明度。其中，开发人员在构建汽车追溯系统时，存在如下数据模型结构。 图1汽车追溯系统-数据模型架构 ![](https://support.huaweicloud.com/bestpractice-idme/figure/zh-cn_image_0000002054128314.png "点击放大") #### 前提条件 已在应用设计态创建了如下数据模型，并将这些数据模型部署至应用运行态。 表1汽车追溯系统的数据模型 | 数据模型 | 基本信息 | 基本属性 | |:---|:---|:---| | 数据实体 | - 英文名称：SupplyRecord - 中文名称：供货记录 - 中文描述：存储汽车每个零部件的名称、配件编号、厂家信息、进货数量、进货单价等信息。 - 模型类型：实体模型 - 父模型：BasicObject - 模型分类：业务数据模型 - 表名称：VehicleTraceabilitySystem_SupplyRecord - 同步至LinkX-F：否 - 其他配置项保持默认设置。 | - **PartName属性信息：** - 英文名称：PartName - 中文名称：配件名称 - 英文描述：Part Name - 中文描述：配件名称 - 类型：文本 - 文本长度：100 - 默认值：PartName - 密级：内部公开 - 唯一键：否 - 必填：是 - 列表属性：是 - 值可变：是 - 值存储方式：原值 - 入库：是 - 其他配置项保持默认设置。 - **PartNumber属性信息：** - 属性英文名称：PartNumber - 属性中文名称：配件编号 - 英文描述：Part Number - 中文描述：配件编号 - 类型：文本 - 文本长度：100 - 默认值：PartNumber - 密级：内部公开 - 唯一键：否 - 必填：是 - 列表属性：是 - 值可变：是 - 值存储方式：原值 - 入库：是 - 其他配置项保持默认设置。 - **ManufactureInformation属性信息：** - 属性英文名称：ManufactureInformation - 属性中文名称：厂家信息 - 英文描述：Manufacture Information - 中文描述：厂家信息 - 类型：文本 - 文本长度：100 - 密级：内部公开 - 唯一键：否 - 必填：否 - 列表属性：是 - 值可变：是 - 值存储方式：原值 - 入库：是 - 其他配置项保持默认设置。 - **PurchaseQuantity属性信息：** - 属性英文名称：PurchaseQuantity - 属性中文名称：进货数量 - 英文描述：Purchase Quantity - 中文描述：进货数量 - 类型：整型 - 密级：内部公开 - 唯一键：否 - 必填：否 - 列表属性：是 - 入库：是 - 其他配置项保持默认设置。 | | 数据实体 | - 英文名称：AssembleRecord - 中文名称：组装记录 - 中文描述：存储汽车组装时所需的发动机、底盘、车身、电气设备等零部件信息。 - 模型类型：实体模型 - 父模型：BasicObject - 模型分类：业务数据模型 - 表名称：VehicleTraceabilitySystem_AssembleRecord - 同步至LinkX-F：否 - 其他配置项保持默认设置。 | - **EngineNumber属性信息：** - 属性英文名称：EngineNumber - 属性中文名称：发动机编号 - 英文描述：Engine Number - 中文描述：发动机编号 - 类型：文本 - 文本长度：100 - 默认值：EngineNumber - 密级：内部公开 - 唯一键：否 - 必填：是 - 列表属性：是 - 值可变：是 - 值存储方式：原值 - 入库：是 - 其他配置项保持默认设置。 - **ChassisNumber属性信息：** - 属性英文名称：ChassisNumber - 属性中文名称：底盘编号 - 英文描述：Chassis Number - 中文描述：底盘编号 - 类型：文本 - 文本长度：100 - 默认值：ChassisNumber - 密级：内部公开 - 唯一键：否 - 必填：是 - 列表属性：是 - 值可变：是 - 值存储方式：原值 - 入库：是 - 其他配置项保持默认设置。 - **BodyNumber属性信息：** - 属性英文名称：BodyNumber - 属性中文名称：车身编号 - 英文描述：Body Number - 中文描述：车身编号 - 类型：文本 - 文本长度：100 - 默认值：BodyNumber - 密级：内部公开 - 唯一键：否 - 必填：是 - 列表属性：是 - 值可变：是 - 值存储方式：原值 - 入库：是 - 其他配置项保持默认设置。 - **BrakePadNumber属性信息：** - 属性英文名称：BrakePadNumber - 属性中文名称：刹车片编号 - 英文描述：Brake Pad Number - 中文描述：刹车片编号 - 类型：文本 - 文本长度：100 - 默认值：BrakePadNumber - 密级：内部公开 - 唯一键：否 - 必填：是 - 列表属性：是 - 值可变：是 - 值存储方式：原值 - 入库：是 - 其他配置项保持默认设置。 | | 数据实体 | - 英文名称：ShipmentRecord - 中文名称：发货记录 - 中文描述：存储车辆识别号（VIN）、销售日期、销售价格、销售渠道、销售地点等信息。 - 模型类型：实体模型 - 父模型：BasicObject - 模型分类：业务数据模型 - 表名称：VehicleTraceabilitySystem_ShipmentRecord - 同步至LinkX-F：否 - 其他配置项保持默认设置。 | - **VIN属性信息：** - 属性英文名称：VIN - 属性中文名称：车辆识别号 - 英文描述：Vehicle identification number - 中文描述：车辆识别号 - 类型：文本 - 文本长度：100 - 默认值：VIN - 密级：内部公开 - 唯一键：否 - 必填：是 - 列表属性：是 - 值可变：是 - 值存储方式：原值 - 入库：是 - 其他配置项保持默认设置。 - **SaleDate属性信息：** - 属性英文名称：SaleDate - 属性中文名称：销售日期 - 英文描述：Sale Date - 中文描述：销售日期 - 类型：日期 - 密级：内部公开 - 唯一键：否 - 必填：否 - 列表属性：是 - 值可变：是 - 入库：是 - 其他配置项保持默认设置。 - **SalesPrice属性信息：** - 属性英文名称：SalesPrice - 属性中文名称：销售价格 - 英文描述：Sales Price - 中文描述：销售价格 - 类型：浮点型 - 标度：2 - 密级：内部公开 - 唯一键：否 - 必填：否 - 列表属性：是 - 值可变：是 - 入库：是 - 其他配置项保持默认设置。 - **SalesChannels属性信息：** - 属性英文名称：SalesChannels - 属性中文名称：销售渠道 - 英文描述：Sales Channels - 中文描述：销售渠道 - 类型：文本 - 文本长度：100 - 密级：内部公开 - 唯一键：否 - 必填：否 - 列表属性：是 - 值可变：是 - 值存储方式：原值 - 入库：是 - 其他配置项保持默认设置。 - **SalesSite属性信息：** - 属性英文名称：SalesSite - 属性中文名称：销售地点 - 英文描述：Sales Site - 中文描述：销售地点 - 类型：文本 - 文本长度：100 - 密级：内部公开 - 唯一键：否 - 必填：否 - 列表属性：是 - 值可变：是 - 值存储方式：原值 - 入库：是 - 其他配置项保持默认设置。 | | 关系实体 | - 英文名称：SupplyAssembleLink - 中文名称：供货与组装记录关系 - 中文描述：为SupplyRecord实体和AssembleRecord实体建立多对多关系。 - 模型分类：业务数据模型 - 关系类型：多对多 - 联动更新关系实例：否 - 表名称：VehicleTraceabilitySystem_SupplyAssembleLink_REL - 同步至LinkX-F：否 - 源数据实体名称/别名：SupplyRecord/SupplyRecord - 目标数据实体名称/别名：AssembleRecord/AssembleRecord - 其他配置项保持默认设置。 | - | | 关系实体 | - 英文名称：AssembleShipmentLink - 中文名称：组装与发货记录关系 - 中文描述：为AssembleRecord实体和ShipmentRecord实体建立多对多关系。 - 模型分类：业务数据模型 - 关系类型：多对多 - 联动更新关系实例：否 - 表名称：VehicleTraceabilitySystem_AssembleShipmentLink_REL - 同步至LinkX-F：否 - 源数据实体名称/别名：AssembleRecord/AssembleRecord - 目标数据实体名称/别名：ShipmentRecord/ShipmentRecord - 其他配置项保持默认设置。 | - | #### 示例1：查询发货记录关联的所有组装记录 1. 调用[认证鉴权](https://support.huaweicloud.com/api-idme/idme_api_0005.html)接口，获取用户的Token。 - 请求消息 URI： ``` POST https://{Endpoint}/v3/auth/tokens ``` 请求消息头： ``` Content-Type: application/json ``` 请求Body： ``` { "auth": { "identity": { "methods": ["password"], "password": { "user": { "name": "user_name", "password": "user_password", "domain": { "name": "domain_name" } } } }, "scope": { "project": { "name": "project_name" } } } } ``` 其中，加粗的斜体字段需要根据实际值填写。 - Endpoint：表示承载REST服务端点的服务器域名或IP地址。 - user_name：表示用户名。 - user_password：表示用户登录密码。 - domain_name：表示用户所属的账号名。 - project_name：表示项目名，代表iDME应用的部署区域。 - 响应消息 返回状态码"200 OK"，在响应Header中获取"X-Subject-Token"的值即为Token。如下所示： ``` X-Subject-Token: MIIZmgYJKoZIhvcNAQcCoIIZizCCGYcCAQExDTALBglghkgBZQMEAgEwgXXXXXX... ``` 2. 调用关系实体"AssembleShipmentLink"的queryRelatedObjects接口，查询发货记录关联的所有组装记录。 - 请求消息 URI： ``` POST http://{Endpoint}/rdm_{appID}_app/services/api/AssembleShipmentLink/queryRelatedObjects/100/1 ``` 请求消息头： ``` Content-Type: application/json ``` 请求Body： ``` { "params": { "role": "source", "isNeedTotal": true, "objectId": 701125002182795264 } } ``` 其中，加粗的斜体字段需要根据实际值填写。 - Endpoint：表示承载REST服务端点的服务器域名或IP地址。 - appID：表示应用ID。 - role：表示角色，取值范围：TARGET（目标模型），SOURCE（源模型）。此处设置为"SOURCE"。 - isNeedTotal：表示是否需要查询总记录数。此处设置为"true"。 - objectId：表示role参数值对应的数据实例ID。 - 响应消息 为篇幅起见，这里只展示部分内容。 ``` { "result": "SUCCESS", "data": [ { "id": "701124583796776960", "lastUpdateTime": "2024-11-21T09:38:47.042+0000", "rdmExtensionType": "ShipmentRecord", "className": "ShipmentRecord", "clazz": "ShipmentRecord", "vin": "001" }, { "id": "701124634447192064", "lastUpdateTime": "2024-11-21T09:38:59.118+0000", "rdmExtensionType": "ShipmentRecord", "className": "ShipmentRecord", "clazz": "ShipmentRecord", "vin": "002" } ], "errors": [], "pageInfo": { "curPage": 1, "pageSize": 100, "totalRows": 2, "totalPages": 1 } } ``` #### 示例2：根据供货记录（源端）的配件名称，查询供货记录与发货记录关系 1. 调用[认证鉴权](https://support.huaweicloud.com/api-idme/idme_api_0005.html)接口，获取用户的Token。 - 请求消息 URI： ``` POST https://{Endpoint}/v3/auth/tokens ``` 请求消息头： ``` Content-Type: application/json ``` 请求Body： ``` { "auth": { "identity": { "methods": ["password"], "password": { "user": { "name": "user_name", "password": "user_password", "domain": { "name": "domain_name" } } } }, "scope": { "project": { "name": "project_name" } } } } ``` 其中，加粗的斜体字段需要根据实际值填写。 - Endpoint：表示承载REST服务端点的服务器域名或IP地址。 - user_name：表示用户名。 - user_password：表示用户登录密码。 - domain_name：表示用户所属的账号名。 - project_name：表示项目名，代表iDME应用的部署区域。 - 响应消息 返回状态码"200 OK"，在响应Header中获取"X-Subject-Token"的值即为Token。如下所示： ``` X-Subject-Token: MIIZmgYJKoZIhvcNAQcCoIIZizCCGYcCAQExDTALBglghkgBZQMEAgEwgXXXXXX... ``` 2. 调用关系实体"SupplyAssembleLink"的find接口，根据供货记录（源端）的配件名称，查询供货记录与发货记录关系。 - 请求消息 URI： ``` POST http://{Endpoint}/rdm_{appID}_app/services/api/SupplyAssembleLink/find/100/1 ``` 请求消息头： ``` Content-Type: application/json ``` 请求Body： ``` { "params": { "filter": { "joiner": "and", "conditions": [ { "conditionName": "source.partNumber", "operator": "=", "conditionValues": [ "001" ] } ] }, "isNeedTotal": false } } ``` 其中，加粗的斜体字段需要根据实际值填写。 - Endpoint：表示承载REST服务端点的服务器域名或IP地址。 - appID：表示应用ID。 - joiner：表示连接符，取值范围：on，and和where。此处设置为"and"。 - conditionName：表示查询条件的名称（数据模型的属性英文名称）。 - operator：表示操作符，取值范围：=、like、customLike、in、\<、\>、\>=、\<=和\<\>。此处设置为"="。 - conditionValues：表示查询条件的值。当"operator"参数为"in"时有多值，"operator"为其他操作符时均为单值。 - isNeedTotal：表示是否需要查询总记录数。此处设置为"false"。 - 响应消息 为篇幅起见，这里只展示部分内容。 ``` { "result": "SUCCESS", "data": [ { "id": "701125239454572544", "createTime": "2024-11-21T09:41:23.363+0000", "lastUpdateTime": "2024-11-21T09:41:23.363+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "SupplyAssembleLink", "className": "SupplyAssembleLink", "clazz": "SupplyAssembleLink", "source": { "id": "701124742303719424", "createTime": "2024-11-21T09:39:24.833+0000", "lastUpdateTime": "2024-11-21T09:39:24.833+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "SupplyRecord", "className": "SupplyRecord", "clazz": "SupplyRecord", "partName": "磁盘", "purchaseQuantity": 100, "partNumber": "001", "manufactureInformation": "南流" }, "target": { "id": "701125002182795264", "createTime": "2024-11-21T09:40:26.793+0000", "lastUpdateTime": "2024-11-21T09:40:26.793+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "AssembleRecord", "className": "AssembleRecord", "clazz": "AssembleRecord", "bodyNumber": "001", "brakePadNumber": "001", "chassisNumber": "001", "engineNumber": "001" }, "name": null, "description": null } ], "errors": [], "pageInfo": { "curPage": 1, "pageSize": 100, "totalRows": 0, "totalPages": 0 } } ``` #### 示例3：根据供货记录（源端）的配件名称与厂家信息，查询供货记录与发货记录关系 1. 调用[认证鉴权](https://support.huaweicloud.com/api-idme/idme_api_0005.html)接口，获取用户的Token。 - 请求消息 URI： ``` POST https://{Endpoint}/v3/auth/tokens ``` 请求消息头： ``` Content-Type: application/json ``` 请求Body： ``` { "auth": { "identity": { "methods": ["password"], "password": { "user": { "name": "user_name", "password": "user_password", "domain": { "name": "domain_name" } } } }, "scope": { "project": { "name": "project_name" } } } } ``` 其中，加粗的斜体字段需要根据实际值填写。 - Endpoint：表示承载REST服务端点的服务器域名或IP地址。 - user_name：表示用户名。 - user_password：表示用户登录密码。 - domain_name：表示用户所属的账号名。 - project_name：表示项目名，代表iDME应用的部署区域。 - 响应消息 返回状态码"200 OK"，在响应Header中获取"X-Subject-Token"的值即为Token。如下所示： ``` X-Subject-Token: MIIZmgYJKoZIhvcNAQcCoIIZizCCGYcCAQExDTALBglghkgBZQMEAgEwgXXXXXX... ``` 2. 调用关系实体"SupplyAssembleLink"的find接口，根据供货记录（源端）的配件名称与厂家信息，查询供货记录与发货记录关系。 - 请求消息 URI： ``` POST http://{Endpoint}/rdm_{appID}_app/services/api/SupplyAssembleLink/find/100/1 ``` 请求消息头： ``` Content-Type: application/json ``` 请求Body： ``` { "params": { "filter": { "joiner": "and", "conditions": [ { "conditionName": "source.partNumber", "operator": "=", "conditionValues": [ "001" ] }, { "conditionName": "source.manufacturerInformation", "operator": "=", "conditionValues": [ "南流" ] } ] }, "isNeedTotal": false } } ``` 其中，加粗的斜体字段需要根据实际值填写。 - Endpoint：表示承载REST服务端点的服务器域名或IP地址。 - appID：表示应用ID。 - joiner：表示连接符，取值范围：on，and和where。此处设置为"and"。 - conditionName：表示查询条件的名称（数据模型的属性英文名称）。 - operator：表示操作符，取值范围：=、like、customLike、in、\<、\>、\>=、\<=和\<\>。此处设置为"="。 - conditionValues：表示查询条件的值。当"operator"参数为"in"时有多值，"operator"为其他操作符时均为单值。 - isNeedTotal：表示是否需要查询总记录数。此处设置为"false"。 - 响应消息 为篇幅起见，这里只展示部分内容。 ``` { "result": "SUCCESS", "data": [ { "id": "701125239454572544", "createTime": "2024-11-21T09:41:23.363+0000", "lastUpdateTime": "2024-11-21T09:41:23.363+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "SupplyAssembleLink", "className": "SupplyAssembleLink", "clazz": "SupplyAssembleLink", "source": { "id": "701124742303719424", "createTime": "2024-11-21T09:39:24.833+0000", "lastUpdateTime": "2024-11-21T09:39:24.833+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "SupplyRecord", "className": "SupplyRecord", "clazz": "SupplyRecord", "partName": "磁盘", "purchaseQuantity": 100, "partNumber": "001", "manufactureInformation": "南流" }, "target": { "id": "701125002182795264", "createTime": "2024-11-21T09:40:26.793+0000", "lastUpdateTime": "2024-11-21T09:40:26.793+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "AssembleRecord", "className": "AssembleRecord", "clazz": "AssembleRecord", "bodyNumber": "001", "brakePadNumber": "001", "chassisNumber": "001", "engineNumber": "001" }, "name": null, "description": null } ], "errors": [], "pageInfo": { "curPage": 1, "pageSize": 100, "totalRows": 0, "totalPages": 0 } } ``` #### 示例4：根据组装记录（ShipmentRecord）的车辆识别号，查询发货与组装记录的关系 1. 调用[认证鉴权](https://support.huaweicloud.com/api-idme/idme_api_0005.html)接口，获取用户的Token。 - 请求消息 URI： ``` POST https://{Endpoint}/v3/auth/tokens ``` 请求消息头： ``` Content-Type: application/json ``` 请求Body： ``` { "auth": { "identity": { "methods": ["password"], "password": { "user": { "name": "user_name", "password": "user_password", "domain": { "name": "domain_name" } } } }, "scope": { "project": { "name": "project_name" } } } } ``` 其中，加粗的斜体字段需要根据实际值填写。 - Endpoint：表示承载REST服务端点的服务器域名或IP地址。 - user_name：表示用户名。 - user_password：表示用户登录密码。 - domain_name：表示用户所属的账号名。 - project_name：表示项目名，代表iDME应用的部署区域。 - 响应消息 返回状态码"200 OK"，在响应Header中获取"X-Subject-Token"的值即为Token。如下所示： ``` X-Subject-Token: MIIZmgYJKoZIhvcNAQcCoIIZizCCGYcCAQExDTALBglghkgBZQMEAgEwgXXXXXX... ``` 2. 调用关系实体"AssembleShipmentLink"的find接口，根据组装记录（ShipmentRecord）的车辆识别号，查询发货与组装记录的关系。 - 请求消息 URI： ``` POST http://{Endpoint}/rdm_{appID}_app/services/api/AssembleShipmentLink/find/100/1 ``` 请求消息头： ``` Content-Type: application/json ``` 请求Body： ``` { "params": { "filter": { "joiner": "and", "conditions": [ { "conditionName": "target.vin", "operator": "=", "conditionValues": [ "001" ] }, { "conditionName": "target.salesSite", "operator": "=", "conditionValues": [ "广州" ] } ] }, "isNeedTotal": false } } ``` 其中，加粗的斜体字段需要根据实际值填写。 - Endpoint：表示承载REST服务端点的服务器域名或IP地址。 - appID：表示应用ID。 - joiner：表示连接符，取值范围：on，and和where。此处设置为"and"。 - conditionName：表示查询条件的名称（数据模型的属性英文名称）。 - operator：表示操作符，取值范围：=、like、customLike、in、\<、\>、\>=、\<=和\<\>。此处设置为"="。 - conditionValues：表示查询条件的值。当"operator"参数为"in"时有多值，"operator"为其他操作符时均为单值。 - isNeedTotal：表示是否需要查询总记录数。此处设置为"false"。 - 响应消息 为篇幅起见，这里只展示部分内容。 ``` { "result": "SUCCESS", "data": [ { "id": "701125119333900288", "createTime": "2024-11-21T09:40:54.724+0000", "lastUpdateTime": "2024-11-21T09:40:54.724+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "AssembleShipmentLink", "className": "AssembleShipmentLink", "clazz": "AssembleShipmentLink", "source": { "id": "701125002182795264", "createTime": "2024-11-21T09:40:26.793+0000", "lastUpdateTime": "2024-11-21T09:40:26.793+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "AssembleRecord", "className": "AssembleRecord", "clazz": "AssembleRecord", "bodyNumber": "001", "brakePadNumber": "001", "chassisNumber": "001", "engineNumber": "001" }, "target": { "id": "701124583796776960", "createTime": "2024-11-21T09:38:47.042+0000", "lastUpdateTime": "2024-11-21T09:38:47.042+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "ShipmentRecord", "className": "ShipmentRecord", "clazz": "ShipmentRecord", "vin": "001", "salesPrice": "100.00", "saleDate": "2024-11-21T09:38:22.000+0000", "salesChannels": "线上", "salesSite": "广州" }, "name": null, "description": null } ], "errors": [], "pageInfo": { "curPage": 1, "pageSize": 100, "totalRows": 0, "totalPages": 0 } } ```