调用UpdateWorkitemComment更新工作项评论_云效(Apsara Devops)-阿里云帮助中心

更新工作项评论。

接口说明

更新工作项评论。

调试

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

调试

授权信息

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

请求语法

POST /organization/{organizationId}/workitems/commentUpdate

请求参数

名称	类型	必填	描述	示例值
organizationId	string	是	企业标识，也称企业 id，字符串形式，可在云效访问链接中获取，如 https://devops.aliyun.com/organization/【OrganizationId】	5ebbc0228123212b59xxxxx
body	object	否	请求 Body
content	string	是	评论内容	这是更新后的评论内容
formatType	string	是	内容格式目前支持 MARKDOWN/RICHTEXT	MARKDOWN/RICHTEXT
workitemIdentifier	string	是	工作项 id，同 workitemId，工作项唯一标识	9144ef6b72d8exxxxx9e61a4d0
commentId	long	是	评论 id	1964584

返回参数

名称	类型	描述	示例值
	object	Schema of Response
requestId	string	Id of the request	F7B85D1B-D1C2-140F-A039-341859F130B9
errorMsg	string	错误信息。	error
errorCode	string	当 success 为 false，返回业务错误码；当 success 为 true，返回空值。	InvalidParam.NotFound
success	string	true 或者 false	true
comment	object	评论
id	string	评论唯一 id	1964584
content	string	评论内容	这是更新后的评论内容
targetType	string	所属资源类型	workitem
targetIdentifier	string	资源 id，工作项目 id	deafe5f33xxxxx6a259d8dafd
parentId	long	父任务 id	2684432
createTime	long	创建时间	1667205617061
modifiedTime	long	修改时间	1646323200000
isTop	boolean	是否置顶	true/false
topTime	long	置顶时间	1667205617089
formatType	string	格式类型	MARKDOWN/RICHTEXT
user	object	用户信息
account	string	阿里云账号	1316458xxxxx41068
identifier	string	用户 id	9144ef6b72d8exxxxx9e61a4d0
realName	string	用户真实姓名	王五
nickName	string	用户昵称	王五
avatar	string	用户头像	https://tcs-devops.aliyuncs.com/thumbnail/112m7150e256dbba0d6456bafbb65c81f90d/w/200/h/200
displayName	string	展示名称	王五

示例

正常返回示例

JSON格式

{
  "requestId": "F7B85D1B-D1C2-140F-A039-341859F130B9",
  "errorMsg": "error",
  "errorCode": "InvalidParam.NotFound",
  "success": "true",
  "comment": {
    "id": "1964584",
    "content": "这是更新后的评论内容",
    "targetType": "workitem",
    "targetIdentifier": "deafe5f33xxxxx6a259d8dafd",
    "parentId": 2684432,
    "createTime": 1667205617061,
    "modifiedTime": 1646323200000,
    "isTop": true,
    "topTime": 1667205617089,
    "formatType": "MARKDOWN/RICHTEXT",
    "user": {
      "account": "1316458xxxxx41068",
      "identifier": "9144ef6b72d8exxxxx9e61a4d0",
      "realName": "王五",
      "nickName": "王五",
      "avatar": "https://tcs-devops.aliyuncs.com/thumbnail/112m7150e256dbba0d6456bafbb65c81f90d/w/200/h/200",
      "displayName": "王五"
    }
  }
}

错误码

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

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史