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

更新文档标题 - UpdateDocument

功能介绍

本接口用于更新结构化文档的标题信息。当文档标题需要随产品版本迭代、工艺变更或项目阶段调整时，可调用本接口修改文档标题。

调用本接口时，需通过document_id或instance_id指定目标文档。

若同时传入document_id和instance_id，优先以document_id定位目标文档。

接口约束

目标数据模型已在应用设计态配置了“结构化文档管理”功能。

调试

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

授权信息

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

URI

PUT /rdm_{identifier}_app/publicservices/api/{modelName}/structured-doc/documents

表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。

约束限制：

不涉及。

取值范围：

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

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

默认取值：

不涉及。

params

是

UpdateDocRequestDto object

参数解释：

请求参数对象，包含待更新文档的标识信息和新的标题内容。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表4 UpdateDocRequestDto

参数

是否必选

参数类型

描述

document_id

是

String

参数解释：

KooPage文档ID，用于唯一标识待更新的结构化文档。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

title

否

String

参数解释：

文档标题，用于指定更新后的文档名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID，用于通过关联的数据模型实例定位待更新的文档。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

modifier

否

String

参数解释：

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

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

当前调用者账号。

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

result

String

参数解释：

请求处理结果状态。

取值范围：

  • SUCCESS：请求成功。

  • FAIL：请求失败。

data

Array of integers

参数解释：

请求数据，返回本次操作影响的记录数。

取值范围：

不涉及。

errors

Array of strings

参数解释：

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

取值范围：

不涉及。

请求示例

示例：更新结构化文档标题

更新文档ID为19619ac0-22ee-405a-bf35-53673efa3267的结构化文档标题为myTitle2。

PUT https://dme.cn-north-4.huaweicloud.com/rdm_04219627d6794f37ae26e8aba250415d_app/publicservices/api/StructuredDocableModel/structured-doc/documents

{
  "params" : {
    "instance_id" : "1",
    "document_id" : "19619ac0-22ee-405a-bf35-53673efa3267",
    "title" : "myTitle2"
  }
}

响应示例

状态码：200

OK，表示请求成功。

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

状态码

状态码

描述

200

OK，表示请求成功。

错误码

请参见错误码。

父主题： 结构化文档管理

相关文档