文档首页/ 工业数字模型驱动引擎/ API参考/ API/ 数据建模引擎/ 数据分类管理/ 添加数据分类 - AddToCategory
更新时间：2026-07-28 GMT+08:00
查看PDF
分享

添加数据分类 - AddToCategory

功能介绍

本接口用于将数据实例添加到指定分类。当需要对零部件、设备、物料等数据实例进行归类管理（如按功能模块、产品线、工艺类型等维度分类）时，可调用本接口建立实例与分类的关联关系。

  • 当实例不存在时，系统将抛出异常。

  • 当实例与指定分类已存在关联关系时，系统将不重复添加，返回值为0。

  • 当实例与指定分类首次建立关联时，返回值为1。

接口约束

  • 目标数据模型已在应用设计态配置了“数据分类管理”功能。

  • 待添加分类的数据实例必须已存在，且未被删除。

  • 待关联的分类实例必须已存在，且未被删除。

调试

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

授权信息

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

identifier

是

String

参数解释：

应用的唯一标识。

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

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

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

约束限制：

不涉及。

取值范围：

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

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

默认取值：

不涉及。

modelName

是

String

参数解释：

数据模型的英文名称。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

IAM用户的token。

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表3 请求Body参数

参数

是否必选

参数类型

描述

applicationId

否

String

参数解释：

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

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

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

params

是

DataCategoryDTO object

参数解释：

请求参数对象，包含待操作分类的数据实例信息和目标分类信息。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表4 DataCategoryDTO

参数

是否必选

参数类型

描述

categoryable

否

ObjectReferenceParamDTO object

参数解释：

待添加分类的数据实例引用信息，即被分类的目标对象。例如某零部件实例、某设备实例等。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

category

否

ObjectReferenceParamDTO object

参数解释：

目标分类实例引用信息，即继承自AbstractCategory的模型实例。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

modifier

否

String

参数解释：

更新者账号，用于记录执行本次分类添加操作的用户信息。

若不指定，默认使用当前调用者账号。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

当前调用者账号。
表5 ObjectReferenceParamDTO

参数

是否必选

参数类型

描述

id

是

String

参数解释：

数据实例ID，用于唯一标识引用的数据实例。

获取方法请参见分页查询实例 - ShowFindUsingPost。

约束限制：

不涉及。

取值范围：

-9223372036854775808到9223372036854775807的整数。

默认取值：

不涉及。

clazz

否

String

参数解释：

类名，用于指定引用对象的类类型。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表6 响应Body参数

参数

参数类型

描述

result

String

参数解释：

请求处理结果状态。

取值范围：

  • SUCCESS：请求成功。

  • FAIL：请求失败。

data

Array of integers

参数解释：

影响数据数量，表示本次操作的结果。

取值范围：

不涉及。

errors

Array of strings

参数解释：

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

取值范围：

不涉及。

请求示例

示例：为数据实例添加分类

为数据实例ID为1的DataCategoryableModel实例添加分类ID为1的MyCategory分类。

POST https://dme.cn-north-4.huaweicloud.com/rdm_04219627d6794f37ae26e8aba250415d_app/publicservices/api/DataCategoryableModel/addToCategory

{
  "params" : {
    "categoryable" : {
      "id" : "1",
      "clazz" : "DataCategoryableModel"
    },
    "category" : {
      "id" : "1",
      "clazz" : "MyCategory"
    }
  }
}

响应示例

状态码：200

OK，表示请求成功。

{
  "result" : "SUCCESS",
  "data" : [ 1 ],
  "errors" : [ ]
}

状态码

状态码

描述

200

OK，表示请求成功。

错误码

请参见错误码。

父主题： 数据分类管理

相关文档