Comments - Get Comments

Referência

Serviço:: Work Item Tracking

Versão da API:: 7.1-preview.4

Retorna uma lista de comentários de item de trabalho, paginável.

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

Com parâmetros opcionais:

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
organization	path	True	string	O nome da organização do Azure DevOps.
project	path	True	string	ID do projeto ou nome do projeto
workItemId	path	True	integer int32	Id de um item de trabalho para o qual obter comentários.
api-version	query	True	string	Versão da API a ser usada. Isso deve ser definido como '7.1-preview.4' para usar essa versão da api.
$expand	query		CommentExpandOptions	Especifica as opções adicionais de recuperação de dados para comentários de item de trabalho.
$top	query		integer int32	Número máximo de comentários a serem retornados.
continuationToken	query		string	Usado para consultar a próxima página de comentários.
includeDeleted	query		boolean	Especifique se os comentários excluídos devem ser recuperados.
order	query		CommentSortOrder	Ordem na qual os comentários devem ser retornados.

Respostas

Nome	Tipo	Description
200 OK	CommentList	operação bem-sucedida

Segurança

oauth2

Tipo: oauth2
Flow: accessCode
URL de Autorização: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL do Token: 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

Escopos

Nome	Description
vso.work	Concede a capacidade de ler itens de trabalho, consultas, quadros, caminhos de área e iterações e outros metadados relacionados ao acompanhamento de itens de trabalho. Também concede a capacidade de executar consultas, pesquisar itens de trabalho e receber notificações sobre eventos de item de trabalho por meio de ganchos de serviço.

Exemplos

Get the first page of comments

Get the next page of comments

Get the first page of comments

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 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

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 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"
    }
  ]
}

Definições

Nome	Description
Comment	Comente em um Item de Trabalho.
CommentExpandOptions	Especifica as opções adicionais de recuperação de dados para comentários de item de trabalho.
CommentFormat	Representa os tipos possíveis para o formato de comentário.
CommentList	Representa uma lista de comentários de item de trabalho.
CommentMention
CommentReaction	Contém informações sobre a reação de comentário do item de trabalho para um tipo de reação específico.
CommentReactionType	Tipo da reação.
CommentSortOrder	Ordem na qual os comentários devem ser retornados.
IdentityRef
ReferenceLinks	A classe para representar uma coleção de links de referência REST.

Comment

Object

Comente em um Item de Trabalho.

Nome	Tipo	Description
_links	ReferenceLinks	Vincular referências a recursos REST relacionados.
createdBy	IdentityRef	IdentityRef do criador do comentário.
createdDate	string	A data de criação do comentário.
createdOnBehalfDate	string	Valor de data/hora efetivo para adicionar o comentário. Opcionalmente, pode ser diferente de CreatedDate.
createdOnBehalfOf	IdentityRef	Identidade em cujo nome este comentário foi adicionado. Opcionalmente, pode ser diferente de CreatedBy.
format	CommentFormat	Representa os tipos possíveis para o formato de comentário.
id	integer	A ID atribuída ao comentário.
isDeleted	boolean	Indica se o comentário foi excluído.
mentions	CommentMention[]	As menções do comentário.
modifiedBy	IdentityRef	IdentityRef do usuário que modificou o comentário pela última vez.
modifiedDate	string	A última data de modificação do comentário.
reactions	CommentReaction[]	As reações do comentário.
renderedText	string	O texto do comentário no formato HTML.
text	string	O texto do comentário.
url	string
version	integer	A versão atual do comentário.
workItemId	integer	A ID do item de trabalho ao qual este comentário pertence.

CommentExpandOptions

Enumeration

Especifica as opções adicionais de recuperação de dados para comentários de item de trabalho.

Valor	Description
all
none
reactions	Inclua reações de comentário.
renderedText	Inclua o texto renderizado (html) além do texto MD.
renderedTextOnly	Se especificado, SOMENTE texto renderizado (html) será retornado, marcação w/o. Supostamente, o uso interno de dados fornece para fins de otimização.

CommentFormat

Enumeration

Representa os tipos possíveis para o formato de comentário.

Valor	Description
html
markdown

CommentList

Object

Representa uma lista de comentários de item de trabalho.

Nome	Tipo	Description
_links	ReferenceLinks	Vincular referências a recursos REST relacionados.
comments	Comment[]	Lista de comentários no lote atual.
continuationToken	string	Um token de cadeia de caracteres que pode ser usado para recuperar a próxima página de comentários, se disponível. Caso contrário, nulo.
count	integer	A contagem de comentários no lote atual.
nextPage	string	Uri para a próxima página de comentários se ele estiver disponível. Caso contrário, nulo.
totalCount	integer	Contagem total de comentários em um item de trabalho.
url	string

CommentMention

Object

Nome	Tipo	Description
_links	ReferenceLinks	Vincular referências a recursos REST relacionados.
artifactId	string	A parte do artefato do texto analisado. (ou seja, a ID do item de trabalho)
artifactType	string	O tipo do analisador atribuído ao menção. (ou seja, pessoa, item de trabalho etc.
commentId	integer	A ID do comentário do menção.
targetId	string	O destino resolvido do menção. Um exemplo disso pode ser o tfid de um usuário
url	string

CommentReaction

Object

Contém informações sobre a reação de comentário do item de trabalho para um tipo de reação específico.

Nome	Tipo	Description
_links	ReferenceLinks	Vincular referências a recursos REST relacionados.
commentId	integer	A ID do comentário ao qual essa reação pertence.
count	integer	Número total de reações para CommentReactionType.
isCurrentUserEngaged	boolean	Sinalizador para indicar se o usuário atual se envolveu nesse EngagementType específico (por exemplo, se ele gostou do comentário associado).
type	CommentReactionType	Tipo da reação.
url	string

CommentReactionType

Enumeration

Tipo da reação.

Valor	Description
confused
dislike
heart
hooray
like
smile

CommentSortOrder

Enumeration

Ordem na qual os comentários devem ser retornados.

Valor	Description
asc	Os resultados serão classificados em ordem crescente.
desc	Os resultados serão classificados em ordem decrescente.

IdentityRef

Object

Nome	Tipo	Description
_links	ReferenceLinks	Esse campo contém zero ou mais links interessantes sobre o assunto do grafo. Esses links podem ser invocados para obter relações adicionais ou informações mais detalhadas sobre esse assunto do grafo.
descriptor	string	O descritor é a principal maneira de referenciar o assunto do grafo enquanto o sistema está em execução. Esse campo identificará exclusivamente o mesmo assunto de grafo entre contas e organizações.
directoryAlias	string	Preterido – pode ser recuperado consultando o usuário do Graph referenciado na entrada "self" do dicionário IdentityRef "_links"
displayName	string	Esse é o nome de exibição não exclusivo do assunto do grafo. Para alterar esse campo, você deve alterar seu valor no provedor de origem.
id	string
imageUrl	string	Preterido – Disponível na entrada "avatar" do dicionário IdentityRef "_links"
inactive	boolean	Preterido – pode ser recuperado consultando o estado de associação do Graph referenciado na entrada "membershipState" do dicionário "_links" do GraphUser
isAadIdentity	boolean	Preterido – pode ser inferido do tipo de assunto do descritor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Preterido – pode ser inferido do tipo de assunto do descritor (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Preterido – não em uso na maioria das implementações preexistir de ToIdentityRef
uniqueName	string	Preterido – use Domain+PrincipalName em vez disso
url	string	Essa URL é a rota completa para o recurso de origem desta entidade de grafo.

ReferenceLinks

Object

A classe para representar uma coleção de links de referência REST.

Nome	Tipo	Description
links	object	A exibição somente leitura dos links. Como os links de referência são somente leitura, só queremos expô-los como somente leitura.

Compartilhar via

Comments - Get Comments

Parâmetros de URI

Respostas

Segurança

oauth2

Escopos

Exemplos

Get the first page of comments

Solicitação de exemplo

Resposta de exemplo

Get the next page of comments

Solicitação de exemplo

Resposta de exemplo

Definições

Comment

CommentExpandOptions

CommentFormat

CommentList

CommentMention

CommentReaction

CommentReactionType

CommentSortOrder

IdentityRef

ReferenceLinks