Updated on 2026-05-19 GMT+08:00

Deleting a Tag

Function

This API is used to delete a tag.

Calling Method

For details, see Calling APIs.

URI

DELETE /v1/ipdprojectservice/projects/{project_id}/tags/{label_id}

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

label_id

Yes

String

Definition:

Label ID, which uniquely identifies a label.

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

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

status

String

Definition:

Response status.

Value range:

success: The response is successful.

error: The response failed.

message

String

Response message.

result

LabelEntity object

Tag details.

Table 3 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 4 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

Deleting a Specified Tag

https://{endpoint}/v1/ipdprojectservice/projects/b54914d464d1498a97d683ef198ec448/tags/1030868827803529217

Example Responses

Status code: 200

OK

{
  "status" : "success",
  "message" : "ok",
  "result" : {
    "id" : "1030868827803529217"
  }
}

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.