Comments - Get Comments Batch

参考

服务:: Work Item Tracking

API 版本:: 7.1-preview.4

按 ID 返回工作项注释的列表。

GET https://dev.azure.com/{organization}/{project}/_apis/wit/workItems/{workItemId}/comments?ids={ids}&api-version=7.1-preview.4

具有可选参数:

GET https://dev.azure.com/{organization}/{project}/_apis/wit/workItems/{workItemId}/comments?ids={ids}&includeDeleted={includeDeleted}&$expand={$expand}&api-version=7.1-preview.4

URI 参数

名称	在	必需	类型	说明
organization	path	True	string	Azure DevOps 组织的名称。
project	path	True	string	项目 ID 或项目名称
workItemId	path	True	integer int32	要为其获取批注的工作项的 ID。
api-version	query	True	string	要使用的 API 版本。应将其设置为“7.1-preview.4”才能使用此版本的 API。
ids	query	True	string array (int32)	要返回的注释 ID 的逗号分隔列表。
$expand	query		CommentExpandOptions	指定工作项注释的其他数据检索选项。
includeDeleted	query		boolean	指定是否应检索已删除的注释。

响应

名称	类型	说明
200 OK	CommentList	成功的操作

安全性

oauth2

类型: oauth2
流向: accessCode
授权 URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
令牌 URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

作用域

名称	说明
vso.work	授予读取工作项、查询、板、区域和迭代路径以及其他工作项跟踪相关元数据的能力。此外，还允许通过服务挂钩执行查询、搜索工作项和接收有关工作项事件的通知。

示例

Get a list of comments by ids

示例请求

HTTP

GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/workItems/299/comments?ids=42,43&api-version=7.1-preview.4

示例响应

状态代码:: 200

{
  "totalCount": 2,
  "count": 2,
  "comments": [
    {
      "workItemId": 299,
      "commentId": 42,
      "version": 1,
      "text": "Moving to the right area path",
      "createdBy": {
        "displayName": "Jamal Hartnett",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
          }
        },
        "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "uniqueName": "fabrikamfiber4@hotmail.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
      },
      "createdDate": "2019-01-16T03:03:28.97Z",
      "modifiedBy": {
        "displayName": "Jamal Hartnett",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
          }
        },
        "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "uniqueName": "fabrikamfiber4@hotmail.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
      },
      "modifiedDate": "2019-01-16T03:03:28.97Z",
      "isDeleted": false,
      "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItems/299/comments/42"
    },
    {
      "workItemId": 299,
      "commentId": 43,
      "version": 1,
      "text": "Johnnie is going to take this work over.",
      "createdBy": {
        "displayName": "Jamal Hartnett",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
          }
        },
        "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "uniqueName": "fabrikamfiber4@hotmail.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
      },
      "createdDate": "2019-01-17T02:03:12.88Z",
      "modifiedBy": {
        "displayName": "Jamal Hartnett",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
          }
        },
        "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "uniqueName": "fabrikamfiber4@hotmail.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
      },
      "modifiedDate": "2019-01-17T02:03:12.88Z",
      "isDeleted": false,
      "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItems/299/comments/43"
    }
  ]
}

定义

名称	说明
Comment	对工作项进行注释。
CommentExpandOptions	指定工作项注释的其他数据检索选项。
CommentFormat	表示注释格式的可能类型。
CommentList	表示工作项注释的列表。
CommentMention
CommentReaction	包含有关特定反应类型的工作项注释反应的信息。
CommentReactionType	反应的类型。
IdentityRef
ReferenceLinks	表示 REST 引用链接集合的类。

Comment

Object

对工作项进行注释。

名称	类型	说明
_links	ReferenceLinks	将引用链接到相关的 REST 资源。
createdBy	IdentityRef	注释创建者的 IdentityRef。
createdDate	string	批注的创建日期。
createdOnBehalfDate	string	用于添加注释的有效日期/时间值。可以选择与 CreatedDate 不同。
createdOnBehalfOf	IdentityRef	已代表其添加此注释的标识。可以选择与 CreatedBy 不同。
format	CommentFormat	表示注释格式的可能类型。
id	integer	分配给注释的 ID。
isDeleted	boolean	指示注释是否已删除。
mentions	CommentMention[]	注释的提及。
modifiedBy	IdentityRef	上次修改注释的用户的 IdentityRef。
modifiedDate	string	注释的上次修改日期。
reactions	CommentReaction[]	注释的反应。
renderedText	string	HTML 格式的注释文本。
text	string	批注的文本。
url	string
version	integer	注释的当前版本。
workItemId	integer	此注释所属的工作项的 ID。

CommentExpandOptions

Enumeration

指定工作项注释的其他数据检索选项。

值	说明
all
none
reactions	包括批注反应。
renderedText	除 MD 文本外，还包括呈现的文本 (html) 。
renderedTextOnly	如果指定，则仅返回呈现的文本 (html) ，w/o markdown。应从数据内部使用，用于优化目的。

CommentFormat

Enumeration

表示注释格式的可能类型。

值	说明
html
markdown

CommentList

Object

表示工作项注释的列表。

名称	类型	说明
_links	ReferenceLinks	将引用链接到相关的 REST 资源。
comments	Comment[]	当前批中的注释列表。
continuationToken	string	一个字符串标记，可用于检索下一页注释（如果可用）。否则为 null。
count	integer	当前批中的批注计数。
nextPage	string	下一页注释的 URI（如果可用）。否则为 null。
totalCount	integer	对工作项的批注总数。
url	string

CommentMention

Object

名称	类型	说明
_links	ReferenceLinks	将引用链接到相关的 REST 资源。
artifactId	string	已分析文本的项目部分。 (即工作项的 ID)
artifactType	string	类型分析程序分配给提及。 (，即人员、工作项等)
commentId	integer	提及的注释 ID。
targetId	string	提及的已解析目标。其中一个示例可能是用户的 tfid
url	string

CommentReaction

Object

包含有关特定反应类型的工作项注释反应的信息。

名称	类型	说明
_links	ReferenceLinks	将引用链接到相关的 REST 资源。
commentId	integer	此反应所属的注释的 ID。
count	integer	CommentReactionType 的反应总数。
isCurrentUserEngaged	boolean	指示当前用户是否已参与此特定 EngagementType (例如，他们是否喜欢) 关联的注释的标志。
type	CommentReactionType	反应的类型。
url	string

CommentReactionType

Enumeration

反应的类型。

值	说明
confused
dislike
heart
hooray
like
smile

IdentityRef

Object

名称	类型	说明
_links	ReferenceLinks	此字段包含有关图形主题的零个或多个相关链接。可以调用这些链接来获取有关此图主题的其他关系或更多详细信息。
descriptor	string	描述符是在系统运行时引用图形主题的主要方式。此字段将唯一标识帐户和组织中的同一图形主题。
directoryAlias	string	已弃用 - 可通过查询 IdentityRef“_links”字典的“self”条目中引用的 Graph 用户来检索
displayName	string	这是图形主题的非唯一显示名称。若要更改此字段，必须在源提供程序中更改其值。
id	string
imageUrl	string	已弃用 - 在 IdentityRef“_links”字典的“头像”条目中可用
inactive	boolean	已弃用 - 可以通过查询 GraphUser“_links”字典的“membershipState”条目中引用的 Graph 成员身份状态来检索
isAadIdentity	boolean	已弃用 - 可以从描述符的主题类型推断 (描述符.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	已弃用 - 可以从描述符的主题类型推断 (描述符.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	已弃用 - 在 ToIdentityRef 的大多数预先存在的实现中未使用
uniqueName	string	已弃用 - 改用 Domain+PrincipalName
url	string	此 URL 是此图主题的源资源的完整路由。

ReferenceLinks

Object

表示 REST 引用链接集合的类。

名称	类型	说明
links	object	链接的只读视图。由于引用链接是只读的，因此我们只想将其公开为只读。

通过

Comments - Get Comments Batch

URI 参数

响应

安全性

oauth2

作用域

示例

Get a list of comments by ids

示例请求

示例响应

定义

Comment

CommentExpandOptions

CommentFormat

CommentList

CommentMention

CommentReaction

CommentReactionType

IdentityRef

ReferenceLinks

其他资源