Отслеживание рабочих элементов

  • Статья

Ресурсы отслеживания рабочих элементов

Получайте, создавайте и обновляйте ошибки, задачи и другие рабочие элементы вашей команды. Запросы позволяют использовать все возможности языка запросов рабочих элементов для поиска и фильтрации рабочих элементов. Язык запросов рабочих элементов можно использовать для доступа к каждому рабочему элементу, который соответствует запросу. Рабочие элементы сохраняют всю историю. Вы можете получить полную редакцию рабочего элемента или только обновления, которые были сделаны в каждой редакции. Рабочие элементы также можно пометить.

Стандартные задачи

Получение рабочих элементов с помощью запроса

  1. Найдите нужный запрос .
  2. Получите результаты для этого запроса.
  3. Получение каждого из рабочих элементов по идентификатору.

Пакетное обновление рабочих item

Используйте API batch WorkItem Update для обновления рабочих элементов в пакете.

Обновление полей рабочего элемента

  1. Получите идентификатор рабочего элемента , который требуется обновить.
  2. Обновите поля рабочего элемента.
  1. Получите идентификатор рабочих элементов , которые требуется связать.
  2. Добавьте связь между рабочими элементами.

Создайте рабочий элемент и добавьте API-интерфейсы ссылок в пакетном вызове.

Вложение файла в рабочий элемент

  1. Получите идентификатор рабочего элемента , который требуется обновить.
  2. Отправьте вложение в хранилище вложений.
  3. Добавьте вложение в рабочий элемент.

Создать рабочий элемент

Создайте рабочий элемент. Убедитесь, что вы указали хотя бы заголовок. Для некоторых типов рабочих элементов требуются значения для других полей.

Получение полного журнала рабочего элемента

  1. Получите идентификатор рабочего элемента.
  2. Получение списка обновлений , внесенных в рабочий элемент.
  3. Получение всего рабочего элемента в том виде, в каком он появился в любой редакции.

Удаление рабочего элемента

  1. Получите идентификатор рабочего элемента.
  2. Удалите рабочий элемент.

Получение полей, используемых в командном проекте

  1. Получение типов рабочих элементов, используемых в командном проекте.
  2. Получение каждого типа рабочего элемента для просмотра полей, которые он использует. (Пропустите xmlform в fieldinstances.)

Получение категорий рабочих элементов

Используйте категории рабочих элементов для получения типов рабочих элементов, используемых в командном проекте для различных функций. Например, чтобы просмотреть рабочие элементы, которые отображаются в невыполненной работе, получите категорию требований.

Получение областей и итераций

Получите иерархию областей или иерархию итерации для командного проекта.

Получение типов связей рабочих элементов

Получите доступные типы ссылок на рабочие элементы , доступные в коллекции проектов.

Ресурсы метаданных рабочих элементов

Рабочие элементы управляются метаданными. Некоторые метаданные относятся к определенному командному проекту, а другие метаданные относятся к коллекции проектов (например, коллекции по умолчанию учетной записи Azure DevOps Services).

Метаданные в области проекта

Командный проект содержит набор типов рабочих элементов. Каждый тип рабочего элемента может относиться к категории , например "требование" или "ошибка", чтобы определить его роль в проекте. Узлы классификации определяют набор значений, которые можно использовать в области и полях итерации для рабочих элементов в командном проекте.

Метаданные уровня коллекции

Типы рабочих элементов совместно используют поля и типы отношений (ссылки и вложения) с другими типами рабочих элементов.

API пакетного обновления рабочих элементов

Выполняет несколько запросов на обновление рабочих элементов. Ответ содержит отдельные ответы для каждого из запросов в пакете. Неудачные запросы не влияют на последующие запросы в пакете.

СЕМАНТИКА REST API

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

Параметры URI

Имя В Обязательно Тип Описание
organization Путь True строка Название организации Azure DevOps.
api-version query строка Используемая версия API.
bypassRules query Логическое Не применяйте правила типа рабочих элементов в этом обновлении.
suppressNotifications query Логическое Не запускайте уведомления об этом изменении.

Текст запроса

Текст запроса состоит из списка запросов на обновление рабочих элементов. Каждый элемент из этого списка будет конвертирует все сведения об одном запросе на обновление, включая метод REST, путь, заголовки и текст.

Подробные сведения об одном запросе можно проверка в документации по обновлению рабочих элементов.

Пример пакетного обновления

Запрос

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

Текст запроса

[
  {
    // 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"
        }
    ]
  },
]

Ответ

Ответ состоит из отдельных ответов для каждого пакетного запроса на обновление.

  • count : количество возвращенных ответов пакетного обновления
  • value : список объектов ответа с кодом отклика, заголовками и текстом.
{
  "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}"
    }
  ]
}