文档首页/ 需求管理 CodeArts Req/ API参考/ API/ IPD标签管理/ 创建标签
更新时间：2025-07-21 GMT+08:00
在线调试
CLI示例
查看PDF
分享

创建标签

功能介绍

创建标签

调用方法

请参见如何调用API。

URI

POST /v1/ipdprojectservice/projects/{project_id}/tags

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

正则表达式，^[A-Za-z0-9]{32}$。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

label_type

是

String

标签归属的工作项分类，不传该参数时默认查询所有类型下的标签。作为更新参数时无效。

feature：特性

raw requirement：原始需求

requirement：研发需求

task：任务

bug：缺陷

color

是

String

标签颜色，作为更新参数时非必填。可选颜色代码："#86CAFF", "#6DDEBB", "#A6DD82", "#FAC20A",

"#FA9841", "#F66F6A", "#F3689A", "#A97AF8", "#71757F", "#5E7CE0", "#207AB3", "#169E6C", "#6CA83B", "#B58200",

"#B54E04", "#B02121", "#AD215B", "#572DB3", "#4F4F4F", "#3C51A6"

title

是

String

标签标题，最长支持15个字符。作为更新参数时非必填

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

status

String

请求状态

message

String

请求失败原因

result

LabelEntity object

标签详情
表4 LabelEntity

参数

参数类型

描述

id

String

参数解释：

标签id，可通过查询标签列表接口获取，响应消息体中的id字段的值就是标签id。

约束限制：

正则表达式，^([0-9]{18,19})$。

取值范围：

不涉及。

默认取值：

不涉及。

label_type

String

参数解释：

标签所属工作项类型，对应工作项的type字段。

约束限制：

最小长度：0，最大长度：32。

取值范围：

不涉及。

默认取值：

不涉及。

color

String

参数解释：

标签颜色RGB。

约束限制：

最小长度：0，最大长度：16。

取值范围：

不涉及。

默认取值：

不涉及。

title

String

参数解释：

标签标题。

约束限制：

最小长度：2，最大长度：256。

取值范围：

不涉及。

默认取值：

不涉及。

请求示例

创建研发需求的标签

POST https://{endpoint}/v3/projects/b54914d464d1498a97d683ef198ec448/tags

{
  "title" : "Tag-IR-05",
  "color" : "#A6DD82",
  "label_type" : "requirement"
}

响应示例

状态码：200

OK

{
  "status" : "success",
  "message" : "ok",
  "result" : {
    "id" : "1030868827803529217",
    "label_type" : "requirement",
    "color" : "#A6DD82",
    "title" : "Tag-IR-05"
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： IPD标签管理

相关文档