更新时间:2024-09-05 GMT+08:00
分享

查询指定数据实例的标签详情

功能介绍

调用该接口查询指定模型的数据实例对应标签信息。在调用该接口前请确保数据模型具有“标签管理”功能。

接口约束

功能列表勾选了标签管理的模型可以使用该接口。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

identifier

String

参数解释:

应用唯一标识。

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

modelName

String

参数解释:

数据模型的英文名称。

约束限制:

不涉及。

取值范围:

大写字母开头,只能包含字母、数字、"_",且长度为[1-60]个字符。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

IAM用户的token。

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

applicationId

String

参数解释

应用ID。

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

params

PersistObjectIdDTO object

参数解释:

请求参数对象。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表4 PersistObjectIdDTO

参数

是否必选

参数类型

描述

id

String

参数解释:

数据实例ID。

约束限制:

不涉及。

取值范围:

-9223372036854775808到9223372036854775807的整数。

默认取值:

不涉及。

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

result

String

参数解释:

请求结果。

取值范围:

  • SUCCESS:请求成功。

  • FAIL:请求失败。

默认取值:

不涉及。

data

Array of objects

参数解释:

请求数据。

取值范围:

不涉及。

默认取值:

不涉及。

errors

Array of strings

参数解释:

异常信息。

取值范围:

不涉及。

默认取值:

不涉及。

请求示例

POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/TagableModel/queryTag

{
  "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281",
  "params" : {
    "id" : "1"
  }
}

响应示例

状态码: 200

OK

{
  "result" : "SUCCESS",
  "data" : [ {
    "id" : "609779121987260416",
    "creator" : "test1",
    "createTime" : "2023-12-04T11:52:48.000+0000",
    "modifier" : "test1",
    "lastUpdateTime" : "2023-12-04T12:07:59.000+0000",
    "rdmVersion" : 1,
    "rdmDeleteFlag" : 0,
    "rdmExtensionType" : "Tag",
    "tenant" : {
      "id" : "-1",
      "creator" : "xdmAdmin",
      "createTime" : "2023-12-01T01:25:21.000+0000",
      "modifier" : "xdmAdmin",
      "lastUpdateTime" : "2023-12-01T01:25:21.000+0000",
      "rdmVersion" : 1,
      "rdmDeleteFlag" : 0,
      "rdmExtensionType" : "Tenant",
      "tenant" : null,
      "className" : "Tenant",
      "name" : "basicTenant",
      "description" : "默认租户",
      "code" : "basicTenant",
      "disableFlag" : false,
      "dataSource" : "DefaultDataSource"
    },
    "className" : "Tag",
    "name" : null,
    "description" : "测试标签",
    "kiaguid" : null,
    "securityLevel" : "internal",
    "nameCn" : "测试标签",
    "nameEn" : "Tag1",
    "type" : null,
    "group" : {
      "id" : "609778926910181376",
      "creator" : "test1",
      "modifier" : "test1",
      "createTime" : "2024-03-14T08:03:45.000+0000",
      "lastUpdateTime" : "2024-03-14T08:04:17.000+0000",
      "rdmVersion" : 2,
      "rdmDeleteFlag" : 0,
      "rdmExtensionType" : "TagGroup",
      "tenant" : {
        "id\"" : -1,
        "creator" : "xdmAdmin",
        "modifier" : "xdmAdmin",
        "createTime" : "2023-12-01T01:25:21.000+0000",
        "lastUpdateTime" : "2023-12-01T01:25:21.000+0000",
        "rdmVersion" : 1,
        "rdmDeleteFlag" : 0,
        "rdmExtensionType" : "Tenant",
        "tenant" : null,
        "className" : "Tenant",
        "name" : "basicTenant",
        "description" : "默认租户",
        "kiaguid" : null,
        "securityLevel" : "internal",
        "nameEn" : null,
        "code" : "basicTenant",
        "disableFlag" : false,
        "dataSource" : "DefaultDataSource"
      },
      "className" : "TagGroup",
      "name" : null,
      "description" : "这是一个标签",
      "kiaguid" : null,
      "securityLevel" : "internal",
      "color" : {
        "code" : "GRAY",
        "cnName" : "灰色",
        "enName" : "GRAY",
        "alias" : "GRAY"
      },
      "nameCn" : "这是一个标签组",
      "nameEn" : "TagGroup1",
      "rootNode" : null,
      "parentNode" : null,
      "leafFlag" : true,
      "fullPath" : "609778926910181376",
      "rawFullPath" : "609778926910181376"
    }
  } ],
  "errors" : [ ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档