文档首页/ 需求管理 CodeArts Req/ API参考/ API/ IPD标签管理/ 查询标签列表
更新时间：2024-11-30 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询标签列表

功能介绍

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

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目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

label_type

String

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

color

String

标签颜色RGB

title

String

标签标题

请求示例

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

{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

错误码

请参见错误码。

父主题： IPD标签管理

相关文档