Querying All Tags of a Work Item

Function

This API is used to query all tags of a work item.

Calling Method

For details, see Calling APIs.

URI

GET /v2/issues/query-tags

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Definition: Pagination index. The offset is an integer multiple of limit. For example, if the value of offset is 0, the return starts from the first record. If the value of offset is 10, the return starts from the eleventh record. Constraints: N/A Value range: Minimum value: 0. Maximum value: 10,000. Default value: Default value: 0.
limit	No	Integer	Definition: Number of records displayed on each page. Constraints: N/A Value range: Minimum length: 1 character. Maximum length: 10 characters. Default value: 10
name	No	String	Definition: Tag name. Constraints: N/A Value range: N/A Default value: N/A
project_uuid	Yes	String	Definition: 32-character UUID of a project, which uniquely identifies a project. Obtain the value of this parameter from the project_id field in the response body of the Querying the Project List API. Constraints: The value must contain 32 characters. Digits and letters are allowed. Value range: N/A Default value: N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition : User token. Obtain a token by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. Constraints: Mandatory. Value range: Minimum length: 10 characters. Maximum length: 32,768 characters. Default value: N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
result	result object	Definition: Returned result.
status	String	Definition: Returned status. Value range: success: The API is successfully called. error: The API call failed.

**Table 4** result
Parameter	Type	Description
tags	Array of tags objects	Definition: Tag.

**Table 5** tags
Parameter	Type	Description
id	Integer	Definition: Tag ID. Value range: N/A
name	String	Definition: Tag name. Value range: N/A
encode_name	String	Definition: Tag code name. Value range: N/A
tag_count	Integer	Definition: Number of tags. Value range: N/A

Example Requests

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

Example Responses

Status code: 200

Response to a successful request for querying all tags of a work item.

{
  "result" : {
    "tags" : [ {
      "id" : 88486,
      "name" : "2222",
      "encode_name" : "2222",
      "tag_count" : 1
    }, {
      "id" : 88487,
      "name" : "Special",
      "encode_name" : "&#x7279;&#x7279;",
      "tag_count" : 1
    } ]
  },
  "status" : "success"
}