Comments - Get Comments

リファレンス

サービス:: Work Item Tracking

API バージョン:: 7.1-preview.4

ページング可能な作業項目コメントの一覧を返します。

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

省略可能なパラメーターを含む:

GET https://dev.azure.com/{organization}/{project}/_apis/wit/workItems/{workItemId}/comments?$top={$top}&continuationToken={continuationToken}&includeDeleted={includeDeleted}&$expand={$expand}&order={order}&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 のバージョン。このバージョンの API を使用するには、これを '7.1-preview.4' に設定する必要があります。
$expand	query		CommentExpandOptions	作業項目コメントの追加のデータ取得オプションを指定します。
$top	query		integer int32	返すコメントの最大数。
continuationToken	query		string	コメントの次のページに対してクエリを実行するために使用します。
includeDeleted	query		boolean	削除されたコメントを取得するかどうかを指定します。
order	query		CommentSortOrder	コメントを返す順序。

応答

名前	型	説明
200 OK	CommentList	成功した操作

セキュリティ

oauth2

型: oauth2
フロー: accessCode
Authorization URL (承認 URL): https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL (トークン 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 the first page of comments

Get the next page of comments

Get the first page of comments

要求のサンプル

HTTP

GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/workItems/299/comments?$top=2&api-version=7.1-preview.4

応答のサンプル

状態コード:: 200

{
  "totalCount": 10,
  "count": 2,
  "comments": [
    {
      "workItemId": 299,
      "commentId": 45,
      "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-21T20:12:14.683Z",
      "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-21T20:12:14.683Z",
      "isDeleted": false,
      "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItems/299/comments/45"
    },
    {
      "workItemId": 299,
      "commentId": 44,
      "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-20T23:26:33.383Z",
      "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-20T23:26:33.383Z",
      "isDeleted": false,
      "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItems/299/comments/44"
    }
  ],
  "nextPage": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItems/299/comments?continuationToken=DFkODYtNTYxYS03ZDdiLWJj&api-version=5.1-preview",
  "continuationToken": "DFkODYtNTYxYS03ZDdiLWJj"
}

Get the next page of comments

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

{
  "totalCount": 10,
  "count": 2,
  "comments": [
    {
      "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"
    },
    {
      "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"
    }
  ]
}

定義

名前	説明
Comment	作業項目にコメントを付けます。
CommentExpandOptions	作業項目コメントの追加のデータ取得オプションを指定します。
CommentFormat	コメント形式で使用できる型を表します。
CommentList	作業項目コメントの一覧を表します。
CommentMention
CommentReaction	特定の反応の種類に対する作業項目コメントの反応に関する情報が含まれます。
CommentReactionType	反応の種類。
CommentSortOrder	コメントを返す順序。
IdentityRef
ReferenceLinks	REST 参照リンクのコレクションを表すクラス。

Comment

Object

作業項目にコメントを付けます。

名前	型	説明
_links	ReferenceLinks	関連する REST リソースへの参照をリンクします。
createdBy	IdentityRef	コメントの作成者の IdentityRef。
createdDate	string	コメントの作成日。
createdOnBehalfDate	string	コメントを追加するための有効な日付/時刻値。必要に応じて、CreatedDate とは異なる場合があります。
createdOnBehalfOf	IdentityRef	このコメントが追加された代理の ID。必要に応じて、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

列挙

作業項目コメントの追加のデータ取得オプションを指定します。

値	説明
all
none
reactions	コメントの反応を含めます。
renderedText	MD テキストに加えて、レンダリングされたテキスト (html) を含めます。
renderedTextOnly	指定した場合、レンダリングされたテキスト (html) のみが返されます(マークダウン付き)。最適化のために、データから内部的に使用することが想定されています。

CommentFormat

列挙

コメント形式で使用できる型を表します。

値	説明
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

列挙

反応の種類。

値	説明
confused
dislike
heart
hooray
like
smile

CommentSortOrder

列挙

コメントを返す順序。

値	説明
asc	結果は昇順で並べ替えられます。
desc	結果は降順で並べ替えられます。

IdentityRef

Object

名前	型	説明
_links	ReferenceLinks	このフィールドには、グラフの件名に関する 0 個以上の興味深いリンクが含まれています。これらのリンクを呼び出して、このグラフの件名に関する追加のリレーションシップまたは詳細情報を取得できます。
descriptor	string	記述子は、システムの実行中にグラフの件名を参照する主な方法です。このフィールドは、アカウントと組織の両方で同じグラフの件名を一意に識別します。
directoryAlias	string	非推奨 - IdentityRef "_links" ディクショナリの "self" エントリで参照されている Graph ユーザーに対してクエリを実行することで取得できます
displayName	string	これは、グラフの件名の一意でない表示名です。このフィールドを変更するには、ソースプロバイダーでその値を変更する必要があります。
id	string
imageUrl	string	非推奨 - IdentityRef "_links" 辞書の "アバター" エントリで使用できます
inactive	boolean	非推奨 - GraphUser "_links" ディクショナリの "membershipState" エントリで参照されている Graph メンバーシップの状態を照会することで取得できます
isAadIdentity	boolean	非推奨 - 記述子のサブジェクト型 (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) から推論できます
isContainer	boolean	非推奨 - 記述子のサブジェクト型 (Descriptor.IsGroupType) から推論できます
isDeletedInOrigin	boolean
profileUrl	string	非推奨 - ToIdentityRef の既存のほとんどの実装では使用されていません
uniqueName	string	非推奨 - 代わりに Domain+PrincipalName を使用する
url	string	この URL は、このグラフの件名のソースリソースへの完全なルートです。

ReferenceLinks

Object

REST 参照リンクのコレクションを表すクラス。

名前	型	説明
links	object	リンクの読み取り専用ビュー。参照リンクは読み取り専用であるため、参照リンクは読み取り専用として公開する必要があります。

次の方法で共有

Comments - Get Comments

URI パラメーター

応答

セキュリティ

oauth2

スコープ

例

Get the first page of comments

要求のサンプル

応答のサンプル

Get the next page of comments

要求のサンプル

応答のサンプル

定義

Comment

CommentExpandOptions

CommentFormat

CommentList

CommentMention

CommentReaction

CommentReactionType

CommentSortOrder

IdentityRef

ReferenceLinks