文档首页/ 工业数字模型驱动引擎/ API参考/ API/ 数据建模引擎/ 基础数据服务/ 根据唯一键为“是”的基本属性查询实例 - ShowGetByUniqueKey
更新时间：2026-07-28 GMT+08:00
查看PDF
分享

根据唯一键为“是”的基本属性查询实例 - ShowGetByUniqueKey

功能介绍

当数据模型中存在“唯一键”为“是”的基本属性时，可根据该属性查询实例数据。

在调用本接口前，请确保目标数据模型已满足实例化条件：

  1. 已在应用设计态完成数据模型（数据实体或关系实体）的创建与发布。具体操作请参见创建数据实体、创建关系实体和应用发布。

  2. 已将对应应用成功部署至运行态。具体操作请参见部署应用。

接口约束

数据模型中必须存在“唯一键”为“是”的基本属性，否则无法使用此接口。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

POST /rdm_{identifier}_app/publicservices/api/{modelName}/{getUniqueFieldMethod}

表1 路径参数

参数

是否必选

参数类型

描述

identifier

是

String

参数解释：

应用的唯一标识。

  • 于2023年06月01日之前创建的应用，其唯一标识为该应用的名称。

  • 于2023年06月01日之后创建的应用，其唯一标识为该应用的ID。

获取方法请参见获取运行服务清单 - ListEnvs。

约束限制：

不涉及。

取值范围：

  • 于2023年06月01日之前创建的应用：由英文字母和数字组成，长度为1-36个字符。

  • 于2023年06月01日之后创建的应用：由英文字母和数字组成，且长度为32个字符。

默认取值：

不涉及。

modelName

是

String

参数解释：

数据模型的英文名称。

约束限制：

不涉及。

取值范围：

以大写字母开头，只能包含字母、数字、“_”，且长度为1-60个字符。

默认取值：

不涉及。

getUniqueFieldMethod

是

String

参数解释：

动态方法名称，格式为：getBy{uniqueName}。

uniqueName：表示“唯一键”为“是”的基本属性英文名称。

示例：

  • 如唯一键属性英文名称为uniqueKey，则方法名为getByUniqueKey。

  • 如唯一键属性英文名称为code，则方法名为getByCode。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

IAM用户的token。

获取方法请参见获取IAM用户Token。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表3 请求Body参数

参数

是否必选

参数类型

描述

applicationId

否

String

参数解释：

应用ID，用于指定实例所属的应用。

当URL路径中已能明确应用上下文时，此参数可不传。

获取方法请参见获取租户下的应用清单 - ListApps。

约束限制：

不涉及。

取值范围：

由英文字母和数字组成，且长度固定为32个字符。

默认取值：

不涉及。

params

是

PersistableModelUniqueKeyDTO object

参数解释：

请求参数对象。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表4 PersistableModelUniqueKeyDTO

参数

是否必选

参数类型

描述

decrypt

否

Boolean

参数解释：

是否加密。

约束限制：

不涉及。

取值范围：

  • true：加密。

  • false：不加密。

默认取值：

false。

uniqueKey

是

String

参数解释：

数据模型的唯一键约束属性值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

result

String

参数解释：

请求处理结果状态。

取值范围：

  • SUCCESS：请求成功。

  • FAIL：请求失败。

data

Array of PersistableModelViewDTO objects

参数解释：

请求数据。

取值范围：

不涉及。

errors

Array of strings

参数解释：

异常信息列表。当result为FAIL时，返回具体的错误描述，包含失败原因及建议处理方式。

取值范围：

不涉及。
表6 PersistableModelViewDTO

参数

参数类型

描述

className

String

参数解释：

类名，表示数据实例的具体类类型。

取值范围：

不涉及。

createTime

String

参数解释：

创建时间。使用UTC+0时间格式，格式为yyyy-MM-ddTHH:mm:ss.SSSZ。

取值范围：

不涉及。

creator

String

参数解释：

创建者账号。

取值范围：

不涉及。

id

String

参数解释：

数据实例的唯一标识。

取值范围：

-9223372036854775808到9223372036854775807的整数。

rdmDeleteFlag

Integer

参数解释：

软删除标识，用于标识实例是否已被逻辑删除。

取值范围：

  • 0：表示未删除。

  • 1：表示已删除。

rdmExtensionType

String

参数解释：

扩展类型，表示数据模型的具体扩展类型。

取值范围：

不涉及。

rdmVersion

Integer

参数解释：

系统版本号，用于标识实例的版本信息。

取值范围：

不涉及。

modifier

String

参数解释：

更新者账号。

取值范围：

不涉及。

lastUpdateTime

AnyType

参数解释：

最后更新时间。使用UTC+0时间格式，格式为yyyy-MM-ddTHH:mm:ss.SSSZ。

取值范围：

不涉及。

tenant

TenantViewDTO object

参数解释：

租户信息，表示实例所属的租户详情。

取值范围：

不涉及。

uniqueKey

String

参数解释：

数据模型的唯一键属性。

取值范围：

不涉及。
表7 TenantViewDTO

参数

参数类型

描述

className

String

参数解释：

租户对象的类名。

取值范围：

不涉及。

code

String

参数解释：

租户编码，用于多租户场景下的租户唯一标识。

取值范围：

不涉及。

createTime

String

参数解释：

租户对象的创建时间。使用UTC+0时间格式，格式为yyyy-MM-ddTHH:mm:ss.SSSZ。

取值范围：

不涉及。

creator

String

参数解释：

租户对象的创建者账号。

取值范围：

不涉及。

dataSource

String

参数解释：

租户使用的数据源名称，用于多租户数据隔离。

取值范围：

不涉及。

description

String

参数解释：

租户描述信息。

取值范围：

不涉及。

disableFlag

Boolean

参数解释：

租户失效标识，用于标识租户是否已失效。

取值范围：

  • true：失效。

  • false：未失效（默认）。

id

String

参数解释：

租户的唯一标识。

取值范围：

-9223372036854775808到9223372036854775807的整数。

kiaguid

String

参数解释：

租户KIA密级。

取值范围：

不涉及。

lastUpdateTime

String

参数解释：

租户的最后更新时间。使用UTC+0时间格式，格式为yyyy-MM-ddTHH:mm:ss.SSSZ。

取值范围：

不涉及。

modifier

String

参数解释：

租户的更新者账号。

取值范围：

不涉及。

name

String

参数解释：

租户中文名称。

取值范围：

不涉及。

nameEn

String

参数解释：

租户英文名称。

取值范围：

不涉及。

rdmDeleteFlag

Integer

参数解释：

软删除标识。

取值范围：

  • 0：表示未删除。

  • 1：表示已删除。

rdmExtensionType

String

参数解释：

租户扩展类型。

取值范围：

不涉及。

rdmVersion

Integer

参数解释：

租户对象的系统版本号。

取值范围：

不涉及。

securityLevel

String

参数解释：

租户安全密级，用于标识租户信息的安全等级。

取值范围：

  • internal：内部公开。

  • secret：秘密。

  • confidential：机密。

  • top_secret：绝密。

tenant

TenantViewDTO object

参数解释：

租户信息，表示当前租户的父租户信息。

取值范围：

不涉及。

请求示例

示例：根据唯一键查询模型实例数据

根据唯一键属性（uniqueKey）查询数据实例，此处构建查询条件的唯一键值为unionKey instance。

POST https://dme.cn-north-4.huaweicloud.com/rdm_04219627d6794f37ae26e8aba250415d_app/publicservices/api/PersistableModel/getByUniqueKey

{
  "applicationId" : "04219627d6794f37ae26e8aba250415d",
  "params" : {
    "decrypt" : false,
    "uniqueKey" : "unionKey instance"
  }
}

响应示例

状态码：200

OK，表示请求成功。

{
  "result": "SUCCESS",
  "data": [
    {
      "className": "AircraftModel",
      "createTime": 2023-09-27T06:18:03.000+0000,
      "creator": "test1",
      "id": "553535480021389300",
      "rdmDeleteFlag": 1,
      "rdmExtensionType": "AircraftModel",
      "rdmVersion": 1,
      "modifier": "test1",
      "lastUpdateTime": 2023-09-27T06:18:03.000+0000,
      "tenant": {
        "className": "Tenant",
        "code": "basicTenant",
        "createTime": 2023-09-27T06:18:03.000+0000,
        "creator": "test1",
        "dataSource": "DefaultDataSource",
        "description": "默认租户",
        "disableFlag": false,
        "id": "-1",
        "kiaguid": "string",
        "lastUpdateTime": 2023-09-27T06:18:03.000+0000,
        "modifier": "test1",
        "name": "basicTenant",
        "rdmDeleteFlag": 1,
        "rdmExtensionType": "Tenant",
        "rdmVersion": 1,
        "securityLevel": "internal",
        "tenant": null
      },
      "uniqueKey": "31415926548645664"
    }
  ],
  "errors": []
}

状态码

状态码

描述

200

OK，表示请求成功。

错误码

请参见错误码。

父主题： 基础数据服务

相关文档