Заметки консультанта

Шамрай Александр Владимирович

VSTS Rest Api. 2. Получение рабочих элементов

Posted by Shamrai Alexander на 11 сентября, 2018

<< Перейти в радел «Azure DevOps Services (TFS/VSTS) Rest Api»

Для получения доступа к рабочим элементам и их типам используется клиент WorkItemTrackingHttpClient со следующими методами:

  • Для получения одного рабочего элемента GetWorkItemAsync или нескольких GetWorkItemsAsync со следующими основными параметрами:
    • Id – идентификатор рабочего элемента, который необходимо получить. Для GetWorkItemsAsync используется список идентификаторов.
    • fields – список полей, которые необходимо получить в рабочем элементе
    • asOf – строка, которая содержит дату, которой должно соответствовать содержание рабочего элемента.
    • expand – получить расширенные свойства рабочего элемента. Возможные варианты (на практике используются обычно all и relations):
      • all – получить все свойства.
      • fields – получить только поля.
      • links – получить дополнительно справочные ссылки.
      • none – без дополнительных свойств.
      • relations – получить дополнительно информацию о связях.
  • Для типов рабочих элементов GetWorkItemTypeAsync со следующими параметрами:
    • project – имя проекта
    • type – имя типа рабочего элемента

Класс рабочего элемента можно представить в следующем виде:

public class
WorkItem

{

public int? Id { get; set; }

public int? Rev { get; set; }

public
IDictionary<string, object> Fields { get; set; }

public
IList<WorkItemRelation> Relations { get; set; }

public
ReferenceLinks Links { get; set;
}

}

Поля класса:

  • Id – идентификатор рабочего элемента.
  • Rev – номер версии рабочего элемента.
  • Fields – словарь в виде «имя поля» — «его значение». Этот список содержит только поля, которые имеют установленные значения. Если нужно знать наличие поля в типе рабочего элемента, то его можно получить через GetWorkItemTypeAsync, как указано в примере.
  • Relations – список связей рабочего элемента.
  • Links – класс с дополнительными вспомогательными ссылками на сам рабочий элемент, его тип, поля, истории и т.д.

Пример вызовов методов для получения рабочих элементов:

  • Получить один рабочий элемент:


static WorkItem GetWorkItem(int Id)

{

return WitClient.GetWorkItemAsync(Id).Result;

}

  • Получить рабочий элемент и его связи:


static WorkItem GetWorkItemWithRelations(int Id)

{

return WitClient.GetWorkItemAsync(Id, expand: WorkItemExpand.Relations).Result;

}

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


static WorkItemType GetWorkItemType(WorkItem WI)

{

return WitClient.GetWorkItemTypeAsync((string)WI.Fields[«System.TeamProject»], (string)WI.Fields[«System.WorkItemType»]).Result;

}

Пример приложения можно посмотреть здесь:

https://github.com/ashamrai/TFRestApi/tree/master/02.TFRestApiAppGetWorkItems

English version

Один ответ to “VSTS Rest Api. 2. Получение рабочих элементов”

  1. […] Как получить детали рабочего элемента описано здесь: Получение рабочих элементов. Пример получения списка рабочих […]

Добавить комментарий

Заполните поля или щелкните по значку, чтобы оставить свой комментарий:

Логотип WordPress.com

Для комментария используется ваша учётная запись WordPress.com. Выход /  Изменить )

Google photo

Для комментария используется ваша учётная запись Google. Выход /  Изменить )

Фотография Twitter

Для комментария используется ваша учётная запись Twitter. Выход /  Изменить )

Фотография Facebook

Для комментария используется ваша учётная запись Facebook. Выход /  Изменить )

Connecting to %s

 
%d такие блоггеры, как: