文档首页/ 需求管理 CodeArts Req/ API参考/ API/ Scrum项目的工作项/ 保存项目模板
更新时间：2025-09-10 GMT+08:00
在线调试
CLI示例
查看PDF
分享

保存项目模板

功能介绍

保存项目模板。

调用方法

请参见如何调用API。

URI

POST /v2/project-template/template

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

必传。

取值范围：

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

默认取值：

不涉及。
表2 请求Body参数

参数

是否必选

参数类型

描述

project_id

否

String

参数解释：

项目的32位uuid，项目唯一标识，通过查询项目列表接口获取，响应消息体中的project_id字段的值就是项目ID。

约束限制：

由数字和字母组成的32位字符串。

取值范围：

不涉及。

默认取值：

不涉及。

name

否

String

参数解释：

模板名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

is_public

否

Integer

参数解释：

设置是否为默认模板。

约束限制：

不涉及。

取值范围：

0（不是默认模板）

1（是，默认模板）

默认取值：

不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

result

result object

参数解释：

返回结果。

status

String

参数解释：

返回状态。

取值范围：

不涉及。
表4 result

参数

参数类型

描述

id

Integer

参数解释：

模板id。

取值范围：

不涉及。

name

String

参数解释：

模板名称。

取值范围：

不涉及。

type

String

参数解释：

模板类型。

取值范围：

"scrum"。

请求示例

创建名字为234548的模板

{endpoint}/v2/project-template/template?_=1753238263835

{
  "project_id" : "5192de5eb435430c8cd41c6ae6028848",
  "name" : "234548",
  "is_public" : 1
}

响应示例

状态码：200

保存项目模板接口成功的响应。

{
  "result" : {
    "id" : 384846,
    "name" : "234548",
    "type" : "scrum"
  },
  "status" : "success"
}

状态码

状态码

描述

200

保存项目模板接口成功的响应。

错误码

请参见错误码。