文档

UpdateWorkitemComment - 更新工作项评论

更新时间:

更新工作项评论。

接口说明

更新工作项评论。

调试

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

授权信息

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

请求语法

POST /organization/{organizationId}/workitems/commentUpdate

请求参数

名称类型必填描述示例值
organizationIdstring

企业标识,也称企业 id,字符串形式,可在云效访问链接中获取,如 https://devops.aliyun.com/organization/【OrganizationId】

5ebbc0228123212b59xxxxx
bodyobject

请求 Body

contentstring

评论内容

这是更新后的评论内容
formatTypestring

内容格式 目前支持 MARKDOWN/RICHTEXT

MARKDOWN/RICHTEXT
workitemIdentifierstring

工作项 id,同 workitemId,工作项唯一标识

9144ef6b72d8exxxxx9e61a4d0
commentIdlong

评论 id

1964584

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

Id of the request

F7B85D1B-D1C2-140F-A039-341859F130B9
errorMsgstring

错误信息。

error
errorCodestring
  • 当 success 为 false,返回业务错误码;

  • 当 success 为 true,返回空值。

InvalidParam.NotFound
successstring

true 或者 false

true
commentobject

评论

idstring

评论唯一 id

1964584
contentstring

评论内容

这是更新后的评论内容
targetTypestring

所属资源类型

workitem
targetIdentifierstring

资源 id,工作项目 id

deafe5f33xxxxx6a259d8dafd
parentIdlong

父任务 id

2684432
createTimelong

创建时间

1667205617061
modifiedTimelong

修改时间

1646323200000
isTopboolean

是否置顶

true/false
topTimelong

置顶时间

1667205617089
formatTypestring

格式类型

MARKDOWN/RICHTEXT
userobject

用户信息

accountstring

阿里云账号

1316458xxxxx41068
identifierstring

用户 id

9144ef6b72d8exxxxx9e61a4d0
realNamestring

用户真实姓名

王五
nickNamestring

用户昵称

王五
avatarstring

用户头像

https://tcs-devops.aliyuncs.com/thumbnail/112m7150e256dbba0d6456bafbb65c81f90d/w/200/h/200
displayNamestring

展示名称

王五

示例

正常返回示例

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错误码错误信息描述
400Openapi.RequestErrorrequest errorOpenAPI请求数据错误
403Operate.NoPermissionNoPermission没有权限

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

  • 本页导读 (0)
文档反馈