CreateWorkitemComment - 创建工作项评论

更新时间: 2023-09-25 19:27:35

创建工作项评论。

接口说明

创建工作项目的评论。

调试

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

调试

授权信息

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

请求语法

POST /organization/{organizationId}/workitems/comment

请求参数

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

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

60811b5eed6e867404f6xxxx
bodyobject

请求Body

contentstring

评论内容

有关于黑龙江地区旅店业室内广告屏出租
workitemIdentifierstring

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

1e9903d8b3f12xxxxxf9286ef5
formatTypestring

目前支持RICHTEXT/MARKDOWN 二选一

RICHTEXT/MARKDOWN
parentIdstring

父目录ID。

说明 根目录时传0
26842

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

Id of the request

ASSDS-ASSASX-XSAXSA-XSAXSAXS
errorMsgstring

错误信息

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

  • 当success为true,返回空值。

success
successstring

调用是否成功。

true 接口调用成功,false 接口调用失败
Commentobject

审核备注。最长支持512字节。

Idlong

唯一标识

26842
contentstring

内容

有关于黑龙江地区旅店业室内广告屏出租
userobject

用户相关信息

accountstring

阿里云id

13164xxxxx41068
identifierstring

用户identifier

1e9903d8bxxxxxxe9df9286ef5
realNamestring

实际名

王五
nickNamestring

昵称

王五
avatarstring

头像链接

https://xxxxx/thumbnail/112m7150e256dbba0d6456bafbb65c81f90d/w/200/h/200
displayNamestring

展示名字

王五
targetTypestring

资源类型

workitem
targetTypestring

资源类型

workitem
targetIdentifierstring

资源id,也就是项目id

79d523806bdxxxxx95612a5154
parentIdlong

父工作流id

26842
createTimelong

创建时间

1667202662000
modifiedTimelong

修改时间

1637995553000
isTopboolean

是否置顶

true/false
topTimelong

置顶时间

1667202662000
formatTypestring

评论类型

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

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

阿里云首页 云效2020 相关技术圈