Updated on 2026-10-27 GMT+08:00

Updating a Tag

Function

This API is used to update a tag. The title and color can be updated.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

codeartsreq:tag:update

Write

-

  • codeartsreq:Model

  • codeartsreq:ProjectId

-

-

URI

PUT /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 API for querying the IPD project list. The value of id in the response message body is the project ID.

Constraints

N/A

Range

A string of 32 characters consisting of letters and digits.

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 API for querying the label list.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

label_type

No

String

Definition

Type of the work item to which the label belongs, corresponding to the type field of the work item, which is an enumeration type. This parameter is not recommended. Use the category_types parameter instead. For custom requirement models, only the category_types parameter can be used.

Constraints

N/A

Range

  • raw requirement: Raw requirement.

  • feature: System feature.

  • requirement: R&D requirement.

  • task: Task.

  • bug: Defect.

Default Value

N/A

color

Yes

String

Definition

Label color. This parameter is optional when it is used as an update parameter.

Constraints

N/A

Range

The available color codes and their descriptions are as follows:

  • #86CAFF: light sky blue

  • #6DDEBB: aquamarine

  • #A6DD82: light green

  • #FAC20A: golden yellow

  • #FA9841: sandy orange

  • #F66F6A: light coral

  • #F3689A: pink

  • #A97AF8: medium purple

  • #71757F: slate gray

  • #5E7CE0: soft blue

  • #207AB3: steel blue

  • #169E6C: sea green

  • #6CA83B: olive green

  • #B58200: dark golden yellow

  • #B54E04: burnt orange

  • #B02121: dark red

  • #AD215B: dark pink

  • #572DB3: deep violet

  • #4F4F4F: dark gray

  • #3C51A6: indigo blue

Default Value

N/A

title

Yes

String

Definition

Label title.

Constraints

1 to 30 characters.

Range

N/A

Default Value

N/A

category_types

Yes

String

Definition

Work item type code.

Constraints

N/A

Range

Multiple work item types are supported, separated by commas (,).

  • System device projects: RR, SF, IR, SR, AR, Task, and Bug.

  • Standalone software projects: RR, SF, IR, US, Task, and Bug.

  • Custom requirement model projects: Obtain the value by calling the Obtaining the Model Tree Configuration API. The code in the response body is the work item type code.

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

status

String

Definition

Response status.

Range

  • success: The response is successful.

  • error: The response fails.

message

String

Response.

result

LabelUpdateResult object

Label update result.

Table 4 LabelUpdateResult

Parameter

Type

Description

category_types

Array of strings

Definition

Code of the work item type to which a label belongs.

color

String

Definition

Label RGB color.

Range

N/A

title

String

Definition

Label title.

Range

N/A

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

Range

N/A

error_msg

String

Definition

Error description, which is a supplement to error_code.

Range

N/A

Example Requests

Updating the tag title

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

{
  "title" : "Tag-RR-01",
  "color" : "#A6DD82",
  "category_types" : "IR"
}

Example Responses

Status code: 200

{
  "status" : "success",
  "message" : "ok",
  "result" : {
    "color" : "#A6DD82",
    "title" : "Tag-RR-01",
    "category_types" : [ "IR" ]
  }
}

Status code: 400

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

SDK Sample Code

The SDK sample code is as follows.

Java

Updating the tag title

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.projectman.v4.region.ProjectManRegion;
import com.huaweicloud.sdk.projectman.v4.*;
import com.huaweicloud.sdk.projectman.v4.model.*;

import java.util.List;
import java.util.ArrayList;

public class UpdateIpdLabelSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        ProjectManClient client = ProjectManClient.newBuilder()
                .withCredential(auth)
                .withRegion(ProjectManRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateIpdLabelRequest request = new UpdateIpdLabelRequest();
        request.withLabelId("{label_id}");
        request.withProjectId("{project_id}");
        LabelParam body = new LabelParam();
        body.withTitle("Tag-RR-01");
        body.withColor("#A6DD82");
        request.withBody(body);
        try {
            UpdateIpdLabelResponse response = client.updateIpdLabel(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Python

Updating the tag title

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkprojectman.v4.region.projectman_region import ProjectManRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkprojectman.v4 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

    client = ProjectManClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(ProjectManRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateIpdLabelRequest()
        request.label_id = "{label_id}"
        request.project_id = "{project_id}"
        request.body = LabelParam(
            title="Tag-RR-01",
            color="#A6DD82"
        )
        response = client.update_ipd_label(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

Updating the tag title

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    projectman "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := projectman.ProjectManClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := projectman.NewProjectManClient(hcClient)

    request := &model.UpdateIpdLabelRequest{}
	request.LabelId = "{label_id}"
	request.ProjectId = "{project_id}"
	request.Body = &model.LabelParam{
		Title: "Tag-RR-01",
		Color: "#A6DD82",
	}
	response, err := client.UpdateIpdLabel(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

More

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

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.