Acompanhamento do item de trabalho

Artigo
07/14/2023

Recursos de acompanhamento de item de trabalho

Obtenha, crie e atualize bugs, tarefas e outros itens de trabalho para sua equipe. As consultas permitem que você use todo o potencial da Work Item Query Language para pesquisar por itens de trabalho e filtrá-los. Você pode usar a Work Item Query Language para chegar a cada item de trabalho que satisfaz a consulta. Itens de trabalho retêm um histórico completo, sendo que você pode obter cada revisão completa do item de trabalho ou apenas as atualizações que foram feitas em cada revisão. Os itens de trabalho também podem ser marcados.

Tarefas comuns

Obter itens de trabalho usando uma consulta

Procure a consulta que você deseja usar.
Obtenha os resultados dessa consulta.
Obtenha cada um dos itens de trabalho por ID.

Atualizar WorkItems em lote

Use a API de Atualização do WorkItem do Lote para atualizar seus workitems em lote.

Atualizar os campos de um item de trabalho

Obtenha a ID do item de trabalho que você deseja atualizar.
Atualize os campos do item de trabalho.

Vincular dois itens de trabalho

Obtenha a ID dos itens de trabalho que você deseja vincular.
Adicione um link entre os itens de trabalho.

Criar dois itens de trabalho e vinculá-los

Use criar um item de trabalho e adicionar apIs de link em uma chamada em lote.

Anexar um arquivo a um item de trabalho

Obtenha a ID do item de trabalho que você deseja atualizar.
Carregue o anexo no repositório de anexos.
Adicione o anexo ao item de trabalho.

Criar um item de trabalho

Crie um item de trabalho. Certifique-se de fornecer pelo menos um título. Alguns tipos de itens de trabalho exigirão valores para outros campos.

Obter o histórico completo de um item de trabalho

Obtenha a ID do item de trabalho.
Obtenha uma lista de atualizações feitas em um item de trabalho.
Obtenha todo o item de trabalho como ele apareceu em qualquer revisão.

Excluir um item de trabalho

Obtenha a ID do item de trabalho.
Exclua o item de trabalho.

Obter os campos usados em um projeto de equipe

Obtenha os tipos de itens de trabalho usados em um projeto de equipe.
Obtenha cada tipo de item de trabalho para ver os campos que ele usa. (Ignore o xmlform para fieldinstances.)

Obter categorias de itens de trabalho

Use categorias de itens de trabalho para obter os tipos de itens de trabalho usados em um projeto de equipe para funções diferentes. Por exemplo, para ver os itens de trabalho que aparecem na lista de pendências, obtenha a categoria de requisitos.

Obter áreas e iterações

Obtenha a hierarquia de área ou a hierarquia de iteração do projeto de equipe.

Obter tipos de relações de item de trabalho

Obtenha os tipos disponíveis de links de item de trabalho que estão disponíveis em sua coleção de projetos.

Recursos de metadados do item de trabalho

Os itens de trabalho são regidos por metadados. Alguns dos metadados têm como escopo um projeto de equipe específico e outros metadados têm o escopo de uma coleção de projetos (como a coleção padrão da conta Azure DevOps Services).

Metadados no escopo do projeto

Seu projeto de equipe tem um conjunto de tipos de item de trabalho. Cada tipo de item de trabalho pode pertencer a uma categoria como "requisito" ou "bug" para definir sua função no projeto. Os nós de classificação definem o conjunto de valores que podem ser usados nos campos de área e iteração para os itens de trabalho no projeto de equipe.

Categorias
Nós de classificação (áreas e iterações)
Tipos de item de trabalho

Metadados no escopo da coleção

Os tipos de item de trabalho compartilham campos e tipos de relação (links e anexos) com outros tipos de itens de trabalho.

API de atualização em lote do item de trabalho

Executa várias solicitações de Atualização de Item de Trabalho. A resposta contém respostas individuais para cada uma das solicitações no lote. As solicitações com falha não afetam as solicitações subsequentes no lote.

SEMÂNTICA DA API REST

PATCH https://dev.azure.com/{organization}/_apis/wit/$batch?api-version=6.1

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Descrição
organization	Caminho	True	string	O nome da organização do Azure DevOps.
api-version	Consulta		string	Versão da API a ser usada.
bypassRules	Consulta		booleano	Não imponha as regras de tipo de item de trabalho nesta atualização.
suppressNotifications	Consulta		booleano	Não dispare nenhuma notificação para essa alteração.

Corpo da solicitação

O corpo da solicitação é composto como uma lista de solicitações de Atualização de Item de Trabalho. Cada item dessa lista concatenará todas as informações sobre uma única Solicitação de Atualização, incluindo método REST, caminho, cabeçalhos e corpo.

Você pode marcar documentação da Atualização de Item de Trabalho para obter informações detalhadas sobre uma única solicitação.

Exemplo de Atualização em Lote

Solicitação

PATCH https://dev.azure.com/fabrikam/_apis/wit/$batch?api-version=6.1

Corpo da solicitação

[
  {
    // Add priority and test rev on work item with id 1
    "method": "PATCH",
    "uri": "/_apis/wit/workitems/1?api-version=6.1",
    "headers": {
      "Content-Type": "application/json-patch+json"
    },
    "body": [
      {
        "op": "test",
        "path": "/rev",
        "value": 3
      },
      {
        "op": "add",
        "path": "/fields/Microsoft.VSTS.Common.Priority",
        "value": "1"
      }
    ]
  },
  {
    // Replace tags on work item with id 299x   
    "method": "PATCH",
    "uri": "/_apis/wit/workitems/299?api-version=6.1",
    "headers": {
      "Content-Type": "application/json-patch+json"
    },
    "body": [
      {
        "op": "replace",
        "path": "/fields/System.Tags",
        "value": "Tag1; Tag2"
      }
    ]
  },
  {
    // You can also use Work Item Create format
    "method": "PATCH",
    "uri": "/mytestprojectname/_apis/wit/workitems/$Bug?api-version=4.1",
    "headers": {
        "Content-Type": "application/json-patch+json"
    },
    "body": [
        {
            "op": "add",
            "path": "/id",
            "value": "-1"
        },
        {
            "op": "add",
            "path": "/fields/System.Title",
            "from": null,
            "value": "Sample 1"
        }
    ]
  },
]

Resposta

A resposta consiste em respostas individuais para cada solicitação de atualização em lote.

count : número de respostas de atualização em lote retornadas
value : lista de objetos de resposta com seu código de resposta, cabeçalhos e corpo

{
  "count": 2,
  "value": [
    {
      "code": 200,
      "headers": {
        "Content-Type": "application/json; charset=utf-8"
      },
      "body": "{work item object}"
    },
    {
      "code": 200,
      "headers": {
        "Content-Type": "application/json; charset=utf-8"
      },
      "body": "{work item object}"
    }
  ]
}