文档首页/需求管理 CodeArts Req/API参考/API/Scrum项目的工作项/修改自定义项目模板名称和描述 - UpdateProjectTemplate
更新时间：2026-02-13 GMT+08:00
在线调试
CLI示例
查看PDF
分享

修改自定义项目模板名称和描述 - UpdateProjectTemplate

功能介绍

修改自定义项目模板名称和描述。

调用方法

请参见如何调用API。

授权信息

当前API调用无需身份策略权限。

URI

PUT /v4/projects/templates/{template_id}

表1 路径参数

参数

是否必选

参数类型

描述

template_id

是

String

参数解释：

模板id，可通过查询工作设置模板V2接口获取，响应消息体中的count字段的值就是模板id。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

约束限制：

必传。

取值范围：

最小长度：10，最大长度：32768。

默认取值：

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

name

否

String

参数解释：

模板名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

description

否

String

参数解释：

模板描述。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

project_template

project_template object

参数解释：

模板信息。

取值范围：

不涉及。

表5 project_template

参数

参数类型

描述

id

Integer

参数解释：

模板id。

取值范围：

不涉及。

name

String

参数解释：

模板名称。

取值范围：

不涉及。

type

String

参数解释：

模板类型。

取值范围：

不涉及。

请求示例

PUT https://{endpoint}/v4/projects/templates/1538

{
  "name" : "12344",
  "description" : ""
}

响应示例

状态码：200

修改自定义项目模板名称和描述接口成功的响应。

{
  "project_template" : {
    "id" : 1538,
    "name" : "12344",
    "type" : null
  }
}

状态码

状态码

描述

200

修改自定义项目模板名称和描述接口成功的响应。

错误码

请参见错误码。

相关文档