文档

GetWorkitemCommentList - 获得工作项的评论列表

更新时间:

获得工作项的评论列表。

接口说明

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

调试

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

授权信息

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

请求语法

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

请求参数

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

企业号

5ebbc0228123212b59xxxxx
workitemIdstring

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

ce2xxxx21580baxxxx633f13

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

Id of the request

ASSDS-ASSASX-XSAXSA-XSAXSAXS
errorMsgstring

错误消息

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

  • 当 success 为 true,返回空值。

Openapi.RequestError
successstring

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

true 接口调用成功,false 接口调用失败
commentListobject []

评论列表

idlong

评论 id

6573
contentstring

评论内容

066961
targetTypestring

资源类型

workitem
targetIdentifierstring

资源 id,也就是工作项 id

9144ef6b72d8exxxxx9e61a4d0
parentIdlong

父评论 id

1013131897677566
createTimelong

创建时间

1667205617061
modifiedTimelong

修改时间

1646323200000
isTopboolean

是否置顶

true/false
topTimelong

置顶时间

1667205617089
formatTypestring

格式类型

RICHTEXT/MARKDOWN
userobject

创建人对象

accountstring

人员账户

null
identifierstring

人员唯一标识

123xxxxxxx222
realNamestring

人员真实姓名

张三
nickNamestring

人员昵称

李四
avatarstring

图标

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

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

  • 本页导读 (0)