Querying Work Item Comments

Function

This API is used to list comments of a work item, including user-created text comments, user reply comments, and system-generated operation comments (such as status changes, field transitions, etc.). It supports filtering by comment type, sorting by creation time, and paginated queries.

Calling Method

For details, see Calling APIs.

Authorization Information

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

URI

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

Request Parameters

None

Response Parameters

Status code: 200

Status code: 400

Example Requests

Query the first page of comments for work item 1111014158531207168 under project 4f967f6f05554273b0476da123e73b41, with 50 comments per page, including comments, replies, and system operations.

GET https://{endpoint}/v1/ipdprojectservice/projects/4f967f6f05554273b0476da123e73b41/issues/1111014158531207168/comments?date_desc=true&domain_id=1050710945110597632&page_no=1&page_size=50&category=comment,reply,operation

Example Responses

Status code: 200

{
  "status" : "success",
  "message" : null,
  "result" : {
    "total" : 4,
    "comment_list" : [ {
      "id" : "1111014460409032705",
      "category" : "Comment",
      "type" : "comment",
      "top" : true,
      "description" : "<p>This is a pinned comment.</p>",
      "issue_id" : "1111014158531207168",
      "top_time" : "1742816095000",
      "top_flag" : true,
      "created_by" : "a360371833bf4c558f796fd707b44daf",
      "created_date" : "1742816089000",
      "creator_info" : {
        "user_id" : "a360371833bf4c558f796fd707b44daf",
        "user_num_id" : 4091,
        "user_name" : "devcloud_devcloud_xxx_01",
        "domain_id" : "4e919d73499648e3b0292cd3cbef806a",
        "domain_name" : "devcloud_devcloud_xxx_01",
        "nick_name" : "Test account.",
        "role_id" : null,
        "role_name" : null,
        "role_code" : null
      }
    }, {
      "id" : "1111014460409032705",
      "category" : "Comment",
      "type" : "comment",
      "top" : false,
      "description" : "<p>This is a pinned comment.</p>",
      "issue_id" : "1111014158531207168",
      "top_time" : "1742816095000",
      "top_flag" : true,
      "created_by" : "a360371833bf4c558f796fd707b44daf",
      "created_date" : "1742816089000",
      "creator_info" : {
        "user_id" : "a360371833bf4c558f796fd707b44daf",
        "user_num_id" : 4091,
        "user_name" : "devcloud_devcloud_xxx_01",
        "domain_id" : "4e919d73499648e3b0292cd3cbef806a",
        "domain_name" : "devcloud_devcloud_xxx_01",
        "nick_name" : "Test account.",
        "role_id" : null,
        "role_name" : null,
        "role_code" : null
      }
    }, {
      "id" : "1111014393723793409",
      "category" : "Comment",
      "type" : "comment",
      "top" : false,
      "description" : "<p>This is a comment with @mention&nbsp;<span class=\"ql-mention-link\" title=\"landingzone_xwq\" mentionchar=\"@\"><span contenteditable=\"false\">@landingzone_xwq</span></span></p>",
      "issue_id" : "1111014158531207168",
      "top_flag" : false,
      "created_by" : "a360371833bf4c558f796fd707b44daf",
      "created_date" : "1742816073000",
      "creator_info" : {
        "user_id" : "a360371833bf4c558f796fd707b44daf",
        "user_num_id" : 4091,
        "user_name" : "devcloud_devcloud_xxx_01",
        "domain_id" : "4e919d73499648e3b0292cd3cbef806a",
        "domain_name" : "devcloud_devcloud_xxx_01",
        "nick_name" : "Test account.",
        "role_id" : null,
        "role_name" : null,
        "role_code" : null
      }
    }, {
      "id" : "1111014282305118208",
      "category" : "Comment",
      "type" : "comment",
      "top" : false,
      "description" : "<p>This is a comment with an image.</p><p><img src=\"/api/ipdproject/openapi/v1/projects/4f967f6f05554273b0476da123e73b41/imgs/a152cf8e8a374ba38a971c2ac701c005.png\" style=\"vertical-align: baseline;\"></p>",
      "issue_id" : "1111014158531207168",
      "top_flag" : false,
      "created_by" : "a360371833bf4c558f796fd707b44daf",
      "created_date" : "1742816046000",
      "creator_info" : {
        "user_id" : "a360371833bf4c558f796fd707b44daf",
        "user_num_id" : 4091,
        "user_name" : "devcloud_devcloud_xxx_01",
        "domain_id" : "4e919d73499648e3b0292cd3cbef806a",
        "domain_name" : "devcloud_devcloud_xxx_01",
        "nick_name" : "Test account.",
        "role_id" : null,
        "role_name" : null,
        "role_code" : null
      }
    }, {
      "id" : "1111014159198101507",
      "category" : "Operation",
      "type" : "comment",
      "top" : false,
      "issue_id" : "1111014158531207168",
      "top_flag" : false,
      "extend_attribute" : "[{\"action\": \"Save initial requirement\", \"action_u_s\": \"Save Initial Requirement\", \"object_type\": \"status\", \"operator_id\": \"a360371833bf4c558f796fd707b44daf\", \"new_status_code\": \"Start\", \"pre_status_code\": \"_Start_\"}]",
      "created_by" : "a360371833bf4c558f796fd707b44daf",
      "created_date" : "1742816017000",
      "creator_info" : {
        "user_id" : "a360371833bf4c558f796fd707b44daf",
        "user_num_id" : 4091,
        "user_name" : "devcloud_devcloud_xxx_01",
        "domain_id" : "4e919d73499648e3b0292cd3cbef806a",
        "domain_name" : "devcloud_devcloud_xxx_01",
        "nick_name" : "Test account.",
        "role_id" : null,
        "role_name" : null,
        "role_code" : null
      },
      "extend_attribute_obj" : {
        "operator" : {
          "watcher" : null,
          "user_id" : "a360371833bf4c558f796fd707b44daf",
          "user_num_id" : 4091,
          "user_name" : "devcloud_devcloud_xxx_01",
          "domain_id" : "4e919d73499648e3b0292cd3cbef806a",
          "domain_name" : "devcloud_devcloud_xxx_01",
          "nick_name" : "Test account.",
          "role_id" : null,
          "role_name" : null,
          "image_id" : null,
          "region" : null,
          "opinion" : null,
          "description" : null,
          "owner" : null,
          "ccbId" : null,
          "has_removed" : null
        },
        "operator_id" : "a360371833bf4c558f796fd707b44daf",
        "action" : "Save initial requirement.",
        "action_us" : "Save Initial Requirement",
        "object_type" : "status",
        "pre_status_code" : "_Start_",
        "new_status_code" : "Start",
        "pre_status" : null,
        "new_status" : {
          "id" : "1050710945727160334",
          "belonging" : "START",
          "name" : "Initial.",
          "code" : "Start",
          "definition_type" : "5",
          "belong_definition_type" : 3,
          "display_value" : "Initial.",
          "position" : 1,
          "displayable" : 1,
          "editable" : 1,
          "deletable" : 1,
          "mutable" : 1,
          "title_py" : "cs",
          "created_by" : "a360371833bf4c558f796fd707b44daf",
          "created_date" : 1728467410000,
          "modified_date" : 1728467410000,
          "modified_by" : "a360371833bf4c558f796fd707b44daf",
          "linkage_node_fields" : false
        },
        "field_type" : "STATUS",
        "field_type_id" : "10001",
        "display_name" : "Status."
      },
      "extend_attribute_objs" : [ {
        "operator" : {
          "watcher" : null,
          "user_id" : "a360371833bf4c558f796fd707b44daf",
          "user_num_id" : 4091,
          "user_name" : "devcloud_devcloud_xxx_01",
          "domain_id" : "4e919d73499648e3b0292cd3cbef806a",
          "domain_name" : "devcloud_devcloud_xxx_01",
          "nick_name" : "Test account.",
          "role_id" : null,
          "role_name" : null,
          "image_id" : null,
          "region" : null,
          "opinion" : null,
          "description" : null,
          "owner" : null,
          "ccbId" : null,
          "has_removed" : null
        },
        "operator_id" : "a360371833bf4c558f796fd707b44daf",
        "action" : "Save initial requirement.",
        "action_us" : "Save Initial Requirement",
        "object_type" : "status",
        "pre_status_code" : "_Start_",
        "new_status_code" : "Start",
        "pre_status" : null,
        "new_status" : {
          "id" : "1050710945727160334",
          "belonging" : "START",
          "space_id" : "1050710945110597632",
          "name" : "Initial.",
          "code" : "Start",
          "definition_type" : "5",
          "belong_definition_type" : 3,
          "display_value" : "Initial.",
          "position" : 1,
          "displayable" : 1,
          "editable" : 1,
          "deletable" : 1,
          "mutable" : 1,
          "title_py" : "cs",
          "created_by" : "a360371833bf4c558f796fd707b44daf",
          "created_date" : 1728467410000,
          "modified_date" : 1728467410000,
          "modified_by" : "a360371833bf4c558f796fd707b44daf",
          "linkage_node_fields" : false
        },
        "field_type" : "STATUS",
        "field_type_id" : "10001",
        "display_name" : "Status."
      } ]
    } ]
  }
}

Status code: 400

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

SDK Sample Code

The SDK sample code is as follows.

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

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 ListIpdIssueCommentsSolution {

    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();
        ListIpdIssueCommentsRequest request = new ListIpdIssueCommentsRequest();
        request.withProjectId("{project_id}");
        request.withIssueId("{issue_id}");
        try {
            ListIpdIssueCommentsResponse response = client.listIpdIssueComments(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

# 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 = ListIpdIssueCommentsRequest()
        request.project_id = "{project_id}"
        request.issue_id = "{issue_id}"
        response = client.list_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

 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

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.ListIpdIssueCommentsRequest{}
	request.ProjectId = "{project_id}"
	request.IssueId = "{issue_id}"
	response, err := client.ListIpdIssueComments(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.