Work Items - Get Work Items Batch

Referência

Service:: Work Item Tracking

API Version:: 6.1-preview.1

Obtém itens de trabalho para uma lista de IDs de item de trabalho (máximo de 200)

POST https://dev.azure.com/{organization}/{project}/_apis/wit/workitemsbatch?api-version=6.1-preview.1

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
organization	path	True	string	O nome da organização do Azure DevOps.
project	path		string	ID do projeto ou nome do projeto
api-version	query	True	string	Versão da API a ser usada. Isso deve ser definido como '6.1-preview.1' para usar essa versão da api.

Corpo da solicitação

Nome	Tipo	Description
$expand	WorkItemExpand	Os parâmetros de expansão para atributos de item de trabalho. As opções possíveis são { None, Relations, Fields, Links, All }
asOf	string	Cadeia de caracteres de hora de data UTC asOf
errorPolicy	WorkItemErrorPolicy	O sinalizador para controlar a política de erro em uma solicitação de obter itens de trabalho em massa. As opções possíveis são {Fail, Omit}.
fields	string[]	Os campos solicitados
ids	integer[]	As IDs de item de trabalho solicitadas

Respostas

Nome	Tipo	Description
200 OK	WorkItem[]	operação bem-sucedida

Segurança

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token 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

Scopes

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 list of work items for specific fields

Sample Request

HTTP

POST https://dev.azure.com/fabrikam/_apis/wit/workitemsbatch?api-version=6.1-preview.1

{
  "ids": [
    297,
    299,
    300
  ],
  "fields": [
    "System.Id",
    "System.Title",
    "System.WorkItemType",
    "Microsoft.VSTS.Scheduling.RemainingWork"
  ]
}

Sample Response

Status code:: 200

{
  "count": 3,
  "value": [
    {
      "id": 297,
      "rev": 1,
      "fields": {
        "System.Id": 297,
        "System.WorkItemType": "Product Backlog Item",
        "System.Title": "Customer can sign in using their Microsoft Account"
      },
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/297"
    },
    {
      "id": 299,
      "rev": 7,
      "fields": {
        "System.Id": 299,
        "System.WorkItemType": "Task",
        "System.Title": "JavaScript implementation for Microsoft Account",
        "Microsoft.VSTS.Scheduling.RemainingWork": 4
      },
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/299"
    },
    {
      "id": 300,
      "rev": 1,
      "fields": {
        "System.Id": 300,
        "System.WorkItemType": "Task",
        "System.Title": "Unit Testing for MSA login",
        "Microsoft.VSTS.Scheduling.RemainingWork": 3
      },
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/300"
    }
  ]
}

Definições

Nome	Description
ReferenceLinks	A classe para representar uma coleção de links de referência REST.
WorkItem	Descreve um item de trabalho.
WorkItemBatchGetRequest	Descreve uma solicitação para obter um conjunto de itens de trabalho
WorkItemCommentVersionRef	Representa a referência a uma versão específica de um comentário em um Item de Trabalho.
WorkItemErrorPolicy	O sinalizador para controlar a política de erro em uma solicitação de obter itens de trabalho em massa. As opções possíveis são {Fail, Omit}.
WorkItemExpand	Os parâmetros de expansão para atributos de item de trabalho. As opções possíveis são { None, Relations, Fields, Links, All }
WorkItemRelation

ReferenceLinks

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.

WorkItem

Descreve um item de trabalho.

Nome	Tipo	Description
_links	ReferenceLinks	Vincular referências a recursos REST relacionados.
commentVersionRef	WorkItemCommentVersionRef	Referência a uma versão específica do comentário adicionado/editado/excluído nesta revisão.
fields	object	Mapa de campos e valores para o item de trabalho.
id	integer	O ID do item de trabalho.
relations	WorkItemRelation[]	Relações do item de trabalho.
rev	integer	Número de revisão do item de trabalho.
url	string

WorkItemBatchGetRequest

Descreve uma solicitação para obter um conjunto de itens de trabalho

Nome	Tipo	Description
$expand	WorkItemExpand	Os parâmetros de expansão para atributos de item de trabalho. As opções possíveis são { None, Relations, Fields, Links, All }
asOf	string	Cadeia de caracteres de hora de data UTC asOf
errorPolicy	WorkItemErrorPolicy	O sinalizador para controlar a política de erro em uma solicitação de obter itens de trabalho em massa. As opções possíveis são {Fail, Omit}.
fields	string[]	Os campos solicitados
ids	integer[]	As IDs de item de trabalho solicitadas

WorkItemCommentVersionRef

Representa a referência a uma versão específica de um comentário em um Item de Trabalho.

Nome	Tipo	Description
commentId	integer	A ID atribuída ao comentário.
createdInRevision	integer	[Interno] A revisão do item de trabalho em que este comentário foi adicionado originalmente.
isDeleted	boolean	[Interno] Especifica se o comentário foi excluído.
text	string	[Interno] O texto do comentário.
url	string
version	integer	O número de versão.

WorkItemErrorPolicy

O sinalizador para controlar a política de erro em uma solicitação de obter itens de trabalho em massa. As opções possíveis são {Fail, Omit}.

Nome	Tipo	Description
fail	string	Falha na política de erro de trabalho.
omit	string	Omita a política de erro de trabalho.

WorkItemExpand

Os parâmetros de expansão para atributos de item de trabalho. As opções possíveis são { None, Relations, Fields, Links, All }

Nome	Tipo	Description
all	string	Expande tudo.
fields	string	Os campos do item de trabalho se expandem.
links	string	Links de item de trabalho expandem.
none	string	Comportamento padrão.
relations	string	O item de trabalho relações se expande.

WorkItemRelation

Nome	Tipo	Description
attributes	object	Coleção de atributos de link.
rel	string	Tipo de relação.
url	string	Url do link.

Partilhar via