Вывод списка полей и атрибутов рабочих элементов

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

Поля рабочих элементов используются для отслеживания сведений в Azure DevOps. Эти поля определяются на уровне организации и используются для всех проектов в организации. Чтобы просмотреть поля, определенные для вашей организации, можно использовать один из следующих двух средств, доступных для моделей процессов Наследуемого и размещенного XML:

• Веб-страница "Поля обработки > "
• Обозреватель полей рабочих элементов

Описание каждого поля, определенного системным процессом, см. в разделе "Индекс поля рабочего элемента".

Необходимые компоненты

Разрешения. Чтобы просмотреть поля, определенные для организации или коллекции, следует быть членом группы приложений "Допустимые пользователи коллекции проектов" или иметь разрешение на просмотр сведений на уровне экземпляра для разрешения для организации или коллекции.

Список или просмотр полей

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

Средство	Наследование	Размещенный XML	Локальный XML-процесс
Веб-портал: список наследуемых и настраиваемых полей	✔️	✔️1
Обозреватель полей рабочих элементов	✔️	✔️	✔️
средство командной строки witadmin listfields	✔️	✔️	✔️

Примечание.

1. Поддерживается только для процессов по умолчанию (Agile, CMMI, Scrum).

Типы и имена данных поля

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

Поля определяются следующими тремя атрибутами:

• Тип данных: указывает тип данных, которые можно ввести в поле, например Boolean, Double, Integer, HTML или String. Подробные описания каждого типа данных см. в полях запросов, операторах и макросах.
• Понятное имя: понятное имя, назначенное полю, используемое при выборе поля в предложении запроса. Это имя может отличаться от имени, отображаемого в форме рабочего элемента.
• Имя ссылки: идентификатор, используемый при создании запросов WIQL, импровизированных шаблонов рабочих элементов, выполнения команд REST API или определения определений типов рабочих элементов XML. Имя ссылки является постоянным и не может быть изменено после установки.

Подробное описание каждого атрибута поля и инструкций по их перечислению см. в разделе "Атрибуты поля" и "Список" далее в этой статье. Общие сведения о типах рабочих элементов (WIT) и рабочих элементах см. в статье "Отслеживание работы с пользовательскими историями,проблемами, ошибками, функциями и эпичными представлениями".

Что такое поле? Как используются имена полей?

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

Каждое поле записывает определенные сведения о выполняемой работе. Значения, назначенные этим полям, хранятся в хранилище данных отслеживания работы, что позволяет создавать запросы, определяющие состояние и тенденции.

Описание и использование каждого поля, определенного для основных системных процессов ( Agile, Basic, Scrum и CMMI), см. в индексе поля рабочего элемента.

Имена полей

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

• Уникальность: имена полей должны быть уникальными в пределах учетной записи или коллекции проектов.
• Длина: имена полей должны содержать 128 символов Юникода или меньше.
• Интервал: имена полей не могут содержать начальные или конечные пробелы или содержать два или более последовательных пробелов.
• Композиция: имена полей должны содержать по крайней мере один алфавитный знак.
• Запрещенные символы: имена полей не могут содержать следующие символы: .,;':~/*|?" &%$!+=()[]{}<>'

Так как настраиваемые поля определены на уровне организации или коллекции, вы не можете добавить настраиваемое поле с одинаковым именем в несколько процессов.

Дополнительные сведения см. в разделе об ограничениях именования и соглашениях.

Системные и предопределенные поля

Имя поля рабочего элемента однозначно идентифицирует каждое поле в Azure DevOps. Убедитесь, что имена полей соответствуют следующим рекомендациям:

• Уникальность: имена полей должны быть уникальными в пределах учетной записи или коллекции проектов.
• Длина: имена полей должны быть 128 символами Юникода или меньше.
• Интервал: имена полей не могут содержать начальные или конечные пробелы или содержать несколько последовательных пробелов.
• Композиция: имена полей должны содержать по крайней мере один алфавитный знак.
• Запрещенные символы: имена полей не могут содержать следующие символы: .,;':~/*|?" &%$!+=()[]{}<>'

Так как настраиваемые поля определены на уровне организации или коллекции, вы не можете добавить настраиваемое поле с одинаковым именем в несколько процессов.

Дополнительные сведения см. в разделе об ограничениях именования и соглашениях.

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

Так как настраиваемые поля определены на уровне организации или коллекции проектов, нельзя добавить настраиваемое поле с одинаковым именем в несколько процессов.

При добавлении настраиваемых полей обратите внимание на следующие ограничения:

• Максимальное количество полей на тип рабочего элемента (WIT): 64
• Максимальное количество полей для каждого процесса: 512

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

При добавлении настраиваемого поля в наследуемый процесс Azure DevOps назначает префикс ссылочного имени, за которым следует имя поля без пробелов. Например, добавление поля с именем DevOps Triage приводит к получению ссылочного имени Custom.DevOpsTriage. Пробелы не допускаются в именах ссылок.

Дополнительные сведения см. в разделе об ограничениях именования и соглашениях.

Как определить тип данных поля?

Вы можете просмотреть тип данных полей, определенных для организации, открыв страницу "Поля процесса>".

Просмотр списка полей

Чтобы просмотреть список полей, определенных для организации или коллекции, сделайте следующее:

1. Выберите логотип Azure DevOps, чтобы открыть проекты. Затем выберите параметры организации.

   

2. Выберите Обработать.

   

3. Выберите Поля.

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

   

   Примечание.

   Если вы не видите поля, то коллекция использует локальный XML-процесс. Страница "Поля" не поддерживается для этого процесса.

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

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

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

Чтобы получить доступ к обозревателе полей рабочего элемента, установите средство редактора процессов. На основе установленной версии Visual Studio получите средство редактора процессов из одного из следующих расширений.

• Visual Studio 2019 и 2022: по состоянию на данный момент нет определенного расширения редактора шаблонов процессов. Но вы по-прежнему можете настраивать шаблоны процессов с помощью других средств, таких как любой текстовый редактор или редактор XML. Вы также можете использовать веб-портал Azure DevOps для определенных настроек, особенно для унаследованных процессов.
• Visual Studio 2017: редактор шаблона процесса TFS. Вы также можете использовать эту версию редактора процессов для изменения форм старых рабочих элементов. Его нельзя использовать для редактирования форм, связанных с новыми веб-формами.
• Visual Studio 2015: TFS Power Tools.

Атрибуты поля

Для каждого поля рабочего элемента существует множество не изменяемых и скрытых атрибутов. В следующей таблице описывается каждый атрибут. Атрибуты имеют разные имена в зависимости от того, извлекаете ли их с помощью полей — получите REST API или просмотрите их с помощью средства обозревателя полей рабочих элементов (WIFE).

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

Attribute

Тип атрибута

Description

---

REST:
ЖЕНА: AllowedValues

коллекция

Возвращает коллекцию допустимых значений для поля, содержащего значения списка выбора. Это можно изменить, указав список выбора или глобальный список (локальный).
Может измениться?=Да

REST: canSortBy
ЖЕНА: CanSortBy

boolean

Указывает, можно ли сортировать результаты запроса с помощью этого поля.
Может измениться?=Нет

REST: описание
ЖЕНА: HelpText

строка

Указывает описание поля, которое также определяет текст справки, который отображается при наведении указателя мыши на поле в форме рабочего элемента.
Может измениться?=Да

REST:
ЖЕНА: ИДЕНТИФИКАТОР

Целое

Указывает внутренний идентификатор поля.
Может измениться?=Нет

REST:
ЖЕНА: IsCloneable

boolean

Указывает, копируется ли значение, определенное для поля, когда пользователь выбирает копирование рабочего элемента. Например, поля Title, Tags и Description копируются, но поля идентификатора и журнала не копируются.
Может измениться?=Нет

REST:
ЖЕНА: IsComputed

boolean

Указывает, вычисляется ли значение, заданное этим полем, системой (True) или не (False). Примеры вычисляемых полей — это те, которые задаются системой, например идентификатор, измененная дата, дата изменения и число внешних ссылок.
Может измениться?=Нет

REST:
ЖЕНА: IsCoreField

boolean

Указывает, указано ли это поле для всех типов рабочих элементов.
Может измениться?=Нет

REST:
ЖЕНА: IsEditable

boolean

Указывает, могут ли пользователи изменить это поле (True) или нет (False). Примеры необработаемых полей — это поля, заданные системой, такие как идентификатор, редакция, созданные и измененные поля
Может измениться?=Нет

REST: isIdentity
ЖЕНА: IsIdentity

boolean

Указывает, является ли это поле полем identity . Поля удостоверений — это строковые поля, используемые для хранения удостоверений пользователей.
Может измениться?=Нет

REST:
ЖЕНА: IsIndexed¹

boolean

Указывает, индексируется ли это поле для поддержки поиска.
Может измениться?=Нет

REST:
ЖЕНА: IsLongText

boolean

Указывает, что поле может содержать более 255 символов, таких как поля, назначенные типу данных PlainText, HTML или History.
Может измениться?=Нет

REST: isPicklist² ЖЕНА:

Логический

Указывает, связано ли поле с списком выбора. Значение имеет значение True , если настраиваемое поле определено для Типа Azure DevOps и Picklist (String) или Picklist (Integer). Значение имеет значение False для унаследованных полей, определяющих списки выбора.
Может измениться?=Нет

REST: isPicklistSuggested² ЖЕНА:

Логический

Указывает, позволяет ли поле пользователям вводить собственные значения для списка выбора. Значение имеет значение True , если настраиваемое поле определено для Azure DevOps, picklist (String) или Picklist (Integer), а флажок разрешить пользователям задавать собственные значения .
Может измениться?=Да

REST: isQueryable
ЖЕНА: IsQueryable

boolean

Указывает, отображается ли поле в наборе полей, которое можно добавить для фильтрации запроса рабочего элемента (True) или нет (False). Большинство полей можно запрашивать.
Может измениться?=Нет

REST:
ЖЕНА: IsReportable ³

boolean

Указывает, определен ли атрибут, доступный для отчета, или имеет значение, отличное от None. Этот атрибут можно изменить для локальных сред.
Может измениться?=Да

REST:
ЖЕНА: IsUsedInGlobalWorkflow

boolean

Указывает, определено ли поле в глобальном рабочем процессе.
Может измениться?=Нет

REST:
ЖЕНА: IsUserNameField

boolean

Указывает, используется ли поле для отображения поля identity.
Может измениться?=Нет

REST: имя
ЖЕНА: Имя

строка

Понятное имя, назначенное полю. Понятное имя нельзя изменить для Azure DevOps, но его можно изменить для локальной среды с помощью команды witadmin changefield .
Может ли измениться?=Только локальная среда

REST: picklistId
ЖЕНА: HelpText

GUID

Если поле является списком выбора, идентификатор связанного списка выбора, в противном случае — значение NULL. Уникальное значение GUID назначается при выборе настраиваемого поля для типа Azure DevOps и Picklist (String) или Picklist (Integer).
Может измениться?=Нет

REST:
ЖЕНА: Запрещенные значения

коллекция

Возвращает коллекцию запрещенных значений для поля, указывающего такие значения. Вы можете определить только запрещенные значения для локальных развертываний.
Может ли измениться?=Только локальная среда

REST: readOnly
ЖЕНА:

Логический

Указывает, задано ли поле только для чтения. Для Azure DevOps Services можно изменить только настраиваемые поля, которые будут доступны только для чтения. Не удается изменить системные поля.
Может измениться?=Да

REST: referenceName
ЖЕНА: ReferenceName

строка

Указывает имя ссылки поля.
Может измениться?=Нет

REST:
ЖЕНА: ReportingAttributes³

Указывает сведения, измерение или меру в зависимости от того, следует ли включать поле в отчеты. Данные из полей, которые имеют значение, отличное от None для этого атрибута, экспортируются в хранилище данных и могут быть включены в отчеты SQL.
Может ли измениться?=Только локальная среда

REST:
ЖЕНА: ReportingName³

строка

Указывает метку поля при отображении данных в отчетах SQL. Если значение не указано, используется понятное имя поля.
Может ли измениться?=Только локальная среда

REST:
ЖЕНА: ReportingReferenceName³

строка

Указывает другое имя ссылки на поле, которое используется при экспорте данных в реляционное хранилище данных. Если значение не указано, используется имя ссылки на поля.
Может ли измениться?=Только локальная среда

REST: supportedOperations
ЖЕНА:

set

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

REST:
ЖЕНА: SupportsTextQuery

boolean

Указывает, поддерживает ли поле текстовые запросы, такие как слова, не содержит слова.
Может измениться?=Нет

REST:
ЖЕНА: SystemType

строка

Указывает тип данных поля, ссылающийся на имя системы, например System.DateTime или System.String.
Может измениться?=Нет

REST: тип
ЖЕНА: FieldType

строка

Указывает тип данных поля, например boolean, DateTime, Integer, String и т. д. Полный список и описания см. в полях запросов, операторах и макросах.
Может измениться?=Нет

REST: использование
ЖЕНА: Использование

строка

Указывает, предназначено ли поле для использования с рабочими элементами (WorkItem) или объектами ссылки на рабочие элементы (WorkItemLink). Использование большинства полей — WorkItem. Полный список значений использования см. в разделе Get Fields, FieldUsage.
Может измениться?=Нет

Примечание.

1. Для локальных развертываний можно включить индексирование поля для улучшения времени отклика запросов при фильтрации в поле. Дополнительные сведения см. в разделе "Индексированные поля " далее в этой статье.
2. Атрибуты isPicklist и isPicklistSuggested назначаются только настраиваемым полям, определенным для унаследованного процесса. Модель наследуемого процесса поддерживается для Azure DevOps Server 2019 и более поздних версий. Дополнительные сведения см. в разделе "Наследуемая модель процесса".
3. Все атрибуты отчетов допустимы только для локальных развертываний, проекты которых настроены для поддержки sql Server Reporting и SQL Server Analysis Services.

Перечисление атрибутов поля

Вы можете перечислить атрибуты, назначенные полю, с помощью поля — получить REST API. Замените OrganizationName фактическим именем организации.

https://dev.azure.com/OrganizationName/_apis/wit/fields/FieldReferenceName

Например, чтобы вывести список атрибутов для пути итерации, используйте имя System.IterationPath ссылки для fabrikam организации:

https://dev.azure.com/fabrikam/_apis/wit/fields/System.IterationPath

**Returned data:**

> [!div class="tabbedCodeSnippets"]
> ```JSON
> {
> "name": "Iteration Path",
> "referenceName": "System.IterationPath",
> "description": "The iteration within which this bug will be fixed",
> "type": "treePath",
> "usage": "workItem",
> "readOnly": false,
> "canSortBy": true,
> "isQueryable": true,
> "supportedOperations": [
> {
> "referenceName": "SupportedOperations.Under",
> "name": "Under"
> },
> {
> "referenceName": "SupportedOperations.NotUnder",
> "name": "Not Under"
> },
> {
> "referenceName": "SupportedOperations.Equals",
> "name": "="
> },
> {
> "referenceName": "SupportedOperations.NotEquals",
> "name": "<>"
> },
> {
> "referenceName": "SupportedOperations.In",
> "name": "In"
> },
> {
> "name": "Not In"
> }
> ],
> "isIdentity": false,
> "isPicklist": false,
> "isPicklistSuggested": false,
> "url": "https://dev.azure.com/mseng/_apis/wit/fields/System.IterationPath"
> }
> ```

Добавление и изменение полей

Чтобы добавить поля в процесс, добавьте их в один или несколько типов рабочих элементов. Дополнительные сведения см. в разделе "Настройка процесса наследования".

Связанные статьи

• Ознакомьтесь с кратким справочником по запросу, чтобы быстро понять синтаксис и использование запросов.
• Изучите индекс поля рабочего элемента, чтобы просмотреть все доступные поля рабочего элемента.
• Добавьте поля для наследуемого процесса и управляйте ими, чтобы настроить поля в соответствии с требованиями к унаследованным процессам.
• Перейдите к справочнику по метаданным для Аналитики Azure Boards, чтобы понять возможности анализа метаданных и отчетов.