文档首页> 工业数字模型驱动引擎> API参考> API> 数据建模引擎> 基础数据服务> 根据唯一键为“是”的属性查询实例
更新时间:2024-03-15 GMT+08:00
分享

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

功能介绍

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

identifier

String

应用ID。

modelName

String

数据模型的英文名称。

getUniqueFieldMethod

String

方法名称,格式为:getBy{uniqueName}。

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

IAM用户的token。

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

表3 请求Body参数

参数

是否必选

参数类型

描述

applicationId

String

应用ID。

params

PersistableModelUniqueKeyDTO object

参数对象。

表4 PersistableModelUniqueKeyDTO

参数

是否必选

参数类型

描述

decrypt

Boolean

是否加密。

  • true:加密。

  • false:不加密。

uniqueKey

String

示例模型的唯一键属性值。

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

result

String

请求结果。

data

Array of PersistableModelViewDTO objects

请求数据。

errors

Array of strings

异常信息。

表6 PersistableModelViewDTO

参数

参数类型

描述

className

String

类名。

createTime

String

创建时间。

creator

String

创建者。

id

String

唯一标识。

rdmDeleteFlag

Integer

软删除标识,参数值为0或1。

  • 0:表示未删除。

  • 1:表示已删除。

rdmExtensionType

String

扩展类型。

rdmVersion

Integer

系统版本。

modifier

String

修改人。

lastUpdateTime

Object

最后更新时间。

tenant

TenantViewDTO object

租户信息。

uniqueKey

String

示例模型中定义的唯一键属性。

表7 TenantViewDTO

参数

参数类型

描述

className

String

类名。

code

String

租户编码。

createTime

String

创建时间。

creator

String

创建者。

dataSource

String

租户使用的数据源名称。

description

String

描述信息。

disableFlag

Boolean

失效标识。

  • true:失效。

  • false:未失效。

id

String

唯一标识。

kiaguid

String

KIA密级。

lastUpdateTime

String

最后更新时间。

modifier

String

修改人。

name

String

中文名称。

rdmDeleteFlag

Integer

软删除标识,参数值为0或1。

  • 0:表示未删除。

  • 1:表示已删除。

rdmExtensionType

String

扩展类型。

rdmVersion

Integer

系统版本。

securityLevel

String

安全密级。

  • INTERNAL:内部公开。

  • SECRET:秘密。

  • CONFIDENTIAL:机密。

  • TOP_SECRET:绝密。

tenant

TenantViewDTO object

租户信息。

请求示例

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

{
  "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281",
  "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" : "string"
    },
    "uniqueKey" : "31415926548645664"
  } ],
  "errors" : [ ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

分享:

    相关文档

    相关产品