Help Center/ CodeArts Req/ API Reference/ API/ IPD Tag Management/ Querying Tags
Updated on 2026-05-19 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

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 ID of a project, which must be unique.

Obtain the value by calling the Querying the IPD Project List API. The value of id in the response message body is the project ID.

Constraints:

N/A

Value range:

N/A

Default value:

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

title

No

String

Tag name.

label_type

No

String

Definition:

Work item type of a tag. Use commas (,) to separate multiple values.

Constraints:

N/A

Value range:

feature

raw requirement

requirement (R&D requirement)

task

bug

Default value:

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

result

LabelListResponse object

Tag details.

status

String

Definition:

Response status.

Value range:

success: The response is successful.

error: The response failed.

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:

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

Constraints:

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

Value range:

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

label_type

String

Definition:

Work item type of a tag. Use commas (,) to separate multiple values.

Constraints:

N/A

Value range:

feature

raw requirement

requirement (R&D requirement)

task

bug

Default value:

N/A

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error code.

Value range:

N/A

error_msg

String

Definition:

Error description, which is a supplement to error_code.

Value range:

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 code: 400

Response upon a request failure. For example, the user does not have the operation permission or the project does not exist.

{
  "error_code" : "PM.02174103",
  "error_msg" : "No permission."
}

Status Codes

Status Code

Description

200

OK

400

Response upon a request failure. For example, the user does not have the operation permission or the project does not exist.

Error Codes

See Error Codes.

Parent topic: IPD Tag Management