更新时间:2025-09-10 GMT+08:00

查询标签列表

功能介绍

查询标签列表,不分页,支持按标题搜索。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

label_type

String

标签归属的工作项分类,不传该参数时默认查询所有类型下的标签

feature:特性

raw requirement:原始需求

requirement:研发需求

task:任务

bug:缺陷

title

String

标签名称

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

result

LabelListResponse object

标签详情

status

String

请求状态

message

String

请求错误信息

表4 LabelListResponse

参数

参数类型

描述

data

Array of LabelEntity objects

标签列表

total

Integer

标签总数

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

取值范围:

不涉及。

默认取值:

不涉及。

请求示例

查询缺陷下标题中包含11的标签列表

https://{endpoint}/v1/ipdprojectservice/projects/b54914d464d1498a97d683ef198ec448/tags?title=11&label_type=bug

响应示例

状态码:200

OK

{
  "status" : "success",
  "result" : {
    "data" : [ {
      "id" : "1030082514003210240",
      "label_type" : "bug",
      "color" : "#A97AF8",
      "title" : "Bug11"
    } ],
    "total" : 7
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码