调用CreateWorkitemComment创建工作项评论_云效(Apsara Devops)-阿里云帮助中心

创建工作项评论。

接口说明

创建工作项目的评论。

调试

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

调试

授权信息

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

请求语法

POST /organization/{organizationId}/workitems/comment

请求参数

名称	类型	必填	描述	示例值
organizationId	string	是	企业标识，也称企业 id，字符串形式，可在云效访问链接中获取，如 https://devops.aliyun.com/organization/【OrganizationId】	60811b5eed6e867404f6xxxx
body	object	否	请求 Body
content	string	是	评论内容	有关于黑龙江地区旅店业室内广告屏出租
workitemIdentifier	string	是	工作项 id，同 workItemId，工作项唯一标识	1e9903d8b3f12xxxxxf9286ef5
formatType	string	是	目前支持 RICHTEXT/MARKDOWN 二选一	RICHTEXT/MARKDOWN
parentId	string	否	父目录 ID。说明根目录时传 0。	26842

返回参数

名称	类型	描述	示例值
	object	Schema of Response
requestId	string	Id of the request	ASSDS-ASSASX-XSAXSA-XSAXSAXS
errorMsg	string	错误信息	error
errorCode	string	当 success 为 false，返回业务错误码；当 success 为 true，返回空值。	success
success	string	调用是否成功。	true 接口调用成功，false 接口调用失败
Comment	object	审核备注。最长支持 512 字节。
Id	long	唯一标识	26842
content	string	内容	有关于黑龙江地区旅店业室内广告屏出租
user	object	用户相关信息
account	string	阿里云 id	13164xxxxx41068
identifier	string	用户 identifier	1e9903d8bxxxxxxe9df9286ef5
realName	string	实际名	王五
nickName	string	昵称	王五
avatar	string	头像链接	https://xxxxx/thumbnail/112m7150e256dbba0d6456bafbb65c81f90d/w/200/h/200
displayName	string	展示名字	王五
targetType	string	资源类型	workitem
targetType	string	资源类型	workitem
targetIdentifier	string	资源 id，也就是项目 id	79d523806bdxxxxx95612a5154
parentId	long	父工作流 id	26842
createTime	long	创建时间	1667202662000
modifiedTime	long	修改时间	1637995553000
isTop	boolean	是否置顶	true/false
topTime	long	置顶时间	1667202662000
formatType	string	评论类型	RICHTEXT/MARKDOWN

示例

正常返回示例

JSON格式

{
  "requestId": "ASSDS-ASSASX-XSAXSA-XSAXSAXS",
  "errorMsg": "error",
  "errorCode": "success",
  "success": "true 接口调用成功，false 接口调用失败",
  "Comment": {
    "Id": 26842,
    "content": "有关于黑龙江地区旅店业室内广告屏出租",
    "user": {
      "account": "13164xxxxx41068",
      "identifier": "1e9903d8bxxxxxxe9df9286ef5",
      "realName": "王五",
      "nickName": "王五",
      "avatar": "https://xxxxx/thumbnail/112m7150e256dbba0d6456bafbb65c81f90d/w/200/h/200",
      "displayName": "王五",
      "targetType": "workitem"
    },
    "targetType": "workitem",
    "targetIdentifier": "79d523806bdxxxxx95612a5154",
    "parentId": 26842,
    "createTime": 1667202662000,
    "modifiedTime": 1637995553000,
    "isTop": true,
    "topTime": 1667202662000,
    "formatType": "RICHTEXT/MARKDOWN "
  }
}

错误码

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

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