Updated on 2025-09-10 GMT+08:00

Querying Tags

Function

This API is used to query the tag list. Tags are displayed on one page. You can search for tags by title.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

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:

Regular expression: ^[A-Za-z0-9]{32}$

Options:

N/A

Default value:

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

label_type

No

String

Work item type to which a tag belongs. If this parameter is not transferred, tags of all types are queried by default. The options are:

feature,

raw requirement,

requirement (R&D requirement),

task, and

bug.

title

No

String

Tag name.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

result

LabelListResponse object

Tag details.

status

String

Request status.

message

String

Returned error message.

Table 4 LabelListResponse

Parameter

Type

Description

data

Array of LabelEntity objects

Tag list.

total

Integer

Total number of tags.

Table 5 LabelEntity

Parameter

Type

Description

id

String

Definition:

Tag ID, which is the value of id in the response body returned by calling the Querying the Tag List API.

Constraints:

Regular expression: ^([0-9]{18,19})$

Options:

N/A

Default value:

N/A

label_type

String

Definition:

Type of the work item to which the label belongs, corresponding to the type field of the work item.

Constraints:

Minimum length: 0 characters. Maximum length: 32 characters.

Options:

N/A

Default value:

N/A

color

String

Definition:

Tag RGB color.

Constraints:

Minimum length: 0 characters. Maximum length: 16 characters.

Options:

N/A

Default value:

N/A

title

String

Definition:

Tag title.

Constraints:

Minimum length: 2 characters. Maximum length: 256 characters.

Options:

N/A

Default value:

N/A

Example Requests

Querying the tags whose titles contain 11 in a bug

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

Example Responses

Status code: 200

OK

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

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.