Справочник по метаданным для Аналитики Azure Boards

  • Статья

Azure DevOps Services | Azure DevOps Server 2022 — Azure DevOps Server 2019

Служба Аналитики собирает все действия отслеживания работы, определенные и обновленные с помощью Azure Boards. Аналитика хранит как свойства всех полей отслеживания работы, за исключением полей HTML/rich-text и журнала. Пользовательские свойства для настраиваемых полей автоматически добавляются в Аналитику.

В этой статье описывается большинство свойств, которые можно использовать для создания отчета аналитики для отслеживания работы. Вы используете сочетание свойств для фильтрации запроса, агрегирования данных или создания отчета. Эти запросы можно выполнять непосредственно в браузере. Дополнительные сведения см. в статье "Определение базовых запросов с помощью OData Analytics". Если вы не знакомы с отслеживанием работы и Azure Boards, рекомендуем ознакомиться со следующими статьями:

Примечание.

Приведены описания сущностей, свойств и перечисленных типов, поддерживаемых моделью данных Аналитики. Это ранний проект. Укажите отзывы о областях, которые вы хотите получить дополнительные сведения. Сведения о запросе модели данных см. в разделе "Создание запросов OData для аналитики".

Обзор наборов сущностей

При запросе аналитики для данных отслеживания работы используйте один из следующих типов сущностей или наборов сущностей.

  • Запрос WorkItems для создания отчетов о состоянии и свертки
  • Запрос WorkItemSnapshot для создания отчетов о тренде, сгорении и сгорении

Используйте другие типы сущностей, например Area, Iteration, TeamProjectили другие сущности для фильтрации данных или выбора свойств для отчета. Сводка примеров отчетов см. в разделе "Примеры отчетов" и краткий справочный индекс.

Примечание.

Чтобы создать отчеты о состоянии и тренде для типов рабочих элементов, запросите WorkItems типы сущностей и WorkItemSnapshot фильтр на основе типа рабочего элемента. Сведения о тестовых запусках, результатах теста или других тестовых данных, запросите TestRunsтипы сущностей или TestPointHistorySnapshot ,TestResultsDailyTestPointsTestSuite. Дополнительные сведения см . в справочнике по метаданным тестов для Azure DevOps.

EntitySet EntityType Description
Области Область Путь к области рабочего элемента с свойствами для группировки и фильтрации по иерархии областей.
Даты CalendarDate Даты, используемые для фильтрации и группировки других сущностей с помощью связей.
Итераций Итерация Пути итерации рабочего элемента с свойствами для группировки и фильтрации по иерархии итерации.
BoardLocations BoardLocation Ячейки канбан-доски, как определено столбец доски, пловец и разделение, включают исторические параметры доски. Описание каждого поля доски Kanban см. в полях рабочего процесса и канбан-доски.
Процессы Обработать Сведения о невыполненной работе, используемые для расширения или фильтрации рабочих элементов и типов рабочих элементов. Пример, использующий процессы для фильтрации отчета, см . в примере отчета о отслеживании требований. Поддерживается для аналитики версии 2.0 и более поздних версий.
Проекты Проект Все проекты, определенные для организации (облака) или коллекции проектов (локальная среда).
Теги Тег Все теги рабочих элементов для каждого проекта. Пример, использующий теги для фильтрации отчета, см . в примере отчета о выпуске.
Teams Команда Все команды, определенные для проекта. Пример, использующий Teams для фильтрации отчета, см. в разделе "Добавление среза команды" в отчет Power BI.
Пользователи Пользователь Сведения о пользователе, которые используются для расширения или фильтрации различных свойств рабочего элемента, например "Назначено" и "Создано".
WorkItemBoardSnapshot WorkItemBoardSnapshot (Составной) Состояние каждого рабочего элемента на каждой дате календаря, включая расположение доски Kanban, используемое для создания отчетов о трендах. Пример отчета см . в примере отчета о накопительной схеме потоков (CF).
WorkItemLinks WorkItemLink Связи между рабочими элементами, например дочерними, родительскими и связанными. Включает только последнюю редакцию ссылок, журнал не содержит. Гиперссылки не включены.
WorkItemRevisions WorkItemRevision Все исторические редакции рабочих элементов, включая текущую редакцию. Не включает удаленные рабочие элементы.
WorkItemSnapshot WorkItemSnapshot (Составной) Состояние каждого рабочего элемента на каждой дате календаря, используемое для поддержки отчетов о трендах. Пример отчета см . в примере отчета об ошибках.
WorkItems Workitem Текущее состояние рабочих элементов. Используется для поддержки отчетов о состоянии. Пример отчета см. в разделе "Свертка значений дочерних рабочих элементов" для родительского примера отчета.
WorkItemTypeFields WorkItemTypeField Свойства рабочего элемента для каждого типа рабочего элемента и процесса. Используется для поддержки создания отчетов.

Сведения о моментальных снимках

Существует два набора сущностей моментального снимка отслеживания работы: WorkItemSnapshot и WorkItemBoardSnapshot.

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

Дополнительные сведения см . в рекомендациях по запросам OData, а также еженедельные или ежемесячные моментальные снимки для запросов трендов, охватывающих длительный период времени.

Сведения о редакциях рабочих элементов

При каждом обновлении рабочего элемента система создает новую редакцию и записывает это действие в System.RevisedDate поле, что делает его полезным для указания фильтра журнала. Измененная дата представлена свойствами RevisedDate (DateTime) и RevisedDateSK (Int32). Для повышения производительности используйте последний суррогатный ключ даты. Она представляет дату создания редакции или имеет значение NULL для активных или неполных редакций.

Если вы хотите все даты, начиная с инклюзивного {startDate} , добавьте следующий фильтр в запрос.

RevisedDateSK eq null or RevisedDateSK gt {startDateSK}

Для загрузки всех исправлений для заданного рабочего элемента используется WorkItemRevisions набор сущностей. Запрос возвращает все исторические редакции рабочих элементов, включая текущую редакцию, для рабочих элементов, которые вы фильтруете. Он не включает удаленные рабочие элементы.

Общие свойства нескольких типов сущностей

Свойства, которые можно выбрать в представлении Аналитики, соответствуют обычным полям отслеживания работы и выберите свойства аналитики, такие как "Время цикла" и "Дни времени свинца". Эти свойства, большинство из которых перечислены и описаны в следующей таблице, определяются для следующих типов сущностей, если иное не указано.

  • WorkItem
  • WorkItemRevision
  • WorkItemSnapshot
  • WorkItemBoardSnapshot

Примечание.

Служба аналитики не сохраняет данные для длинных текстовых полей, назначенных типу ДАННЫХ HTML или форматированного текста. К ним относятся поля "Описание " и "Журнал ". Аналитика не сохраняет ссылки или количество вложенных файлов. Полный список полей, определенных в шаблонах процессов по умолчанию, см. в разделе "Индекс поля рабочего элемента". Описание каждого типа данных см. в полях запросов, операторах и макросах.
Не все свойства, связанные с полями scrum и CMMI, включаются в следующую таблицу. Список этих полей см . в описаниях полей по умолчанию и рабочих элементов, используемых в шаблонах процессов, полях, используемых для отслеживания рабочих элементов CMMI.

Многие свойства основаны на дате или на основе пользователей. Эти свойства связаны с наборами сущностей CalendarDate и User , описанными в разделе "Дата календаря", "Проект" и "Метаданные пользователя".

Отображаемое имя
Property name		 Тип данных Description
Reference name
Принято
Microsoft_VSTS_CodeReview_AcceptedBy		 UserSK Имя пользователя, который ответил на проверку кода. (процесс CMMI)
Microsoft.VSTS.CodeReview.AcceptedBy
Дата принятия
AcceptedDate		 Дата/время Дата и время, когда пользователь ответил на проверку кода. (процесс CMMI)
Microsoft.VSTS.CodeReview.AcceptedDate
Активировано
ActivatedBy
ActivatedByUserSK		 UserSK Имя участника группы, активированного или повторно активированного рабочего элемента.
Microsoft.VSTS.Common.ActivatedBy
Дата активации
ActivatedDate		 Дата/время Дата и время активации или повторной активации или повторной активации элемента группы.
Microsoft.VSTS.CodeReview.ActivatedDate
Деятельность
Activity		 Строка Тип действия, необходимого для выполнения задачи.
Microsoft.VSTS.Common.Activity

Тип действия или дисциплины, назначенных задаче. Допустимые значения: развертывание, проектирование, разработка, документация, требования и тестирование. (Гибкий, scrum и базовый процесс)
Microsoft.VSTS.Common.Activity
AnalyticsUpdatedDate DateTimeOffset Данные и время последнего обновления сущности.
Тип приложения Строка Тип приложения, по которому заинтересованные стороны будут предоставлять отзывы. Значения по умолчанию — веб-приложение, удаленный компьютер и клиентское приложение. Допустимые типы указываются в файле конфигурации процесса для проектов, использующих локальный XML-процесс.
Microsoft_VSTS_Feedback_ApplicationType
Путь к области
AreaPath
AreaSK		 Строка Группу рабочих элементов в области компонентов продукта или групп. Область должна быть допустимым узлом в иерархии проекта.
System.AreaPath
Назначено
AssignedTo
AssignedToUserSK		 UserSK Имя члена группы, которому в настоящее время принадлежит рабочий элемент.
System.AssignedTo
Автоматический идентификатор теста
AutomatedTestId		 Строка Идентификатор теста, который автоматизирует тестовый случай.
Microsoft.VSTS.TCM.AutomatedTestId
Автоматическое имя теста
AutomatedTestName		 Строка Имя участника группы, активированного или повторно активированного рабочего элемента.
Microsoft.VSTS.TCM.AutomatedTestName
Автоматизированное тестирование служба хранилища
AutomatedTestStorage		 Строка Сборка, содержащая тест, который автоматизирует тестовый случай.
Microsoft.VSTS.TCM.AutomatedTestStorage
Автоматический тип теста
AutomatedTestType		 Строка Тип теста, который автоматизирует тестовый случай.
Microsoft.VSTS.TCM.AutomatedTestType
Состояние автоматизации
AutomatedStatus		 Строка Состояние тестового случая со следующими принятыми значениями: "Автоматический", "Не автоматизирован" или "Запланированный".
Microsoft.VSTS.TCM.AutomationStatus
Приоритет невыполненной работы
BacklogPriority		 Двойной Номер, назначенный системным фоновым процессом, используемым для стека ранга или отслеживания последовательности элементов в невыполненной работы или доске. (Процесс scrum)
Microsoft.VSTS.Common.BacklogPriority
Заблокировано
Blocked		 Строка Указывает, что дальнейшие действия не могут выполняться на рабочем элементе. Допустимые значения: "Да " или "Нет". (процесс CMMI)
Microsoft.VSTS.CMMI.Blocked
Ценность бизнеса
BusinessValue		 Двойной Субъективная единица измерения, которая фиксирует относительную бизнес-ценность элемента невыполненной работы продукта или функции по сравнению с другими элементами того же типа. Элемент, назначаемый более высоким числом, должен рассматриваться как имеющий больше бизнес-ценности, чем элемент, которому назначено меньшее число.
Microsoft.VSTS.Common.BusinessValue
Изменено
ChangedBy
ChangedByUserSK		 UserSK Имя пользователя, изменившего рабочий элемент в последнее время.
System.ChangedBy
Дата изменения
ChangedDate		 Дата/время Дата и время изменения рабочего элемента.
System.ChangedDate
ChangedDateSK Int32 Дата изменения рабочего элемента, выраженного как YYYYMMDD в часовом поясе, определенном для организации. Используется внешними средствами для присоединения связанных сущностей.
ChangedOn Переходы Свойство навигации в Date сущность для даты изменения рабочего элемента в часовом поясе, определенном для организации. Часто используется для ссылки на свойства сущности Date в groupby инструкциях.
Закрыто
ClosedBy
ClosedByUserSK		 UserSK Имя человека, закрывшего рабочий элемент.
Microsoft.VSTS.Common.ClosedBy
Дата закрытия
ClosedDate
ClosedDateSK
ClosedOn		 Дата/время Дата и время закрытия рабочего элемента.
Microsoft.VSTS.Common.ClosedDate
Число комментариев
CommentCount		 Int32 Количество комментариев, добавленных в раздел "Обсуждение " рабочего элемента.
System.CommentCount
Совершил
Committed		 Строка Указывает, зафиксировано ли требование в проекте. Допустимые значения: "Да " или "Нет". (процесс CMMI)
Microsoft.VSTS.CMMI.Committed
CompletedDateSK Int32 Дата свойства навигации, записанная аналитикой, которая сохраняет, когда рабочий элемент ввел состояние рабочего процесса, связанное с категорией состояния завершенного рабочего процесса.
CompletedOn Переходы Свойство навигации для Date сущности с датой, когда рабочий элемент ввел состояние рабочего процесса, связанное с категорией состояния завершенного рабочего процесса, в часовом поясе, определенном для организации. Часто используется для ссылки на свойства сущности Date в groupby инструкциях.
Завершенная работа
CompletedWork		 Двойной Мера объема работы, потраченной на задачу.
Microsoft.VSTS.Scheduling.CompletedWork
Автор
CreatedBy
CreatedByUserSK		 UserSK Имя пользователя, создавшего рабочий элемент.
Microsoft.VSTS.Common.CreatedBy
Дата создания
CreatedDate
CreatedDateSK		 Дата/время Дата создания рабочего элемента, выраженного в часовом поясе , определенном для организации. Часто используется для фильтрации и отображения.
Microsoft.VSTS.Common.CreatedDate
CreatedDateSK Int32 Дата создания рабочего элемента, выраженного как YYYYMMDD в часовом поясе, определенном для организации. Используется внешними средствами для присоединения связанных сущностей.
CreatedOn Переходы Свойство навигации в Date сущность для даты создания рабочего элемента в часовом поясе, определенном для организации. Часто используется для ссылки на свойства сущности Date в groupby инструкциях.
Время цикла
CycleTimeDays		 Двойной Время цикла вычисляется при первом вводе категории состояния "Выполняется " или "Разрешено " для ввода категории состояния "Завершено ". Дополнительные сведения см . в мини-приложениях времени и времени цикла.
Дисциплины
Discipline		 Строка Тип действия или дисциплины, назначенных задаче. Допустимые значения: анализ*, разработка, тестирование, обучение пользователей и взаимодействие с пользователем. (процесс CMMI)
Microsoft.VSTS.Common.Activity
Срок оплаты
DueDate		 Дата/время Прогнозируемая дата выполнения, с помощью которой будет устранена проблема или рабочий элемент. (Гибкий процесс)
Microsoft.VSTS.Scheduling.DueDate
Трудозатраты
Effort		 Двойной Оценка объема работы, которую потребуется реализовать элемент невыполненной работы продукта (процесс Scrum) или проблема (базовый процесс).
Microsoft.VSTS.Scheduling.Effort
Дата завершения
FinishDate		 Дата/время Дата и время, когда расписание указывает, что рабочий элемент будет завершен.
Microsoft.VSTS.Scheduling.FinishDate
Найдено в
FoundIn		 Строка Номер сборки продукта, также известный как редакция, в которой обнаружена ошибка.
Microsoft.VSTS.Build.FoundIn
Дата InProgress
InProgressDate		 Дата/время Аналитика хранит дату, которая фиксирует дату, когда рабочий элемент был перемещен в состояние , которое принадлежит категории состояния "Ход выполнения ".
InProgressDateSK Int32 Дата перемещения рабочего элемента в состояние, которое принадлежит категории состояния "Ход выполнения ", выраженное как YYYYMMDD в часовом поясе, определенном для организации. Используется внешними средствами для присоединения связанных сущностей.
Сборка интеграции
IntegrationBuild		 Строка Номер сборки продукта, который включает код или исправляет ошибку.
Microsoft.VSTS.Build.IntegrationBuild
Текущая
IsCurrent		 Логический Поддерживает фильтрацию данных для просмотра последнего моментального снимка отфильтрованного набора рабочих элементов, задав значение True.
Допустимо для этих типов сущностей: WorkItemRevision, WorkItemBoardSnapshotи BoardLocation.
Является последней редакцией дня
IsLastRevisionOfDay		 Логический Указывает, что моментальный снимок представляет последнюю редакцию дня, когда задано Trueзначение .
Является последней редакцией периода
IsLastRevisionOfPeriod		 Логический Указывает, что моментальный снимок представляет последнюю редакцию периода, когда задано Trueзначение .
Проблема
Issue		 Строка Указывает, что общий шаг связан с ожидаемым результатом. Допустимые значения: "Да " и "Нет".
Microsoft.VSTS.Common.Issue
Время выполнения
LeadTimeDays		 Двойной Время выполнения вычисляется из создания рабочего элемента или ввода категории "Предлагаемое состояние" для ввода категории завершенного состояния. Дополнительные сведения см . в мини-приложениях времени и времени цикла.
Исходная оценка
OriginalEstimate		 Двойной Мера объема работы, необходимой для выполнения задачи.
Microsoft.VSTS.Scheduling.OriginalEstimate
Идентификатор родительского рабочего элемента
ParentWorkItemId		 Int32 Уникальный идентификатор, определяющий рабочий элемент, связанный с родительским элементом. Полезно для создания отчетов свертки. Родительское поле доступно из Azure DevOps Server 2020 и более поздних версий. Допустимо для этих типов сущностей: WorkItemRevision и WorkItem.
System.Parent
Приоритет
Priority		 Int32 Субъективная оценка ошибки, проблемы, задачи или тестового случая, как это относится к бизнесу. К значениям относятся: 1, 2 или 3.
Microsoft.VSTS.Common.Priority
Имя проекта
ProjectName		 Переходы Имя проекта, к которому принадлежит рабочий элемент. Дополнительные сведения см. в разделе "Дата календаря", "Проект" и "Метаданные пользователя", "Свойства проекта".
System.TeamProject
ProjectSK GUID GUID, назначенный проекту, которому принадлежит рабочий элемент.
Оценка
Reason		 Строка Количество звезд, полученных от рецензента в системе ранжирования на основе звезд. (Ответ обратной связи) Число хранится в системе и записывается следующим образом: - 0 - Не оценено, 1 - Бедный, 2 - Fair, 3 - Good, 4 - Очень хорошо, и 5 - Отлично. Допустимо для этих типов сущностей: WorkItemRevision и WorkItem.
Microsoft.VSTS.Common.Rating
Причина
Reason		 Строка Причина, по которой рабочий элемент находится в текущем состоянии. Каждый переход из одного состояния рабочего процесса в другое связан с соответствующей причиной.
System.Reason
Оставшиеся трудоемкие
RemainingWork		 Двойной Мера объема работы, которая остается для завершения задачи.
Microsoft.VSTS.Scheduling.RemainingWork
Разрешено по
ResolvedBy
ResolvedByUserSK		 UserSK Имя члена группы, который разрешил ошибку или историю пользователя.
Microsoft.VSTS.Common.ResolvedBy
Дата разрешения
ResolvedDate		 Дата/время Дата и время устранения ошибки или истории пользователя.
Microsoft.VSTS.Common.ResolvedDate
ResolvedDateSK Int32 Дата разрешения рабочего элемента, выраженная как YYYYMMDD в часовом поясе, определенном для организации. Используется внешними средствами для присоединения связанных сущностей.
ResolvedOn Переходы Свойство навигации в Date сущность для даты разрешения рабочего элемента в часовом поясе, определенном для организации. Часто используется для ссылки на свойства сущности Date в groupby инструкциях.
Устраненная причина
ResolvedReason		 Строка Причина устранения ошибки (например, исправлена).
Microsoft.VSTS.Common.ResolvedReason
Revision
Revision		 Int32 Число, назначенное исторической редакции рабочего элемента.
System.Rev
Измененная дата
RevisedDate		 Дата/время Дата и время изменения или обновления рабочего элемента.
RevisedDateSK Int32 Дата изменения рабочего элемента, выраженного как YYYYMMDD в часовом поясе, определенном для организации. Используется внешними средствами для присоединения связанных сущностей.
RevisedOn Переходы Свойство навигации к Date сущности для даты изменения рабочего элемента в часовом поясе, определенном для организации. Часто используется для ссылки на свойства сущности Date в groupby инструкциях.
Риск
Risk		 Двойной Субъективная оценка относительной неопределенности о успешном завершении истории пользователя. Допустимые значения: 1 — высокий, 2 — средний и 3 — низкий.
Microsoft.VSTS.Common.Risk
Уровень серьезности
Severity		 Двойной Субъективная оценка влияния ошибки, проблемы или риска для проекта. Допустимые значения: 1 — критическое, 2 — высокий, 3 — средний и 4 — низкий.
Microsoft.VSTS.Common.Severity
Размер
Size		 Двойной Оценка объема работы, необходимой для реализации требования (процесса CMMI).
Microsoft.VSTS.Scheduling.Size
Ранжирование стека
StackRank		 Двойной Номер, назначенный системным фоновым процессом, используемым для стека ранга или отслеживания последовательности элементов в невыполненной работы или доске. (Гибкие, scrum и базовые процессы)
Microsoft.VSTS.Common.StackRank
Дата начала
StartDate		 Дата/время Дата и время, назначенные рабочему элементу для начала работы.
Microsoft.VSTS.Scheduling.StartDate
Штат
State		 Строка Текущее состояние рабочего элемента. Допустимые значения состояния зависят от каждого типа рабочего элемента и настроек, внесенных в него.
System.State
Категория состояния
StateCategory		 Строка Категории состояний определяют, как Azure Boards и выбор мини-приложений панели мониторинга обрабатывают каждое состояние рабочего процесса. Категории состояний, используемые в использовании, включают в себя: предлагаемые, в ходе выполнения, разрешенные, удаленные и завершенные. Дополнительные сведения см. в статье "Использование состояний рабочего процесса и категорий состояний". Допустимо только для типа сущности WorkItemRevision .
Дата изменения состояния
StateChangeDate		 Дата/время Дата и время изменения значения поля State .
Microsoft.VSTS.Common.StateChangeDate
StateChangeSK Int32 Дата изменения состояния рабочего элемента, выраженного как YYYYMMDD в часовом поясе, определенном для организации. Используется внешними средствами для присоединения связанных сущностей.
StateChangeOn Переходы Свойство навигации в Date сущность для даты изменения состояния рабочего элемента в часовом поясе, определенном для организации. Часто используется для ссылки на свойства сущности Date в groupby инструкциях.
Точки истории
StoryPoints		 Двойной Оценка объема работы, которую требует пользовательская история (гибкий процесс) для реализации, обычно агрегированной в виде суммы.
Microsoft.VSTS.Scheduling.StoryPoints
Теги
TagNames		 Строка Разделенный точкой с запятой список тегов, назначенных одному или нескольким рабочим элементам в целях фильтрации или запроса.
System.Tags
Целевая дата
TargetDate		 Дата/время Прогнозируемая дата выполнения, с помощью которой будет устранена или завершена проблема или другой рабочий элемент.
Microsoft.VSTS.Scheduling.TargetDate
Тип набора тестов Строка Указывает тип набора тестов. Допустимые значения: на основе запросов, на основе требований и статические.
Microsoft_VSTS_TCM_TestSuiteType
Идентификатор типа набора тестов Int64 Назначенный системой номер, соответствующий категории набора тестов и применимый только к наборам тестов. Назначенные значения: 1 (статический), 2 (на основе запросов) и 3 (на основе требований).
Microsoft_VSTS_TCM_TestSuiteTypeId
Критическое значение времени
TimeCriticality		 Двойной Субъективная единица измерения, которая фиксирует снижение бизнес-ценности с течением времени. Более высокие значения указывают на то, что эпический или компонент по сути является более критически важным, чем эти элементы с более низкими значениями.
Microsoft.VSTS.Common.TimeCriticality
Заголовок
Title		 Строка Краткое описание, в котором описывается рабочий элемент и помогает членам команды отличить его от других рабочих элементов в списке.
System.Title
Область значений
ValueArea		 Строка Область ценности клиента, которую решает эпический, компонент или элемент невыполненной работы. К ним относятся: архитектура или бизнес.
Microsoft.VSTS.Common.ValueArea
Водяной знак
Watermark		 Строка Управляемое системой поле, которое увеличивается с изменениями, внесенными в рабочий элемент. Допустимо для этих типов сущностей: WorkItemRevision и WorkItem.
System.Watermark
Идентификатор рабочего элемента
WorkItemId		 Int32 Уникальный идентификатор, назначенный рабочему элементу. Идентификаторы рабочих элементов уникальны во всех проектах и в организации или коллекции проектов.
System.Id
WorkItemRevisionSK Int32 Уникальный ключ аналитики для редакции рабочего элемента, который используется внешними средствами для объединения связанных сущностей.
Тип рабочего элемента
WorkItemType		 Строка Имя типа рабочего элемента. Типы рабочих элементов определяются на основе процесса, используемого при создании проекта. Дополнительные сведения см. в разделе "Сведения о процессах и шаблонах процессов".
System.WorkItemType

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

Показать имя Имя
Ограничение ссылок и свойство		 Допустимо для типов сущностей
ChangedOn
ChangedDateSK, DateSK		 WorkItemRevision, WorkItemSnapshot, WorkItemBoardSnapshot
ClosedOn
ClosedDateSK, DateSK		 WorkItemRevision, WorkItemSnapshot, WorkItemBoardSnapshot
CreatedOn
CreatedDateSK, DateSK		 WorkItemRevision, WorkItemSnapshot, WorkItemBoardSnapshot
ResolvedOn
ResolvedDateSK, DateSK		 WorkItemRevision, WorkItem, WorkItemSnapshot, WorkItemBoardSnapshot
StateChangeOn
StateChangeDateSK, DateSK		 WorkItemRevision, WorkItem, WorkItemSnapshot, WorkItemBoardSnapshot
InProgressOn
InProgressDateSK, DateSK		 WorkItemRevision, WorkItem, WorkItemSnapshot, WorkItemBoardSnapshot
CompletedOn
CompletedDateSK, DateSK		 WorkItemRevision, WorkItem, WorkItemSnapshot, WorkItemBoardSnapshot
ChangedOn
ChangedDateSK, DateSK		 WorkItemRevision, WorkItem, WorkItemSnapshot, WorkItemBoardSnapshot
RevisedOn
RevisedDateSK, DateSK		 WorkItemRevision, WorkItemSnapshot
Date
DateSK, DateSK		 WorkItemRevision, WorkItemSnapshot, WorkItemBoardSnapshot
Области Area
AreaSK		 WorkItemRevision, WorkItem, WorkItemSnapshot, WorkItemBoardSnapshot
BoardLocation WorkItemRevision, WorkItem, WorkItemBoardSnapshot
Итераций Iteration
IterationSK		 WorkItemRevision, WorkItem, WorkItemSnapshot, WorkItemBoardSnapshot
Назначено AssignedTo
AssignedToUserSK, UserSK		 WorkItemRevision, WorkItem, WorkItemSnapshot, WorkItemBoardSnapshot
Изменено ChangedBy
ChangedByUserSK, UserSK		 WorkItemRevision, WorkItem, WorkItemSnapshot, WorkItemBoardSnapshot
Автор CreatedBy
CreatedByUserSK, UserSK		 WorkItemRevision, WorkItem, WorkItemSnapshot, WorkItemBoardSnapshot
Активировано ActivatedBy
ActivatedByUserSK, UserSK		 WorkItemRevision,WorkItem, WorkItemSnapshot, WorkItemBoardSnapshot
Закрыто ClosedBy
ClosedBySK, UserSK		 WorkItemRevision, WorkItem, WorkItemSnapshot, WorkItemBoardSnapshot
ResolvedBy ResolvedBy
ResolvedByUserSK, UserSK		 WorkItemRevision, WorkItemSnapshot, WorkItemBoardSnapshot
Teams Area, BoardLocation, Iteration, WorkItemRevision, WorkItemSnapshot, WorkItemBoardSnapshot
Теги WorkItem, WorkItemRevision, WorkItemBoardSnapshot
Проект Project
ProjectSK, ProjectSK		 Tag, WorkItemBoardSnapshot, WorkItemLink, WorkItemRevision, WorkItemSnapshot, WorkItemTypeField,
Процессы WorkItemRevision, WorkItem, WorkItemSnapshot
Редакции WorkItem
Ссылки WorkItem
Children WorkItem
Parent WorkItem
Descendants WorkItem
Workitem WorkItemId WorkItemRevision

Прогнозирование функций

Следующие две функции поддерживаются для сущности WorkItem . Эти функции используются в поддержке прогнозных тенденций для выбора встроенных отчетов и мини-приложений аналитики.

  • PredictTags
  • Predict

BoardLocation и WorkItemBoardSnapshot

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

  • BoardLocation
  • WorkItemBoardSnapshot

Пример запроса WorkItemBoardSnapshot набора сущностей см . в примере отчета о накопительной схеме потоков (CF).

Отображаемое имя
Property name		 Тип данных Description
Reference name
Идентификатор доски
BoardId		 GUID Уникальный GUID, назначенный доске Kanban. Каждая команда связана с одной или несколькими досками Канбан.
Имя ссылки на категорию доски
BoardCategoryReferenceName		 Строка Имя, назначенное категории типов рабочих элементов, используемых для заполнения доски Kanban. Например, доска невыполненной работы продукта связана с категорией "Требования". Дополнительные сведения см. в разделе "Настройка невыполненных работ" или "Доски" (процесс наследования).
Имя доски
BoardName		 Строка Имя, назначенное доске Канбан. Например, Истории, Невыполненные элементы, функции и эпические эпосы.
Уровень платы
BoardLevel		 Int32 Номер, назначенный совету Канбана на основе того, где он находится в иерархии канбан-досок.
Тип невыполненной работы
BacklogType		 Строка Имя типа невыполненной работы. Например, итерация, требование или портфель.
Имя столбца
ColumnName		 Строка Имя столбца канбан-доски, назначаемого рабочим элементом, например "Активный", "Закрытый", "Зафиксировано", "Готово" или другой настраиваемой метки столбца.
System.BoardColumn
Порядок столбцов
ColumnOrder		 Int32 Номер, назначенный столбцу канбанской доски с точки зрения его последовательности в доске Канбан.
Готово
Done		 Enumerated Указывает расположение разделенных столбцов. Допустимые значения перечислены ниже для BoardColumnSplit.
Ограничение элемента столбца
ColumnItemLimit		 Int32 Номер, назначенный столбцу Канбан-доски с точки зрения его последовательности.
Отображается доска
IsBoardVisible		 Логический Указывает, выбрана ли команда, чтобы сделать доску видимой или нет.
Разделение столбцов
IsColumnSplit		 Логический Указывает, был ли столбец разделен на столбцы "Выполнение" и "Готово", как описано в разделе "Разделение столбцов" на доске Kanban для отображения работы.
Текущая
IsCurrent		 Логический Свойство, поддерживающее фильтрацию данных для просмотра последнего моментального снимка отфильтрованного набора рабочих элементов, задав значение True.
Является полосой по умолчанию
IsDefaultLane		 Логический Свойство, указывающее, что рабочий элемент назначается дорожке по умолчанию (True) или нет (False).
Готово
IsDone		 Логический Текущее назначение рабочего элемента для действия (False) или Готово (True) в столбце Kanban. Назначается только при включении разделенных столбцов для столбца канбан-доски.
System.BoardColumnDone
Идентификатор лейн
LaneId		 GUID Уникальный GUID, назначенный полосе плавать на борту Канбана. Каждая команда может добавить одну или несколько плаваловых полос на доску Канбан. Дополнительные сведения о купальниках см. в статье "Ускорение работы вашей команды" с помощью пловцов в доске Kanban.
Имя полосы
LaneName		 Строка Имя, назначенное бассейну Канбана.
System.BoardLane
Порядок полос
LaneOrder		 Int32 Номер, назначенный канбанской доске пловец с точки зрения его последовательности.

Перечисленные члены BoardColumnSplit

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

Имя участника Значение Показать имя
Doing 0 Выполняется
Done 1 Выполнено
Unknown 2 Неизвестно (не разделено)

Дополнительные сведения о столбцах доски для команды см. в следующих статьях:

Области

Следующие свойства допустимы для набора сущностей "Области ", связанного с полем "Путь к области". Суррогатные ключи, связанные с областью , включают AreaSK и ProjectSK. Эти свойства можно использовать для фильтрации или отчета о данных отслеживания работы на основе назначений пути области.

Отображаемое имя Имя Тип данных Description
AnalyticsUpdatedDate Дата/время Подложка, указывающая время последнего обновления данных Аналитики.
Number Int32 Целочисленное значение, назначенное узлу пути к области при его создании.
Глубина Depth Int32 Уровень, на котором определяется путь области на основе глубины от корневого уровня.
Идентификатор области AreaId GUID Уникальный идентификатор, назначенный пути к области при его создании.
Уровень области 1–1
Уровень области 14		 AreaLevel1 Через
AreaLevel14		 Строка Имя, связанное с уровнем узла пути к области. Поддерживаются до 14 вложенных уровней. Например, уровень 1 области всегда соответствует корневому узлу и имени проекта.
Имя области AreaName Строка Имя, определенное для пути области при его создании.
Путь к области AreaPath Строка Полный путь к пути области, начиная с корневого узла.

Важно!

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

Свойства навигации для типа сущности "Область " и набора сущностей "Области " включают Project и Teams.

Дополнительные сведения о путях области см. в следующих статьях:

Итерации

Следующие свойства допустимы для набора сущностей итерации , связанного с полем "Путь итерации". Суррогатные ключи, связанные с итерацией , включают IterationSK и ProjectSK. Эти свойства можно использовать для фильтрации или отчета о данных отслеживания работы на основе назначений пути итерации.

Отображаемое имя Имя Тип данных Description
AnalyticsUpdatedDate Дата/время Подложка, указывающая время последнего обновления данных Аналитики.
Number Int32 Целочисленное значение, назначенное узлу пути итерации при его создании.
Глубина Depth Int32 Уровень, на котором определяется путь итерации на основе глубины от корневого уровня.
Дата окончания EndDate Дата/время Дата окончания, определенная для пути итерации.
IsEnded IsEnded Логический Если задано значение True, указывает, что дата окончания пути итерации находится в прошлом.
Идентификатор итерации IterationId GUID Уникальный идентификатор, назначенный пути итерации при его создании.
Уровень итерации 1–1
Уровень итерации 14		 IterationLevel1 Через
IterationLevel14		 Строка Имя, связанное с уровнем узла пути итерации. Поддерживаются до 14 вложенных уровней. Например, уровень итерации 1 всегда соответствует корневому узлу и имени проекта.
Имя итерации IterationName Строка Имя, определенное для пути итерации при его создании.
Путь итерации IterationPath Строка Полный путь пути итерации, начиная с корневого узла. Итерация должна быть допустимым узлом в иерархии проекта.
System.IterationPath
Дата начала StartDate Дата/время Дата начала, определенная для пути итерации.

Важно!

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

Свойства навигации для типа сущности и набора сущностей итерациивключают Project иTeams.

Дополнительные сведения о путях итерации см. в следующих статьях:

Процессы

Следующие свойства допустимы для типа сущности Process и набора сущностей Process . Суррогатные ключи, связанные с процессом , включают ProcessSK, ProjectSKи TeamSK. Эти свойства можно использовать для фильтрации или отчета о данных отслеживания работы на основе типов рабочих элементов, используемых проектом или командой.

Примечание.

Тип сущности Process и набор сущностей Process поддерживаются в версиях 2.0, версии 3.0-preview и версии 4.0-preview аналитики.

Эти свойства можно использовать для фильтрации данных отслеживания работы на основе уровня невыполненной работы

Отображаемое имя Имя Тип данных Description
AnalyticsUpdatedDate Дата/время Подложка, указывающая время последнего обновления данных Аналитики.
ProjectSK GUID Ключ проекта, связанный с процессом.
TeamSK GUID Ключ группы, связанный с процессом.
Имя ссылки на категорию невыполненной работы BacklogCategoryReferenceName Строка Имя ссылки на категорию, назначенное невыполненной работе, связанной с типом рабочего элемента. Примеры: Microsoft.EpicCategory, Microsoft.FeatureCategory, Microsoft.RequirementCategoryMicrosoft.TaskCategory.
Имя невыполненной работы BacklogName Логический Имя ссылки, назначенное невыполненной работе, связанной с типом рабочего элемента
Тип невыполненной работы BacklogType GUID Уникальный идентификатор, назначенный пути итерации при его создании.
Уровень невыполненной работы BacklogLevel Строка Указывает уровень невыполненной работы, связанный с типом рабочего элемента. Если тип рабочего элемента не связан с уровнем невыполненной работы, возвращается nullзначение.
Тип рабочего элемента WorkItemType Строка Имя, определенное для типа рабочего элемента.
Имеет невыполненную работу HasBacklog Строка Указывает, принадлежит ли тип рабочего элемента к невыполненной работе.
Скрытый тип IsHiddenType Логический Указывает, отключен ли тип рабочего элемента.
Тип ошибки IsBugType Логический Указывает, принадлежит ли тип рабочего элемента категории "Ошибка".
Удаляется IsDeleted Логический Указывает, был ли удален тип рабочего элемента.

Дополнительные сведения о невыполненных процессах и типах рабочих элементов см. в следующих статьях:

Пользовательские типы рабочих элементов и пользовательские категории невыполненной работы

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

Пользовательская категория создается при определении типа пользовательского рабочего элемента и уровня невыполненной работы. Custom_ добавляется в GUID категории. Например, для типа пользовательского рабочего элемента портфеля с невыполненной работой портфелей GUID назначается пользовательской категории, напримерCustom.49b81c4e-9c4f-4c04-94fd-d660cbf3a000.

Теги

Следующие свойства допустимы для набора сущностей Tags . Суррогатные ключи, связанные с тегом , включают TagSK и ProjectSK. Свойства навигации включают Project и его ссылочное ограничение ProjectSK. Дополнительные сведения об использовании тегов см. в статье "Добавление тегов рабочего элемента для классификации и фильтрации списков и досок".

Эти свойства можно использовать для фильтрации или отчета по данным отслеживания работы.

Отображаемое имя Имя Тип данных Description
Идентификатор тега TagId GUID Уникальный идентификатор, назначенный тегу при его создании.
Имя тега TagName Строка Имя тега.

Команды

Следующие свойства допустимы для типа сущности Team и набора сущностей Teams . Суррогатные ключи, связанные с командой , включают TeamSK и ProjectSK. Эти свойства можно использовать для фильтрации или отчета о данных отслеживания работы на основе назначений команд. Сведения об использовании и добавлении команд см. в разделе "О командах" и "Гибкие средства " и "Создание или добавление команды".

Отображаемое имя Имя Тип данных Description
AnalyticsUpdatedDate Дата/время Подложка, указывающая время последнего обновления данных Аналитики.
Идентификатор команды TeamId GUID Уникальный идентификатор, назначенный команде при его создании.
Имя команды TeamName Строка Имя команды.

Свойства навигации для набора сущностей Teams включают Projectsи AreasIterations.

Следующие свойства допустимы для набора сущностей WorkItemLinks . Ссылочный суррогатный ключ свойства имеет значение WorkItemLinkSK. Запрос WorkItemLinks для отчета о родительском или дочернем, связанном, предшественнике или преемнике или других типах ссылок.

Отображаемое имя Имя Тип данных Description
AnalyticsUpdatedDate Дата/время Подложка, указывающая время последнего обновления данных Аналитики.
WorkItemLinkSK Int32 Суррогатный ключ, назначенный сущности WorkItemLink .
Дата создания CreatedDate GUID Дата создания ссылки.
Комментарий Comment Строка Комментарий, добавленный при создании ссылки.
Дата удаления DeletedDate Строка Дата удаления ссылки.
Идентификатор типа ссылки LinkTypeId Int32 Идентификатор, назначенный целевому рабочему элементу, связанному с ним.
Имя типа ссылки LinkTypeName Строка Понятное имя, назначенное типу ссылки.
Имя ссылочного типа LinkTypeReferenceName Строка Имя ссылки, назначенное типу ссылки.
Тип ссылки является ациклическим LinkTypeIsAcyclic Логический Значение атрибута типа ссылки, указывающее тип ссылки, разрешает циклические связи, если для значения задано значение True. Например, ссылки типа дерева ограничивают циклические связи.
Тип ссылки — направление LinkTypeIsDirectional Логический Значение атрибута типа ссылки, указывающее, что тип ссылки является направленным. Типы связей направления определяются в парах с компонентом пересылки и обратного.
Идентификатор исходного рабочего элемента SourceWorkItemId Int32 Идентификатор, назначенный исходному рабочему элементу, связанному с ним.
Идентификатор целевого рабочего элемента TargetWorkItemId Int32 Идентификатор, назначенный целевому рабочему элементу, связанному с ним.

Свойства навигации для типа сущности WorkItemLink включают Projectsи SourceWorkItemTargetWorkItem.

Дополнительные сведения о ссылках и типах ссылок см. в следующих статьях:

WorkItemTypeFields

Следующие свойства допустимы для набора сущностей WorkItemTypeFields . Ключи ссылки на свойства: FieldNameи ProjectSKWorkItemType.

Отображаемое имя Имя Тип данных Description
Имя поля FieldName Строка Понятное имя, назначенное полю системой или при его создании.
Имя ссылки на поле FieldReferenceName Строка Имя ссылки, назначенное системе или при создании настраиваемого поля.
Тип поля FieldType Строка Тип данных, назначенный полю.
Тип рабочего элемента WorkItemType Строка Имя типов рабочих элементов, для которым определено поле.

К свойствам навигации относятся Project.

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

Пользовательские свойства

Настраиваемые поля автоматически добавляются в службу Аналитики в качестве настраиваемого свойства. Custom_ или Custom. добавляется к имени свойства. Проверьте метаданные коллекции, как описано в запросах OData конструктора для аналитики, компонентов URL-адресов для запроса метаданных. В следующем примере приведен синтаксис метаданных для настраиваемого поля Risk Opportunity.

<Property Name="Custom_RiskOpportunity" Type="Edm.Double">
<Annotation Term="Display.DisplayName" String="Risk Opportunity"/>
<Annotation Term="Ref.ReferenceName" String="Custom.RiskOpportunity"/>
<Annotation Term="Display.Description" String="Risk Reduction | Opportunity Enablement Value. Enter a value from 1 to 5. 5 represents high risk reduction or high opportunity enablement."/>
</Property>