文档首页/ 需求管理 CodeArts Req/ API参考/ API/ Scrum项目的工作项/ 更新工作项评论 - UpdateScrumMyIssueNotes
更新时间:2026-10-22 GMT+08:00
分享

更新工作项评论 - UpdateScrumMyIssueNotes

功能介绍

更新工作项评论。

调用方法

请参见如何调用API。

授权信息

当前API调用无需身份策略权限。

URI

POST /v2/workitem/issue-note

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及。

取值范围:

长度为10~32768个字符。

默认取值:

不涉及。

表2 请求Body参数

参数

是否必选

参数类型

描述

id

是

String

参数解释:

工作项id,可通过高级查询工作项接口获取,响应消息体中的id字段的值就是工作项id。

约束限制:

长度在1位到10位之间的纯数字。

取值范围:

最小长度:1,最大长度:10。

默认取值:

不涉及。

notes

是

String

参数解释:

工作项的评论内容。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

projectUUId

是

String

参数解释:

项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。

约束限制:

由数字和英文组成的32字符串。

取值范围:

不涉及。

默认取值:

不涉及。

type

否

String

参数解释:

工作项所属项目类型。

约束限制:

不涉及。

取值范围:

scrum。

默认取值:

不涉及。

noteId

是

String

参数解释:

工作项的评论id。通过获取工作项的评论V2接口查询工作项的评论信息,返回数据的comments中的id为评论id。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

result

result object

参数解释:

返回结果。

取值范围:

不涉及。

status

String

参数解释:

返回状态。

取值范围:

success:返回成功。

error:返回失败。

表4 result

参数

参数类型

描述

status

String

参数解释:

返回更新状态。

取值范围:

success:更新成功。

error:更新失败。

请求示例

POST http://{endpoint}/v2/workitem/issue-note

{
  "id" : 9206017,
  "noteId" : 87298751,
  "notes" : "TEST",
  "projectUUId" : "a8ac165097ff4e42bcfb234dd27d30a6",
  "type" : "scrum"
}

响应示例

状态码:200

{
  "result" : {
    "status" : "success"
  },
  "status" : "success"
}

SDK代码示例

SDK代码示例如下。

Java

 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
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.*;


public class UpdateScrumMyIssueNotesSolution {

    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();
        UpdateScrumMyIssueNotesRequest request = new UpdateScrumMyIssueNotesRequest();
        UpdateCommentsRequest body = new UpdateCommentsRequest();
        body.withNoteId(87298751);
        body.withType("scrum");
        body.withProjectUUId("a8ac165097ff4e42bcfb234dd27d30a6");
        body.withNotes("TEST");
        body.withId(9206017);
        request.withBody(body);
        try {
            UpdateScrumMyIssueNotesResponse response = client.updateScrumMyIssueNotes(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

 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
# 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 = UpdateScrumMyIssueNotesRequest()
        request.body = UpdateCommentsRequest(
            note_id=87298751,
            type="scrum",
            project_uu_id="a8ac165097ff4e42bcfb234dd27d30a6",
            notes="TEST",
            id=9206017
        )
        response = client.update_scrum_my_issue_notes(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

 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
54
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.UpdateScrumMyIssueNotesRequest{}
	request.Body = &model.UpdateCommentsRequest{
		NoteId: int32(87298751),
		Type: "scrum",
		ProjectUUId: "a8ac165097ff4e42bcfb234dd27d30a6",
		Notes: "TEST",
		Id: int32(9206017),
	}
	response, err := client.UpdateScrumMyIssueNotes(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

更新工作项评论接口成功的响应。

错误码

请参见错误码。

相关文档