调用GetWorkitemCommentList获得工作项的评论列表_云效(Apsara Devops)-阿里云帮助中心

获得工作项的评论列表。

接口说明

获得工作项目的评论列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求语法

GET /organization/{organizationId}/workitems/{workitemId}/commentList

请求参数

名称	类型	必填	描述	示例值
organizationId	string	是	企业号	5ebbc0228123212b59xxxxx
workitemId	string	是	工作项 id，同 workitemIdentifier，工作项唯一标识	ce2xxxx21580baxxxx633f13

返回参数

名称	类型	描述	示例值
	object	Schema of Response
requestId	string	Id of the request	ASSDS-ASSASX-XSAXSA-XSAXSAXS
errorMsg	string	错误消息	error
errorCode	string	当 success 为 false，返回业务错误码；当 success 为 true，返回空值。	Openapi.RequestError
success	string	true 接口调用成功，false 接口调用失败	true 接口调用成功，false 接口调用失败
commentList	object []	评论列表
id	long	评论 id	6573
content	string	评论内容	066961
targetType	string	资源类型	workitem
targetIdentifier	string	资源 id，也就是工作项 id	9144ef6b72d8exxxxx9e61a4d0
parentId	long	父评论 id	1013131897677566
createTime	long	创建时间	1667205617061
modifiedTime	long	修改时间	1646323200000
isTop	boolean	是否置顶	true/false
topTime	long	置顶时间	1667205617089
formatType	string	格式类型	RICHTEXT/MARKDOWN
user	object	创建人对象
account	string	人员账户	null
identifier	string	人员唯一标识	123xxxxxxx222
realName	string	人员真实姓名	张三
nickName	string	人员昵称	李四
avatar	string	图标	null

示例

正常返回示例

JSON格式

{
  "requestId": "ASSDS-ASSASX-XSAXSA-XSAXSAXS",
  "errorMsg": "error",
  "errorCode": "Openapi.RequestError",
  "success": "true 接口调用成功，false 接口调用失败",
  "commentList": [
    {
      "id": 6573,
      "content": "066961",
      "targetType": "workitem",
      "targetIdentifier": "9144ef6b72d8exxxxx9e61a4d0",
      "parentId": 1013131897677566,
      "createTime": 1667205617061,
      "modifiedTime": 1646323200000,
      "isTop": true,
      "topTime": 1667205617089,
      "formatType": "RICHTEXT/MARKDOWN",
      "user": {
        "account": "null",
        "identifier": "123xxxxxxx222",
        "realName": "张三",
        "nickName": "李四",
        "avatar": "null"
      }
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	Openapi.RequestError	request error	OpenAPI请求数据错误
403	Operate.NoPermission	NoPermission	没有权限

访问错误中心查看更多错误码。