Creating a Work Item Comment

Function

This API is used to create a new comment or reply to a comment for a specified work item. Set category to comment when creating a new comment. Set category to reply and specify parent_id and root_id when replying to an existing comment. Mentioned users will be notified.

Calling Method

For details, see Calling APIs.

Authorization Information

No identity policy-based permission required for calling this API.

URI

POST /v1/ipdprojectservice/projects/{project_id}/issues/{issue_id}/comments

Request Parameters

Response Parameters

Status code: 200

Status code: 400

Example Requests

• Reply to comment 1223642621183123456 under IR work item 1223642181313880065 in project 99719a734aee4f20aae8c8e3bbd4e365. The comment content includes @mention of user c2d89e38a64a466f8f945f595df4402d.

  POST https://{endpoint}/v1/ipdprojectservice/projects/99719a734aee4f20aae8c8e3bbd4e365/issues/1223642181313880065/comments
  
  {
    "category" : "reply",
    "issue_category" : "IR",
    "description" : "<p><span class=\"ql-mention-link\" data-mention-id=\"ForTest\" title=\"ForTest\" mentionchar=\"@\"><span contenteditable=\"false\">@ForTest</span></span>&nbsp;Could you please check?</p>",
    "parent_id" : "1223642621183123456",
    "root_id" : "1223642621183123456",
    "at" : "c2d89e38a64a466f8f945f595df4402d",
    "at_others" : "c2d89e38a64a466f8f945f595df4402d"
  }

• Create a text comment under IR work item 1223642181313880065 in project 99719a734aee4f20aae8c8e3bbd4e365.

  POST http://{{endpoint}}/v1/ipdprojectservice/projects/99719a734aee4f20aae8c8e3bbd4e365/issues/1223642181313880065/comments
  
  {
    "category" : "comment",
    "issue_category" : "IR",
    "description" : "<p>Create a comment.</p>"
  }

Example Responses

Status code: 200

{
  "status" : "success",
  "message" : "",
  "result" : {
    "id" : "1223666764846850049",
    "category" : "Comment",
    "type" : "comment",
    "top" : false,
    "description" : "<p>Create a system comment.</p>",
    "at" : "",
    "issue_id" : "1223642181313880065",
    "top_flag" : false,
    "created_by" : "c2d89e38a64a466f8f945f595df4402d",
    "created_date" : "1769674491368",
    "creator_info" : {
      "user_id" : "c2d89e38a64a466f8f945f595df4402d",
      "user_num_id" : null,
      "user_name" : "ForTest",
      "domain_id" : "aae03ca0d6814951980945b6eeca56cd",
      "domain_name" : null,
      "nick_name" : "ForTest",
      "role_id" : "5c78db505ee3486bb91840023c8e6d6c,d40d48b766d74ad680be222c128498c9",
      "role_name" : "Project manager, project administrator.",
      "role_code" : "Project manager,project_admin"
    }
  }
}

Status code: 400

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

SDK Sample Code

The SDK sample code is as follows.

Java

• Reply to comment 1223642621183123456 under IR work item 1223642181313880065 in project 99719a734aee4f20aae8c8e3bbd4e365. The comment content includes @mention of user c2d89e38a64a466f8f945f595df4402d.

  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 55

  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 CreateIpdIssueCommentsSolution { 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(); CreateIpdIssueCommentsRequest request = new CreateIpdIssueCommentsRequest(); request.withProjectId("{project_id}"); request.withIssueId("{issue_id}"); CommentCreateVO body = new CommentCreateVO(); body.withAt("c2d89e38a64a466f8f945f595df4402d"); body.withRootId("1223642621183123456"); body.withParentId("1223642621183123456"); body.withDescription("<p><span class="ql-mention-link" data-mention-id="ForTest" title="ForTest" mentionchar="@"><span contenteditable="false">@ForTest</span></span>&nbsp;Could you please check?</p>"); body.withIssueCategory("IR"); body.withCategory(CommentCreateVO.CommentCreateVO.fromValue("reply")); request.withBody(body); try { CreateIpdIssueCommentsResponse response = client.createIpdIssueComments(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()); } } }

• Create a text comment under IR work item 1223642181313880065 in project 99719a734aee4f20aae8c8e3bbd4e365.

  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 CreateIpdIssueCommentsSolution { 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(); CreateIpdIssueCommentsRequest request = new CreateIpdIssueCommentsRequest(); request.withProjectId("{project_id}"); request.withIssueId("{issue_id}"); CommentCreateVO body = new CommentCreateVO(); body.withDescription("<p>Create a comment.</p>"); body.withIssueCategory("IR"); body.withCategory(CommentCreateVO.CommentCreateVO.fromValue("comment")); request.withBody(body); try { CreateIpdIssueCommentsResponse response = client.createIpdIssueComments(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

• Reply to comment 1223642621183123456 under IR work item 1223642181313880065 in project 99719a734aee4f20aae8c8e3bbd4e365. The comment content includes @mention of user c2d89e38a64a466f8f945f595df4402d.

  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

  # 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 = CreateIpdIssueCommentsRequest() request.project_id = "{project_id}" request.issue_id = "{issue_id}" request.body = CommentCreateVO( at="c2d89e38a64a466f8f945f595df4402d", root_id="1223642621183123456", parent_id="1223642621183123456", description="<p><span class="ql-mention-link" data-mention-id="ForTest" title="ForTest" mentionchar="@"><span contenteditable="false">@ForTest</span></span>&nbsp;Could you please check?</p>", issue_category="IR", category="reply" ) response = client.create_ipd_issue_comments(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg)

• Create a text comment under IR work item 1223642181313880065 in project 99719a734aee4f20aae8c8e3bbd4e365.

  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 = CreateIpdIssueCommentsRequest() request.project_id = "{project_id}" request.issue_id = "{issue_id}" request.body = CommentCreateVO( description="<p>Create a comment.</p>", issue_category="IR", category="comment" ) response = client.create_ipd_issue_comments(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

• Reply to comment 1223642621183123456 under IR work item 1223642181313880065 in project 99719a734aee4f20aae8c8e3bbd4e365. The comment content includes @mention of user c2d89e38a64a466f8f945f595df4402d.

  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 55 56 57 58 59 60 61 62 63

  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.CreateIpdIssueCommentsRequest{} request.ProjectId = "{project_id}" request.IssueId = "{issue_id}" atCommentCreateVo:= "c2d89e38a64a466f8f945f595df4402d" rootIdCommentCreateVo:= "1223642621183123456" parentIdCommentCreateVo:= "1223642621183123456" descriptionCommentCreateVo:= "<p><span class="ql-mention-link" data-mention-id="ForTest" title="ForTest" mentionchar="@"><span contenteditable="false">@ForTest</span></span>&nbsp;Could you please check?</p>" issueCategoryCommentCreateVo:= "IR" categoryCommentCreateVo:= model.GetCommentCreateVoCategoryEnum().REPLY request.Body = &model.CommentCreateVo{ At: &atCommentCreateVo, RootId: &rootIdCommentCreateVo, ParentId: &parentIdCommentCreateVo, Description: &descriptionCommentCreateVo, IssueCategory: &issueCategoryCommentCreateVo, Category: &categoryCommentCreateVo, } response, err := client.CreateIpdIssueComments(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } }

• Create a text comment under IR work item 1223642181313880065 in project 99719a734aee4f20aae8c8e3bbd4e365.

  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 55 56 57

  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.CreateIpdIssueCommentsRequest{} request.ProjectId = "{project_id}" request.IssueId = "{issue_id}" descriptionCommentCreateVo:= "<p>Create a comment.</p>" issueCategoryCommentCreateVo:= "IR" categoryCommentCreateVo:= model.GetCommentCreateVoCategoryEnum().COMMENT request.Body = &model.CommentCreateVo{ Description: &descriptionCommentCreateVo, IssueCategory: &issueCategoryCommentCreateVo, Category: &categoryCommentCreateVo, } response, err := client.CreateIpdIssueComments(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

Error Codes

See Error Codes.