更新时间:2025-08-11 GMT+08:00
分享

查询工作项的所有标签

功能介绍

查询工作项的所有标签。

调用方法

请参见如何调用API

URI

GET /v2/issues/query-tags

表1 Query参数

参数

是否必选

参数类型

描述

offset

Integer

参数解释:

分页索引,偏移量,offset是limit的整数倍数。例如,offset为0表示从第一个记录开始,offset为10表示从第11个记录开始。

约束限制:

不涉及。

取值范围:

最小值:0,最大值:10000。

默认取值:

缺省值:0。

limit

Integer

参数解释:

条数,每页显示查询的数量。

约束限制:

不涉及。

取值范围:

最小长度:1,最大长度:10。

默认取值:

10。

name

String

参数解释:

标签名称。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

project_uuid

String

参数解释

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

约束限制

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

取值范围

不涉及。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

最小长度:10,最大长度:32768。

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

result

result object

参数解释:

返回结果。

status

String

参数解释:

返回状态

取值范围:

success:返回成功

error :返回失败

表4 result

参数

参数类型

描述

tags

Array of tags objects

参数解释:

标签。

表5 tags

参数

参数类型

描述

id

Integer

参数解释:

标签id。

取值范围:

不涉及。

name

String

参数解释:

标签名称。

取值范围:

不涉及。

encode_name

String

参数解释:

标签编码名称。

取值范围:

不涉及。

tag_count

Integer

参数解释:

标签数量。

取值范围:

不涉及。

请求示例

{endpoint}/v2/issues/query-tags?project_uuid=5192de5eb435430c8cd41c6ae6028848&_=1753183910332

响应示例

状态码:200

OK

{
  "result" : {
    "tags" : [ {
      "id" : 88486,
      "name" : "2222",
      "encode_name" : "2222",
      "tag_count" : 1
    }, {
      "id" : 88487,
      "name" : "特特",
      "encode_name" : "特特",
      "tag_count" : 1
    } ]
  },
  "status" : "success"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档