Azure DevOps

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

Этот соединитель доступен в следующих продуктах и регионах:

Услуга Class Регионы
Copilot Studio Премия Все регионы Power Automate за исключением следующих:
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Логические приложения Стандарт Все регионы Logic Apps , кроме следующих:
     - Azure регионы Китая
     - Министерство обороны США (DoD)
Power Apps Премия Все регионы Power Apps кроме следующих:
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Power Automate Премия Все регионы Power Automate за исключением следующих:
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Контакт
Имя Microsoft
URL https://azure.microsoft.com/en-us/support/?icid=devops
Метаданные соединителя
Publisher Microsoft
Веб-сайт https://learn.microsoft.com/en-us/azure/devops/?view=azure-devops
Политика конфиденциальности https://privacy.microsoft.com
Категории ИТ-операции

Чтобы использовать эту интеграцию, вам потребуется доступ к учетной записи Azure DevOps с включенным доступом к API. Чтобы сделать подключение, нажмите кнопку "Войти". Затем вам будет предложено указать учетную запись служб Azure DevOps. Следуйте остальным экранам, чтобы создать подключение.

При использовании подключения, если вы не видите список проектов, которые вы ожидаете, проверьте учетную запись, с помощью которую вы создали подключение и повторите попытку. Дополнительные сведения см. в Visual Studio Marketplace.

Теперь вы готовы начать использовать эту интеграцию.

Отправка вложений

Вы можете создавать вложения файлов с помощью действия Send HTTP-запрос на Azure DevOps, а затем выполните следующие действия:

  1. Преобразуйте содержимое файла в строку Base64 и поместите его в параметр Body.
  2. Задайте для параметра Body is Base64 значение "Да".

Создание планов тестирования

Перед созданием тестового плана с помощью действия создания рабочего элемента необходимо сначала создать набор test Suite. Вы можете использовать то же действие "Создать рабочий элемент" для создания наборов тестов, а затем создать план тестирования со ссылкой на набор Test Suite.

Самый простой вариант — вызвать Test Plans — создать API напрямую с помощью Send http-запрос на действие Azure DevOps. API автоматически создает связанный набор тестов.

Параметр "Другие поля"

Создайте рабочий элемент и обновите действия рабочего элемента с поддержкой Other Fields параметра. Эти поля обеспечивают дополнительную гибкость при обновлении рабочих элементов. Пары "ключ-значение" преобразуются в следующий код JSON:

{
  "op": "add",
  "path": "/fields/<key>",
  "value": <value>
}

Обратите внимание, что это константа иop, как ожидается, <key> будет допустимым именем поля в перечислении DevOps/fields.

Ниже приведены несколько примеров использования. Дополнительные примеры см. в разделе "Рабочие элементы" — обновление REST API.

  1. Обновление key журнала = System.History value = Переход на правильный путь к области'
  2. Перемещение рабочих элементов: key = System.TeamProject value = Fabrikam-Scrum

Известные проблемы и ограничения

В следующем списке приведены известные ограничения использования соединителя Azure DevOps.

  1. Триггер при обновлении рабочего элемента будет пропущен при добавлении или удалении новых ссылок на рабочий элемент.

  2. Сведения о рабочем элементе действия Get и триггеры на основе рабочих элементов могут пропускать некоторые поля (например, System.AttachFileCount) в ответе, так как это ограничение Azure DevOps REST API. Чтобы устранить эту проблему, можно выполнить одно из следующих действий:

  3. Действие Send HTTP-запрос на Azure DevOps имеет ограниченный набор областей, которые управляют доступом к ресурсам, к которым можно обращаться с помощью действия, и какие операции, которые разрешено выполнять с этими ресурсами.

    Области:

    • vso.agentpools_manage
    • vso.build_execute
    • vso.chat_manage
    • vso.code_manage
    • vso.code_status
    • vso.connected_server
    • vso.доски_управление
    • vso.entitlements
    • vso.extension.data_write
    • управление_расширением_vso
    • vso.identity
    • vso.loadtest_write
    • vso.packaging_manage
    • vso.управление_проектами
    • vso.управление_выпуском
    • vso.тестовая_запись
    • vso.work_write
  4. соединитель Azure DevOps предназначен только для работы от имени текущих учетных данных пользователя. Невозможно изменить подключение или переключиться между учетными записями.

  5. Обратите внимание, что изменения паролей в учетной записи Azure DevOps не влияют на существующее подключение.

  6. Azure DevOps личные маркеры доступа не поддерживаются для проверки подлинности с помощью соединителя.

  7. Действие "Создание рабочего элемента" имеет ограничение для параметра Repro Steps. Изображение размером более 30 КБ может отображаться неправильно в созданном элементе. Изображение размером более 500 КБ можно удалить из запроса. Рекомендуемый размер изображения должен быть меньше 30 КБ.

  8. Действие "Создание рабочего элемента " очень редко может возвращать код ответа 404. Чаще всего это происходит по следующей причине: сразу после создания элемента запрашиваются все его поля. Запрос можно отправить в скопированную базу данных. Изменения синхронизированы почти в режиме реального времени, но иногда это занимает несколько секунд. Из-за этого запрос GET может возвращать пустой результат, который представляет собой код состояния 404 в ответе. Чтобы избежать этого исключения, можно использовать флаг "Вернуть все поля" и задать для него значение "Нет".

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

Замечание

В действии "Создание рабочего элемента"

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:

Проверка подлинности сертификата клиента Предоставление учетных данных Microsoft Entra ID с помощью сертификата И пароля PFX Все регионы Доступный для общего пользования
Log in with Azure DevOps Credentials Вход с помощью учетных данных Azure DevOps только Azure для государственных организаций и правительство США (GCC) Недоступен для совместного использования
Log в Microsoft Entra ID Вход с помощью Microsoft Entra ID Только ДЛЯ РАБОЧЕЙ СРЕДЫ Недоступен для совместного использования
Аутентификация сервисного принципала Использование приложения Microsoft Entra ID для проверки подлинности субъекта-службы Все регионы Доступный для общего пользования
По умолчанию [не рекомендуется] Этот параметр предназначен только для старых подключений без явного типа проверки подлинности и предоставляется только для обратной совместимости. Все регионы Недоступен для совместного использования

Проверка подлинности сертификата клиента

Идентификатор проверки подлинности: CertOauth

Применимо: все регионы

Предоставление учетных данных Microsoft Entra ID с помощью сертификата И пароля PFX

Это совместное подключение. Если приложение power app предоставлено другому пользователю, подключение также предоставляется совместно. Дополнительные сведения см. в обзоре Connectors для приложений холста — Power Apps | Документация Майкрософт

Имя Тип Description Обязательно
Tenant струна True
Идентификатор клиента струна Идентификатор клиента для приложения Microsoft Entra ID True
Секрет сертификата клиента клиентский сертификат Секрет сертификата клиента, разрешенный этим приложением True

Вход с помощью учетных данных Azure DevOps

Идентификатор проверки подлинности: ADO3pAuthForGCC

Применимо: только Azure для государственных организаций и правительство США (GCC)

Вход с помощью учетных данных Azure DevOps

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Вход с помощью Microsoft Entra ID

Идентификатор проверки подлинности: EntraOAuth

Применимо: только для рабочей среды

Вход с помощью Microsoft Entra ID

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Аутентификация сервисного принципала

Идентификатор проверки подлинности: OauthSP

Применимо: все регионы

Использование приложения Microsoft Entra ID для проверки подлинности субъекта-службы

Это совместное подключение. Если приложение power app предоставлено другому пользователю, подключение также предоставляется совместно. Дополнительные сведения см. в обзоре Connectors для приложений холста — Power Apps | Документация Майкрософт

Имя Тип Description Обязательно
Tenant струна True
Идентификатор клиента струна Идентификатор клиента для приложения Microsoft Entra ID True
Секрет клиента securestring True

По умолчанию [не рекомендуется]

Применимо: все регионы

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

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Ограничения регулирования

Имя Вызовы Период обновления
Вызовы API для каждого подключения 300 60 секунд

Действия

Вывод списка ветвей Git (предварительная версия)

Извлекает список ветвей Git, доступных в репозиториях проекта.

Вывод списка запросов в папке

Извлекает список запросов рабочих элементов в папке для данного проекта.

Вывод списка запросов корневого уровня

Извлекает список запросов рабочих элементов корневого уровня в проекте.

Вывод списка запусков конвейера

Возвращает первые 10000 запусков для определенного конвейера

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

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

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

Извлекает список типов рабочих элементов, доступных в данном проекте Azure DevOps.

Добавление ссылки на рабочий элемент (предварительная версия)

Добавляет ссылку на рабочий элемент.

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

Обновите существующий рабочий элемент по идентификатору.

Обновление комментария к рабочему элементу (предварительная версия)

Обновляет комментарий к рабочему элементу.

Отправка HTTP-запроса в Azure DevOps

Создайте запрос REST API Azure DevOps для вызова. См. следующую ссылку для всех доступных конечных точек: https://docs.microsoft.com/rest/api/azure/devops

Очередь новой сборки

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

Перечисление определений выпуска

Извлекает список определений выпуска, связанных с проектом.

Перечисление организаций

Извлекает список организаций, в которые пользователь входит.

Перечисление сборок (предварительная версия)

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

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

Предоставляет набор результатов для текста поиска.

Получение вложения рабочего элемента (предварительная версия)

Загружает содержимое вложения рабочего элемента.

Получение временной шкалы сборки (предварительная версия)

Извлекает временную шкалу для определенной сборки.

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

Получение списка дочерних элементов (максимальный размер 1000) одного рабочего элемента.

Получение комментариев рабочих элементов (предварительная версия)

Извлекает комментарии для рабочего элемента.

Получение профиля пользователя

Получает профиль пользователя.

Получение результатов запроса

Извлекает результат запроса рабочего элемента.

Получение результатов запроса [DEPRECATED]

Это действие устарело. Вместо этого используйте результаты запроса.

Извлекает результат запроса рабочего элемента.

Получение сборки (предварительная версия)

Извлекает сборку по идентификатору.

Получение сведений о рабочем элементе

Получение сведений об одном рабочем элементе.

Получение сведений о рабочем элементе (версия 2) (предварительная версия)

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

Создание комментария к рабочему элементу (предварительная версия)

Добавляет комментарий к рабочему элементу.

Создание нового выпуска

Создайте выпуск на основе существующего определения выпуска.

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

Создайте новый рабочий элемент с предоставленными атрибутами.

Список запрашивающих сборок (предварительная версия)

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

Список итераций

Извлекает список итерации для проекта.

Список конвейеров

Извлекает список конвейеров в проекте.

Список проектов

Извлекает список проектов в организации.

Список рабочих элементов

Возвращает список рабочих элементов.

Список репозиториев Git

Извлекает список репозиториев Git в проекте.

Удаление комментария к рабочему элементу (предварительная версия)

Удалите комментарий для рабочего элемента.

Удаление ссылки на рабочий элемент (предварительная версия)

Удаляет ссылку из рабочего элемента.

Вывод списка ветвей Git (предварительная версия)

Извлекает список ветвей Git, доступных в репозиториях проекта.

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project True string

Имя проекта в указанной организации.

Возвращаемое значение

Список моделей VSTS.

Тело
VstsList[GitRef]

Вывод списка запросов в папке

Извлекает список запросов рабочих элементов в папке для данного проекта.

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project True string

Имя проекта в указанной организации.

Путь к папке
folderPath True string

Путь к папке, в которой следует искать запросы.

Возвращаемое значение

Список моделей VSTS.

Вывод списка запросов корневого уровня

Извлекает список запросов рабочих элементов корневого уровня в проекте.

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project True string

Имя проекта в указанной организации.

Возвращаемое значение

Список моделей VSTS.

Вывод списка запусков конвейера

Возвращает первые 10000 запусков для определенного конвейера

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project True string

Имя проекта в указанной организации.

Идентификатор конвейера
pipelineId True integer

Идентификатор конвейера

Возвращаемое значение

Тело
Run

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

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

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project string

Необязательный проект в организации для области списка полей.

Параметры развертывания
expand string

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

Возвращаемое значение

Список моделей VSTS.

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

Извлекает список типов рабочих элементов, доступных в данном проекте Azure DevOps.

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project True string

Имя проекта в указанной организации.

Возвращаемое значение

Список моделей VSTS.

Добавление ссылки на рабочий элемент (предварительная версия)

Добавляет ссылку на рабочий элемент.

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project True string

Project идентификатор или имя project

Тип рабочего элемента
type True string

Тип рабочего элемента рабочего элемента.

Идентификатор рабочего элемента
workItemId True integer

Идентификатор рабочего элемента.

Тип ссылки
linkType True string

Тип отношения для ссылки. По умолчанию значение System.LinkTypes.Related не указано.

Целевой URL-адрес
targetUrl True string

Абсолютный URL-адрес целевого объекта ссылки. Должен быть абсолютным универсальным кодом ресурса (URI) и соответствовать ожиданиям выбранного типа ссылки.

Комментарий
comment string

Необязательный комментарий, хранящийся вместе со ссылкой.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

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

Обновите существующий рабочий элемент по идентификатору.

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

Идентификатор рабочего элемента
id True string

Уникальный идентификатор рабочего элемента для обновления.

имя Project
project string

Имя проекта в указанной организации.

Тип рабочего элемента
type string

Тип рабочего элемента для создания схемы.

Сведения о рабочем элементе
workItem True dynamic

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

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Обновление комментария к рабочему элементу (предварительная версия)

Обновляет комментарий к рабочему элементу.

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project True string

Project идентификатор или имя project

Идентификатор рабочего элемента
workItemId True integer

Идентификатор рабочего элемента.

Идентификатор комментария
commentId True integer

Идентификатор комментария для обновления.

Формат комментариев
format string

Формат комментария рабочего элемента (Markdown или Html).

Текст примечания
text True string

Текст комментария.

Возвращаемое значение

Комментарий рабочего элемента

Тело
WorkItemComment

Отправка HTTP-запроса в Azure DevOps

Создайте запрос REST API Azure DevOps для вызова. См. следующую ссылку для всех доступных конечных точек: https://docs.microsoft.com/rest/api/azure/devops

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

Метод
Method True string

Метод HTTP.

Относительный универсальный код ресурса (URI)
Uri True string

Относительный универсальный код ресурса (URI). Пример: {project}/{team}/_apis/wit/templates?api-version=5.0-preview.1.

Headers
Headers object

Заголовки запроса.

Тело
Body string

Содержимое запроса. Может быть объектом JSON или двоичными данными, закодированными как строка Base64.

Основной текст — Base64
IsBase64 boolean

Значение true, если содержимое запроса закодировано как строка Base64.

Возвращаемое значение

Очередь новой сборки

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

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project True string

Имя проекта в указанной организации.

Идентификатор определения сборки
buildDefId True string

Идентификатор используемого определения сборки.

Исходная ветвь
sourceBranch string

Исходная ветвь сборки.

Параметры
parameters string

Словарь JSON необязательных параметров сборки.

Возвращаемое значение

Результат сборки

Тело
BuildResult

Перечисление определений выпуска

Извлекает список определений выпуска, связанных с проектом.

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project True string

Имя проекта в указанной организации.

Возвращаемое значение

Список моделей VSTS.

Перечисление организаций

Извлекает список организаций, в которые пользователь входит.

Возвращаемое значение

Список моделей VSTS.

Перечисление сборок (предварительная версия)

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

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project True string

Имя проекта в указанной организации.

Фильтрация по идентификаторам определения
definitions string

Разделенный запятыми список идентификаторов определений, которые необходимо включить.

Фильтрация по номеру сборки
buildNumber string

Фильтрация по номеру сборки.

Фильтрация по ветви
branchName string

Фильтрация по имени ветви (например, refs/heads/main).

Фильтрация по результату
resultFilter string

Фильтрация по результату сборки.

Фильтрация по состоянию
statusFilter string

Фильтрация по состоянию сборки.

Фильтрация по причине
reasonFilter string

Фильтрация по причине сборки.

Фильтр по запросу
requestedFor string

Фильтруйте по идентификатору, для которого была запрошена сборка.

Минимальное время окончания
minTime date-time

Фильтрация по минимальному времени окончания (включительно).

Максимальное время окончания
maxTime date-time

Фильтрация по максимальному времени окончания (включительно).

Максимальные результаты
$top integer

Максимальное количество возвращаемых сборок.

Возвращаемое значение

Список моделей VSTS.

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

Предоставляет набор результатов для текста поиска.

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project True string

Имя проекта в указанной организации.

Поиск текста
searchText True string

Текст для поиска.

Пропустить
$skip integer

Количество пропущенных результатов. Значение по умолчанию — 0.

Верх
$top integer

Количество возвращаемых результатов. Значение по умолчанию — 100.

Фильтры
filters object

Примененные фильтры. Задайте для него значение NULL, если не применяются фильтры.

Включение аспектов
includeFacets boolean

Флаг, чтобы выбрать аспект в результате. Поведение по умолчанию — false.

Поле
field string

Имя поля, для которого необходимо выполнить сортировку.

Порядок сортировки
sortOrder string

Порядок (ASC/DESC), в котором должны быть отсортированы результаты.

Возвращаемое значение

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

Получение вложения рабочего элемента (предварительная версия)

Загружает содержимое вложения рабочего элемента.

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

Идентификатор вложения
attachmentId True string

Уникальный идентификатор скачиваемого вложения.

имя Project
project string

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

Имя файла
fileName string

Необязательное указание имени файла, переданное Azure DevOps при скачивании вложения.

Возвращаемое значение

Получение временной шкалы сборки (предварительная версия)

Извлекает временную шкалу для определенной сборки.

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project True string

Имя проекта в указанной организации.

Идентификатор сборки
buildId True integer

Идентификатор сборки для получения временной шкалы.

Идентификатор временной шкалы
timelineId string

Необязательный идентификатор временной шкалы при наличии нескольких временных шкал.

Изменение идентификатора
changeId integer

Необязательный идентификатор изменения для получения определенного изменения временной шкалы.

Идентификатор плана
planId string

Необязательный идентификатор плана для временной шкалы.

Возвращаемое значение

Временная шкала сборки

Тело
Timeline

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

Получение списка дочерних элементов (максимальный размер 1000) одного рабочего элемента.

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project True string

Имя проекта в указанной организации.

Идентификатор рабочего элемента
id True string

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

Тип дочерних рабочих элементов
workItemType string

Тип дочерних рабочих элементов

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение комментариев рабочих элементов (предварительная версия)

Извлекает комментарии для рабочего элемента.

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project True string

Имя проекта в указанной организации.

Идентификатор рабочего элемента
workItemId True integer

Уникальный идентификатор рабочего элемента для получения комментариев.

Максимальное количество примечаний для возврата
$top integer

Максимальное количество возвращаемых комментариев.

Порядок сортировки комментариев
order string

Порядок сортировки комментариев. По умолчанию используется значение desc.

Включение удаленных комментариев
includeDeleted boolean

Следует ли включать примечания, которые были обратимо удалены.

Параметры развертывания
$expand string

Определяет, какие дополнительные данные комментариев должны быть возвращены.

Возвращаемое значение

Представляет ответ, содержащий комментарии рабочего элемента.

Получение профиля пользователя

Получает профиль пользователя.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор профиля
id True string

Идентификатор профиля в той же организации или "я", чтобы получить профиль текущего пользователя, прошедшего проверку подлинности.

Возвращаемое значение

Profile

Тело
Profile

Получение результатов запроса

Извлекает результат запроса рабочего элемента.

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project True string

Имя проекта в указанной организации.

Идентификатор запроса
queryId True string

Идентификатор хранимого запроса для выполнения.

Количество возвращаемых рабочих элементов
workItemsCount integer

Максимальное количество рабочих элементов для получения (1 – 20000)

Сбой при изменении результатов запроса
throwIfQueryChanged boolean

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

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение результатов запроса [DEPRECATED]

Это действие устарело. Вместо этого используйте результаты запроса.

Извлекает результат запроса рабочего элемента.

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project True string

Имя проекта в указанной организации.

Идентификатор запроса
queryId True string

Идентификатор хранимого запроса для выполнения.

Возвращаемое значение

Список моделей VSTS.

Получение сборки (предварительная версия)

Извлекает сборку по идентификатору.

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project True string

Имя проекта в указанной организации.

Идентификатор сборки
buildId True integer

Идентификатор извлекаемой сборки.

Возвращаемое значение

Результат сборки

Тело
BuildResult

Получение сведений о рабочем элементе

Получение сведений об одном рабочем элементе.

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project True string

Имя проекта в указанной организации.

Тип рабочего элемента
typeName True string

Тип рабочего элемента рабочего элемента.

Идентификатор рабочего элемента
id True string

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

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение сведений о рабочем элементе (версия 2) (предварительная версия)

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

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project True string

Имя проекта в указанной организации.

Тип рабочего элемента
typeName True string

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

Идентификатор рабочего элемента
id True string

Уникальный идентификатор рабочего элемента для получения сведений.

Дата
asOf date-time

Получите рабочий элемент по состоянию на эту дату и время.

Развернуть
expand string

Определяет, какие дополнительные данные включены в ответ.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Создание комментария к рабочему элементу (предварительная версия)

Добавляет комментарий к рабочему элементу.

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project True string

Project идентификатор или имя project

Тип рабочего элемента
type string

Тип рабочего элемента для создания схемы.

Идентификатор рабочего элемента
workItemId True integer

Идентификатор рабочего элемента.

Формат комментариев
format string

Формат комментария рабочего элемента (Markdown или Html).

Текст примечания
text True string

Текст комментария.

Возвращаемое значение

Комментарий рабочего элемента

Тело
WorkItemComment

Создание нового выпуска

Создайте выпуск на основе существующего определения выпуска.

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project True string

Имя проекта в указанной организации.

Идентификатор определения выпуска
releaseDefId True string

Идентификатор используемого определения выпуска.

Description
Description string

Описание метаданных запуска выпуска.

Является черновиком
IsDraft boolean

Указывает, является ли выпуск черновиком.

Причина
Reason string

Причина запуска выпуска метаданных.

Имя
Name True string

Имя переменной конфигурации.

Ценность
Value string

Значение переменной конфигурации.

Возвращаемое значение

Релиз

Тело
Release

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

Создайте новый рабочий элемент с предоставленными атрибутами.

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project True string

Имя проекта в указанной организации.

Тип рабочего элемента
type True string

Тип этого рабочего элемента

Возврат всех полей
shouldReturnAllFields boolean

При задании значения "Нет" возвращается только идентификатор рабочего элемента. Если значение равно "Да", будут возвращены все поля созданного элемента вместе с идентификатором. Значение по умолчанию — "Да"

Сведения о рабочем элементе
workItem True dynamic

Сведения для включения в новый рабочий элемент

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Список запрашивающих сборок (предварительная версия)

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

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project True string

Имя проекта в указанной организации.

Возвращаемое значение

Список моделей VSTS.

Список итераций

Извлекает список итерации для проекта.

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project True string

Имя проекта в указанной организации.

Имя группы
team True string

Имя команды в проекте.

Возвращаемое значение

Список моделей VSTS.

Список конвейеров

Извлекает список конвейеров в проекте.

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project True string

Имя проекта в указанной организации.

Возвращаемое значение

Тело
Pipeline

Список проектов

Извлекает список проектов в организации.

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

Возвращаемое значение

Список моделей VSTS.

Список рабочих элементов

Возвращает список рабочих элементов.

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project True string

Имя проекта в указанной организации.

Идентификаторы рабочих элементов
workItemIds True string

Разделенный запятыми список запрошенных идентификаторов рабочих элементов.

Тип рабочего элемента
workItemType string

Тип рабочего элемента для создания схемы.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Список репозиториев Git

Извлекает список репозиториев Git в проекте.

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project True string

Имя проекта в указанной организации.

Возвращаемое значение

Список моделей VSTS.

Удаление комментария к рабочему элементу (предварительная версия)

Удалите комментарий для рабочего элемента.

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project True string

Имя проекта в указанной организации.

Идентификатор рабочего элемента
workItemId True integer

Уникальный идентификатор рабочего элемента.

Идентификатор комментария
commentId True integer

Идентификатор удаления комментария.

Удаление ссылки на рабочий элемент (предварительная версия)

Удаляет ссылку из рабочего элемента.

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project True string

Project идентификатор или имя project

Тип рабочего элемента
type True string

Тип рабочего элемента рабочего элемента.

Идентификатор рабочего элемента
workItemId True integer

Идентификатор рабочего элемента.

Идентификатор отношения
linkId integer

Отсчитываемый от нуля идентификатор отношения (attributes.relationId) или позиция массива из ответа рабочего элемента.

Ссылка на рабочий элемент для удаления
workItemLinkToRemove uri

Абсолютный URL-адрес ссылки для удаления, если идентификатор отношения не указан.

Тип отношения связи
linkType string

Тип отношения (rel) ссылки для удаления при сопоставлении по URL-адресу.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Триггеры

После завершения сборки

Активирует поток после завершения сборки.

При закрытии запроса на вытягивание (Git)

Активирует поток при закрытии запроса на вытягивание, соответствующего предоставленным критериям.

При закрытии рабочего элемента

Активирует поток при закрытии рабочего элемента, соответствующего предоставленным критериям.

При закрытии рабочего элемента [DEPRECATED]

Это действие устарело. Используйте вместо этого рабочий элемент, если рабочий элемент закрыт .

Активирует поток при закрытии рабочего элемента, соответствующего предоставленным критериям.

При назначении рабочего элемента

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

При назначении рабочего элемента [DEPRECATED]

Это действие устарело. Используйте вместо этого рабочий элемент .

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

При обновлении рабочего элемента

Активирует поток при обновлении рабочего элемента, соответствующего заданным критериям.

При обновлении рабочего элемента [DEPRECATED]

Это действие устарело. Используйте вместо этого , когда рабочий элемент обновляется .

Активирует поток при обновлении рабочего элемента, соответствующего заданным критериям.

При отправке кода (Git)

Активирует поток при отправке кода в репозиторий Git.

При проверке кода (TFVC)

Активирует поток при входе кода в проект Управления версиями Team Foundation.

При создании запроса на вытягивание (Git)

Активирует поток при создании запроса на вытягивание, соответствующего заданным критериям.

При создании рабочего элемента

Активирует поток при создании рабочего элемента, соответствующего заданным критериям.

При создании рабочего элемента [DEPRECATED]

Это действие устарело. Используйте вместо этого рабочий элемент .

Активирует поток при создании рабочего элемента, соответствующего заданным критериям.

После завершения сборки

Активирует поток после завершения сборки.

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project True string

Имя проекта в указанной организации.

Фильтрация по результату
resultFilter string

Параметр, указывающий, какой результат сборки следует активировать. Допустимые параметры включают '', 'успешно', 'частично'succeeded', 'failed' или 'canceled'.

Фильтр по идентификатору определения
definitions string

Параметр, указывающий идентификатор определения сборки для активации.

Возвращаемое значение

Список моделей VSTS.

При закрытии запроса на вытягивание (Git)

Активирует поток при закрытии запроса на вытягивание, соответствующего предоставленным критериям.

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project True string

Имя проекта в указанной организации.

Имя репозитория
repository True string

Имя репозитория в указанном проекте.

Имя источника ссылок
sourceRefName string

Имя ссылки на Git, например ветвь или тег.

Имя целевого ссылок
targetRefName string

Имя ссылки на Git, например ветвь или тег.

Возвращаемое значение

Список моделей VSTS.

При закрытии рабочего элемента

Активирует поток при закрытии рабочего элемента, соответствующего предоставленным критериям.

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project True string

Имя проекта в указанной организации.

Имя команды (для выбора назначенного)
team string

Имя команды, из которой нужно выбрать назначаемого.

Assigned To
wiql__System_AssignedTo string

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

Тип
wiql__System_WorkItemType string

Имя типа рабочего элемента.

Закрытое состояние
closedState string

Разделенный запятыми список значений поля State, указывающий, как рабочий элемент был закрыт (готово, закрыто, завершено, неактивно).

Областной путь
wiql__System_AreaPath string

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

Сравнение пути к области
areaPathComparison string

Правило, используемое при сравнении поля "Путь к области".

Путь итерации
wiql__System_IterationPath string

Именованный спринт или период времени, в который находится рабочий элемент.

Сравнение пути итерации
iterationPathComparison string

Правило, используемое при сравнении поля пути итерации.

Priority
wiql__Microsoft_VSTS_Common_Priority string

Субъективная оценка ошибки, проблемы, задачи или тестового случая, как это относится к бизнесу.

Создано автором
wiql__System_CreatedBy string

Имя члена группы, создавшего рабочий элемент.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

При закрытии рабочего элемента [DEPRECATED]

Это действие устарело. Используйте вместо этого рабочий элемент, если рабочий элемент закрыт .

Активирует поток при закрытии рабочего элемента, соответствующего предоставленным критериям.

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project True string

Имя проекта в указанной организации.

Имя команды (для выбора назначенного)
team string

Имя команды, из которой нужно выбрать назначаемого.

Assigned To
wiql__System_AssignedTo string

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

Тип
wiql__System_WorkItemType string

Имя типа рабочего элемента.

Областной путь
wiql__System_AreaPath string

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

Сравнение пути к области
areaPathComparison string

Правило, используемое при сравнении поля "Путь к области".

Путь итерации
wiql__System_IterationPath string

Именованный спринт или период времени, в который находится рабочий элемент.

Сравнение пути итерации
iterationPathComparison string

Правило, используемое при сравнении поля пути итерации.

Priority
wiql__Microsoft_VSTS_Common_Priority string

Субъективная оценка ошибки, проблемы, задачи или тестового случая, как это относится к бизнесу.

Команда Project
wiql__System_TeamProject string

Командный проект, к которому принадлежит этот рабочий элемент.

Создано автором
wiql__System_CreatedBy string

Имя члена группы, создавшего рабочий элемент.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

При назначении рабочего элемента

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

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project True string

Имя проекта в указанной организации.

Имя команды (для выбора назначенного)
team True string

Имя команды, из которой нужно выбрать участника.

Assigned To
wiql__System_AssignedTo True string

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

Тип
wiql__System_WorkItemType string

Имя типа рабочего элемента.

Областной путь
wiql__System_AreaPath string

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

Сравнение пути к области
areaPathComparison string

Правило, используемое при сравнении поля "Путь к области".

Путь итерации
wiql__System_IterationPath string

Именованный спринт или период времени, в который находится рабочий элемент.

Сравнение пути итерации
iterationPathComparison string

Правило, используемое при сравнении поля пути итерации.

Priority
wiql__Microsoft_VSTS_Common_Priority string

Субъективная оценка ошибки, проблемы, задачи или тестового случая, как это относится к бизнесу.

Создано автором
wiql__System_CreatedBy string

Имя члена группы, создавшего рабочий элемент.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

При назначении рабочего элемента [DEPRECATED]

Это действие устарело. Используйте вместо этого рабочий элемент .

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

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project True string

Имя проекта в указанной организации.

Assigned To
wiql__System_AssignedTo True string

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

Имя команды (для выбора назначенного)
team string

Имя команды, из которой нужно выбрать участника.

Тип
wiql__System_WorkItemType string

Имя типа рабочего элемента.

Областной путь
wiql__System_AreaPath string

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

Сравнение пути к области
areaPathComparison string

Правило, используемое при сравнении поля "Путь к области".

Путь итерации
wiql__System_IterationPath string

Именованный спринт или период времени, в который находится рабочий элемент.

Сравнение пути итерации
iterationPathComparison string

Правило, используемое при сравнении поля пути итерации.

Priority
wiql__Microsoft_VSTS_Common_Priority string

Субъективная оценка ошибки, проблемы, задачи или тестового случая, как это относится к бизнесу.

Команда Project
wiql__System_TeamProject string

Командный проект, к которому принадлежит этот рабочий элемент.

Создано автором
wiql__System_CreatedBy string

Имя члена группы, создавшего рабочий элемент.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

При обновлении рабочего элемента

Активирует поток при обновлении рабочего элемента, соответствующего заданным критериям.

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project True string

Имя проекта в указанной организации.

Имя команды (для выбора назначенного)
team string

Имя команды, из которой нужно выбрать назначаемого.

Assigned To
wiql__System_AssignedTo string

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

Тип
wiql__System_WorkItemType string

Имя типа рабочего элемента.

Областной путь
wiql__System_AreaPath string

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

Сравнение пути к области
areaPathComparison string

Правило, используемое при сравнении поля "Путь к области".

Путь итерации
wiql__System_IterationPath string

Именованный спринт или период времени, в который находится рабочий элемент.

Сравнение пути итерации
iterationPathComparison string

Правило, используемое при сравнении поля пути итерации.

Priority
wiql__Microsoft_VSTS_Common_Priority string

Субъективная оценка ошибки, проблемы, задачи или тестового случая, как это относится к бизнесу.

Создано автором
wiql__System_CreatedBy string

Имя члена группы, создавшего рабочий элемент.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

При обновлении рабочего элемента [DEPRECATED]

Это действие устарело. Используйте вместо этого , когда рабочий элемент обновляется .

Активирует поток при обновлении рабочего элемента, соответствующего заданным критериям.

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project True string

Имя проекта в указанной организации.

Имя команды (для выбора назначенного)
team string

Имя команды, из которой нужно выбрать назначаемого.

Assigned To
wiql__System_AssignedTo string

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

Тип
wiql__System_WorkItemType string

Имя типа рабочего элемента.

Областной путь
wiql__System_AreaPath string

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

Сравнение пути к области
areaPathComparison string

Правило, используемое при сравнении поля "Путь к области".

Путь итерации
wiql__System_IterationPath string

Именованный спринт или период времени, в который находится рабочий элемент.

Сравнение пути итерации
iterationPathComparison string

Правило, используемое при сравнении поля пути итерации.

Priority
wiql__Microsoft_VSTS_Common_Priority string

Субъективная оценка ошибки, проблемы, задачи или тестового случая, как это относится к бизнесу.

Команда Project
wiql__System_TeamProject string

Командный проект, к которому принадлежит этот рабочий элемент.

Создано автором
wiql__System_CreatedBy string

Имя члена группы, создавшего рабочий элемент.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

При отправке кода (Git)

Активирует поток при отправке кода в репозиторий Git.

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project True string

Имя проекта в указанной организации.

Имя репозитория
repository True string

Имя репозитория в указанном проекте.

Имя ссылки
refName string

Имя ссылки на Git, например ветвь или тег.

Возвращаемое значение

Список моделей VSTS.

При проверке кода (TFVC)

Активирует поток при входе кода в проект Управления версиями Team Foundation.

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project True string

Имя проекта в указанной организации.

Имя группы
team string

Имя команды, которую нужно выбрать автора.

Член группы
author string

Уникальное имя участника группы, создавшего вход.

Возвращаемое значение

Список моделей VSTS.

При создании запроса на вытягивание (Git)

Активирует поток при создании запроса на вытягивание, соответствующего заданным критериям.

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project True string

Имя проекта в указанной организации.

Имя репозитория
repository True string

Имя репозитория в указанном проекте.

Имя источника ссылок
sourceRefName string

Имя ссылки на Git, например ветвь или тег.

Имя целевого ссылок
targetRefName string

Имя ссылки на Git, например ветвь или тег.

Возвращаемое значение

Список моделей VSTS.

При создании рабочего элемента

Активирует поток при создании рабочего элемента, соответствующего заданным критериям.

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project True string

Имя проекта в указанной организации.

Имя команды (для выбора назначенного)
team string

Имя команды, из которой нужно выбрать назначаемого.

Assigned To
wiql__System_AssignedTo string

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

Тип
wiql__System_WorkItemType string

Имя типа рабочего элемента.

Областной путь
wiql__System_AreaPath string

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

Сравнение пути к области
areaPathComparison string

Правило, используемое при сравнении поля "Путь к области".

Путь итерации
wiql__System_IterationPath string

Именованный спринт или период времени, в который находится рабочий элемент.

Сравнение пути итерации
iterationPathComparison string

Правило, используемое при сравнении поля пути итерации.

Priority
wiql__Microsoft_VSTS_Common_Priority string

Субъективная оценка ошибки, проблемы, задачи или тестового случая, как это относится к бизнесу.

Создано автором
wiql__System_CreatedBy string

Имя члена группы, создавшего рабочий элемент.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

При создании рабочего элемента [DEPRECATED]

Это действие устарело. Используйте вместо этого рабочий элемент .

Активирует поток при создании рабочего элемента, соответствующего заданным критериям.

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
account True string

Имя организации. Это можно найти в URL-адресе экземпляра, например {Organization}.visualstudio.com. Организация должна иметь доступ к сторонним приложениям через OAuth, чтобы предотвратить ошибки в операции.

имя Project
project True string

Имя проекта в указанной организации.

Имя команды (для выбора назначенного)
team string

Имя команды, из которой нужно выбрать назначаемого.

Assigned To
wiql__System_AssignedTo string

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

Тип
wiql__System_WorkItemType string

Имя типа рабочего элемента.

Областной путь
wiql__System_AreaPath string

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

Сравнение пути к области
areaPathComparison string

Правило, используемое при сравнении поля "Путь к области".

Путь итерации
wiql__System_IterationPath string

Именованный спринт или период времени, в который находится рабочий элемент.

Сравнение пути итерации
iterationPathComparison string

Правило, используемое при сравнении поля пути итерации.

Priority
wiql__Microsoft_VSTS_Common_Priority string

Субъективная оценка ошибки, проблемы, задачи или тестового случая, как это относится к бизнесу.

Команда Project
wiql__System_TeamProject string

Командный проект, к которому принадлежит этот рабочий элемент.

Создано автором
wiql__System_CreatedBy string

Имя члена группы, создавшего рабочий элемент.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Определения

VstsList[Account]

Список моделей VSTS.

Имя Путь Тип Описание
Ценность
value array of Account

Модели VSTS

Счет

Счет

Имя Путь Тип Описание
Идентификатор учетной записи
accountId string

Идентификатор учетной записи.

URI учетной записи
accountUri string

Универсальный код ресурса (URI) учетной записи.

Имя учетной записи
accountName string

Имя учетной записи.

Владелец учетной записи
accountOwner string

Владелец набора учетной записи.

Название организации
organizationName string

Имя организации, соответствующее учетной записи.

Тип учетной записи
accountType string

Тип учетной записи.

Profile

Profile

Имя Путь Тип Описание
отображаемое имя
displayName string

Отображаемое имя пользователя

id
id string

Уникальный идентификатор профиля.

publicAlias
publicAlias string

Общедоступный псевдоним.

Электронная почта
emailAddress string

Адрес электронной почты учетной записи.

Метка времени
timeStamp date-time

Время, когда этот профиль был изменен в последний раз.

ревизия
revision integer

Максимальный номер редакции любого атрибута.

CoreRevision
coreRevision integer

CoreRevision

VstsList[TeamSettingsIteration]

Список моделей VSTS.

Имя Путь Тип Описание
Ценность
value array of TeamSettingsIteration

Модели VSTS

TeamSettingsIteration

Итерация работы (гибкая)

Имя Путь Тип Описание
Attributes
Attributes TeamIterationAttributes

Атрибуты итерации команды

Идентификатор
Id string

Идентификатор ресурса.

Имя
Name string

Имя ресурса.

Путь
Path string

Относительный путь к итерации.

Links
_links object

Коллекция ссылок, относящихся к ресурсу.

URL
Url string

Полная http-ссылка на ресурс.

TeamIterationAttributes

Атрибуты итерации команды

Имя Путь Тип Описание
Дата окончания
FinishDate date-time

Атрибут итерации команды окончания.

Дата начала
StartDate date-time

Атрибут итерации команды начала.

Links

Имя Путь Тип Описание
веб
web WebLinks

Веб-ссылки

Веб-ссылки

Имя Путь Тип Описание
HTML-ссылка
href string

URL-адрес веб-страницы сведений о сборке

BuildResult

Результат сборки

Имя Путь Тип Описание
Идентификатор сборки
id integer

Уникальный идентификатор сборки.

Номер сборки
buildNumber string

Номер сборки.

Исходная ветвь
sourceBranch string

Ветвь системы управления версиями используется сборка.

Исходная версия
sourceVersion string

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

Состояние
status string

Состояние сборки.

Priority
priority string

Приоритет сборки.

Время очереди
queueTime date-time

Время, когда сборка была поставлена в очередь.

Время начала
startTime date-time

Время начала сборки.

Время окончания
finishTime date-time

Время завершения сборки.

Причина
reason string

Причина сборки.

Result
result string

Результат сборки.

запрошенные для
requestedFor BuildRequestUser

Пользователь запроса на сборку

Параметры
parameters string

Параметры, передаваемые в сборку, если таковые есть.

Определение
definition BuildResultDefinition

Определение результата сборки

_дюны
_links Links

Links

BuildRequestUser

Пользователь запроса на сборку

Имя Путь Тип Описание
Запрошено для
uniqueName string

Для пользователя было запрошено уникальное имя сборки.

BuildResultDefinition

Определение результата сборки

Имя Путь Тип Описание
Идентификатор определения сборки
id integer

Идентификатор определения сборки.

Имя определения сборки
name string

Имя определения сборки.

VstsList[BuildResult]

Список моделей VSTS.

Имя Путь Тип Описание
Ценность
value array of BuildResult

Модели VSTS

Временная шкала

Временная шкала сборки

Имя Путь Тип Описание
Идентификатор временной шкалы
id uuid

Идентификатор временной шкалы.

Изменение идентификатора
changeId integer

Идентификатор изменения временной шкалы.

Последнее изменение
lastChangedBy uuid

Процесс или пользователь, который последний раз изменил временную шкалу.

Последнее изменение
lastChangedOn date-time

Время последнего изменения временной шкалы.

Записи временной шкалы
records array of TimelineRecord

Записи временной шкалы.

Временная шкала

Запись временной шкалы

Имя Путь Тип Описание
Идентификатор записи
id uuid

Идентификатор записи.

Изменение идентификатора
changeId integer

Идентификатор изменения записи.

Родительский идентификатор
parentId uuid

Идентификатор родительской записи.

Тип
type string

Тип записи.

Имя
name string

Имя записи.

Время начала
startTime date-time

Время начала записи.

Время окончания
finishTime date-time

Время окончания записи.

Государство
state string

Состояние записи.

Result
result string

Результат записи.

Имя рабочей роли
workerName string

Рабочая роль, обрабатывая запись.

Попытка
attempt integer

Номер попытки записи.

Идентификатор
identifier string

Значение идентификатора записи.

Проблемы
issues array of TimelineIssue

Проблемы, возникающие в записи.

Лог
log TimelineLogReference

Справочник по журналу временной шкалы

Заказ
order integer

Порядок выполнения записи.

details
details TimelineReference

Справочник по временной шкале

Задача
task TimelineTask

Задача временной шкалы

Предыдущие попытки
previousAttempts array of TimelineReference

Предыдущие попытки записи.

Процент завершения
percentComplete integer

Процент завершения записи.

Текущая операция
currentOperation string

Текущая операция записи.

URL
url string

URL-адрес записи.

Код результата
resultCode string

Запись кода результата.

Свойства
properties object

Свойства записи.

Временная шкала

Проблема с временной шкалой

Имя Путь Тип Описание
Тип
type string

Тип проблемы.

Категория
category string

Категория проблем.

Message
message string

Сообщение о проблеме.

Данные
data object

Выдача данных.

Код ошибки
errorCode string

Ошибка в коде ошибки.

Код предупреждения
warningCode string

Код предупреждения о проблеме.

TimelineLogReference

Справочник по журналу временной шкалы

Имя Путь Тип Описание
Идентификатор журнала
id integer

Идентификатор журнала.

Тип
type string

Тип журнала.

Число строк
lineCount integer

Количество строк в журнале.

URL
url string

URL-адрес журнала.

Временная шкалаReference

Справочник по временной шкале

Имя Путь Тип Описание
Идентификатор
id uuid

Идентификатор ссылки.

Изменение идентификатора
changeId integer

Идентификатор изменения ссылки.

Временная шкала

Задача временной шкалы

Имя Путь Тип Описание
Идентификатор задачи
id uuid

Идентификатор задачи.

Имя
name string

Имя задачи.

Версия
version string

Версия задачи.

VstsList[GitRepository]

Список моделей VSTS.

Имя Путь Тип Описание
Ценность
value array of GitRepository

Модели VSTS

GitRepository

Репозиторий Git

Имя Путь Тип Описание
Идентификатор репозитория
id string

Уникальный идентификатор репозитория.

Имя репозитория
name string

Имя репозитория.

URL-адрес браузера репозитория
url string

URL-адрес — это конечная точка API для репозитория.

Удаленный URL-адрес репозитория
remoteUrl string

URL-адрес, с помощью которого git может синхронизироваться с этим репозиторием.

VstsList[GitRef]

Список моделей VSTS.

Имя Путь Тип Описание
Ценность
value array of GitRef

Модели VSTS

GitRef

Git Ref

Имя Путь Тип Описание
Идентификатор ссылки
objectId string

Уникальный идентификатор ссылки.

Имя ссылки
name string

Имя ссылки.

VstsList[GitPush]

Список моделей VSTS.

Имя Путь Тип Описание
Ценность
value array of GitPush

Модели VSTS

GitPush

Отправка Git

Имя Путь Тип Описание
репозиторий
repository GitRepository

Репозиторий Git

pushedBy
pushedBy GitPushUser

Git Push User

Обновления ссылок
refUpdates array of GitRefUpdate

Ссылки, которые были обновлены в рамках этой принудительной отправки.

Push Id
pushId integer

Уникальный идентификатор push-отправки.

Date
date date-time

Дата создания отправки.

GitPushUser

Git Push User

Имя Путь Тип Описание
Идентификатор push-указателя
id string

Уникальный идентификатор пользователя, создавшего push-отправку.

Имя push-указателя
displayName string

Имя пользователя, создавшего push-отправку.

Уникальное имя push-указателя
uniqueName string

Уникальное имя пользователя, создавшего push-отправку.

URL-адрес образа push-указателя
imageUrl string

URL-адрес изображения для этого пользователя.

VstsList[GitPullRequest]

Список моделей VSTS.

Имя Путь Тип Описание
Ценность
value array of GitPullRequest

Модели VSTS

GitPullRequest

Запрос на вытягивание Git

Имя Путь Тип Описание
репозиторий
repository GitRepository

Репозиторий Git

Идентификатор запроса на вытягивание
pullRequestId integer

Уникальный идентификатор запроса на вытягивание.

создано кем
createdBy PullRequestCreatedBy

Запрос на вытягивание, созданный с помощью

Дата создания
creationDate date-time

Дата создания запроса на вытягивание

Дата закрытия
closedDate date-time

Дата закрытия запроса на вытягивание (завершена, отменена или объединена внешне)

Название
title string

Заголовок запроса на вытягивание

Description
description string

Описание запроса на вытягивание

Имя источника ссылок
sourceRefName string

Имя исходной ветви запроса на вытягивание

Имя целевого ссылок
targetRefName string

Имя целевой ветви запроса на вытягивание

Является черновиком
isDraft boolean

Черновик / запрос на вытягивание WIP

Рецензенты
reviewers array of PullRequestReviewer

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

Список рецензентов
reviewerList string

Разделенный точкой с запятой список уникальных имен рецензента, которые являются допустимыми адресами электронной почты

Список обязательных рецензентов
requiredReviewerList string

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

Фиксации
commits array of GitCommitRef

Фиксации, содержащиеся в запросе на вытягивание.

completionOptions
completionOptions PullRequestCompletionOptions

Параметры завершения запроса на вытягивание

mergeOptions
mergeOptions PullRequestMergeOptions

Параметры слияния запросов на вытягивание

Сообщение об ошибке слияния
mergeFailureMessage string

Если задано, слияние запроса на вытягивание завершилось сбоем по этой причине.

closedBy
closedBy PullRequestClosedBy

Запрос на вытягивание закрыт

autoCompleteSetBy
autoCompleteSetBy PullRequestAutoCompleteSetBy

Автоматическое заполнение запроса на вытягивание по

URL-адрес
url string

URL-адрес запроса на вытягивание.

Удаленный URL-адрес
remoteUrl string

Удаленный URL-адрес запроса на вытягивание.

Идентификатор артефакта
artifactId string

Строка, которая однозначно идентифицирует этот запрос на вытягивание.

Идентификатор слияния
mergeId string

Идентификатор слияния запроса на вытягивание.

Идентификатор проверки кода
codeReviewId integer

Идентификатор проверки кода запроса на вытягивание.

Время очереди завершения
completionQueueTime string

Последняя дата, по которой запрос на вытягивание ввел очередь для завершения.

Поддерживает итерации
supportsIterations boolean

Если задано значение true, этот запрос на вытягивание поддерживает несколько итераций.

PullRequestCreatedBy

Запрос на вытягивание, созданный с помощью

Имя Путь Тип Описание
Создано отображаемым именем
displayName string

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

Создание по уникальному имени
uniqueName string

Уникальное имя создателя запроса на вытягивание.

Создан идентификатором
id string

Идентификатор создателя запроса на вытягивание.

Создан по URL-адресу образа
imageUrl string

URL-адрес изображения создателя запроса на вытягивание.

Создан по URL-адресу
url string

URL-адрес создателя запроса на вытягивание.

PullRequestClosedBy

Запрос на вытягивание закрыт

Имя Путь Тип Описание
Закрыто по отображаемого имени
displayName string

Отображаемое имя запроса на вытягивание ближе.

Закрыто уникальным именем
uniqueName string

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

Закрыто по идентификатору
id string

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

Закрыто по URL-адресу изображения
imageUrl string

URL-адрес изображения запроса на вытягивание ближе.

Закрыто по URL-адресу
url string

URL-адрес запроса на вытягивание ближе.

PullRequestAutoCompleteSetBy

Автоматическое заполнение запроса на вытягивание по

Имя Путь Тип Описание
Автоматическое заполнение по отображаемого имени
displayName string

Отображаемое имя пользователя, который включил автоматическое завершение.

Автоматическое завершение по уникальному имени
uniqueName string

Уникальное имя пользователя, который включил автоматическое завершение.

Автоматическое заполнение по идентификатору
id string

Идентификатор пользователя, который включил автоматическое завершение.

Автозавержение по URL-адресу изображения
imageUrl string

URL-адрес изображения пользователя, который включил автозавержение.

Автоматическое заполнение по URL-адресу
url string

URL-адрес пользователя, который включил автоматическое завершение.

PullRequestReviewer

Рецензент запроса на вытягивание

Имя Путь Тип Описание
Отображаемое имя рецензента
displayName string

Отображаемое имя рецензента запроса на вытягивание.

Уникальное имя рецензента
uniqueName string

Уникальное имя рецензента запроса на вытягивание.

Идентификатор рецензента
id string

Идентификатор рецензента запроса на вытягивание.

URL-адрес рецензента
url string

URL-адрес рецензента запроса на вытягивание.

Отклонено
hasDeclined boolean

Указывает, отказался ли этот рецензент проверить этот запрос на вытягивание.

Помечается
isFlagged boolean

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

Требуется
isRequired boolean

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

Голос
vote integer

Голосование по запросу на вытягивание: утверждено(10), утверждено с предложениями(5), нет голосов(0), ожидая автора (-5), отклонено (-10).

Проголосовали за
votedFor array of PullRequestReviewer

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

PullRequestMergeOptions

Параметры слияния запросов на вытягивание

Имя Путь Тип Описание
Нет быстрого переадресации
noFastForward string

Двух родительское слияние без быстрого переадресации. Исходная ветвь не изменяется. Это поведение по умолчанию.

Ребейз
rebase string

Перебазируйте исходную ветвь поверх фиксации HEAD целевой ветви и перенаправите целевую ветвь.

Перебазировать слияние
rebaseMerge string

Перебазируйте исходную ветвь поверх фиксации HEAD целевой ветви и создайте двух родительский, без быстрого слияния.

Сквош
squash string

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

PullRequestMergeStrategy

Стратегия слияния запросов на вытягивание

Имя Путь Тип Описание
Фиксации авторства конфликтов
conflictAuthorshipCommits boolean

Если задано значение true, разрешения конфликтов, примененные во время слияния, будут помещены в отдельные фиксации для сохранения сведений о авторстве для вины Git.

Обнаружение ложноположительных срабатываний
detectRenameFalsePositives boolean

Если значение true, обнаруживает переименование ложных срабатываний.

Отключение переименований
disableRenames boolean

Если значение true, обнаружение переименования не будет выполнено во время слияния.

PullRequestCompletionOptions

Параметры завершения запроса на вытягивание

Имя Путь Тип Описание
Автоматическое завершение пропустить идентификаторы конфигурации
autoCompleteIgnoreConfigIds array of integer

Список идентификаторов конфигурации политики, для которых автоматическое завершение не должно ожидать

Обход политики
bypassPolicy boolean

Если значение true, политики будут явно обойдены во время завершения запроса на вытягивание.

Обход причины
bypassReason string

Если политики обходятся, сохраняется причина использования обхода.

Удаление исходной ветви
deleteSourceBranch boolean

Если true, исходная ветвь запроса pull будет удалена после завершения.

Сообщение об фиксации слияния
mergeCommitMessage string

Если этот параметр установлен, он будет использоваться в качестве сообщения о коммите слияния.

mergeStrategy
mergeStrategy PullRequestMergeStrategy

Стратегия слияния запросов на вытягивание

Слияние скваша
squashMerge boolean

Если MergeStrategy не задан, стратегия слияния будет без быстрой перемотки, если этот флаг имеет значение false, или squash, если true.

Переход рабочих элементов
transitionWorkItems boolean

Если значение true, мы попытаемся перенести все рабочие элементы, связанные с запросом на вытягивание, в следующее логическое состояние (т. е. активный —> разрешено).

CommitGitUserDate

Фиксация Git User Date

Имя Путь Тип Описание
Дата фиксации пользователя
date string

Дата выполнения операции Git.

Фиксация электронной почты пользователя
email string

Адрес электронной почты пользователя, выполняющего операцию Git.

Url-адрес фиксации изображения
imageUrl string

URL для аватара пользователя.

Зафиксировать имя пользователя
name string

Имя пользователя, выполняющего операцию Git.

GitCommitRef

Ссылка на фиксацию Git

Имя Путь Тип Описание
автор
author CommitGitUserDate

Фиксация Git User Date

Зафиксировать комментарий
comment string

Комментарий или сообщение фиксации.

Усечение примечания фиксации
commentTruncated string

Указывает, усечен ли комментарий из полного сообщения о фиксации Git.

Идентификатор фиксации
commitId string

Идентификатор фиксации.

Коммиттер
committer CommitGitUserDate

Фиксация Git User Date

Родители
parents array of string

Перечисление идентификаторов родительских фиксаций для этой фиксации.

Фиксация удаленного URL-адреса
remoteUrl string

Удаленный путь URL-адреса к фиксации.

URL-адрес фиксации
url string

REST URL-адрес для этого ресурса.

GitRefUpdate

Обновление Git Ref

Имя Путь Тип Описание
Имя ссылки
name string

Имя обновленного Git Ref.

Идентификатор репозитория
repositoryId string

Уникальный идентификатор репозитория.

Старый идентификатор фиксации
oldObjectId string

Идентификатор предыдущей фиксации, на который указывает ссылка перед обновлением.

Новый идентификатор фиксации
newObjectId string

Идентификатор новой фиксации, на который указывает ссылка перед обновлением.

VstsList[Project]

Список моделей VSTS.

Имя Путь Тип Описание
Ценность
value array of Project

Модели VSTS

Project

Project

Имя Путь Тип Описание
идентификатор Project
id string

Уникальный идентификатор проекта.

имя Project
name string

Имя проекта.

URL-адрес Project
url string

URL-адрес API проекта.

VstsList[TeamMember]

Список моделей VSTS.

Имя Путь Тип Описание
Ценность
value array of TeamMember

Модели VSTS

TeamMember

Член группы

Имя Путь Тип Описание
Идентификатор участника группы
id string

Уникальный идентификатор члена команды.

Отображаемое имя
displayName string

Отображаемое имя участника команды.

Уникальное имя
uniqueName string

Имя пользователя участника команды.

Универсальный код ресурса (URI) члена
url string

Универсальный код ресурса (URI) участника команды.

URI изображения
imageUrl string

Универсальный код ресурса (URI) образа участника группы.

VstsList[ReleaseDefinition]

Список моделей VSTS.

Имя Путь Тип Описание
Ценность
value array of ReleaseDefinition

Модели VSTS

ReleaseDefinition

Определение выпуска

Имя Путь Тип Описание
Комментарий
Comment string

Комментарий определения выпуска.

Создано
CreatedOn date-time

Дата создания определения выпуска.

Description
Description string

Описание определения выпуска.

Идентификатор
Id integer

Уникальный идентификатор определения выпуска.

ModifiedBy
ModifiedBy IdentityRef

Ссылка на удостоверение

Изменено
ModifiedOn date-time

Дата изменения определения выпуска.

Имя
Name string

Имя определения выпуска.

Путь
Path string

Путь определения выпуска.

Формат имени выпуска
ReleaseNameFormat string

Формат имени выпуска определения выпуска.

Исправление
Revision integer

Номер редакции определения выпуска.

Исходный материал
Source string

Источник определения выпуска.

Метки
Tags array of string

Список тегов определения выпуска.

URL
Url string

URL-адрес для доступа к определению выпуска.

IdentityRef

Ссылка на удостоверение

Имя Путь Тип Описание
Псевдоним каталога
DirectoryAlias string

Псевдоним каталога ссылки на удостоверение.

Отображаемое имя
DisplayName string

Отображаемое имя ссылки на удостоверение.

Уникальное имя
UniqueName string

Уникальное имя ссылки на удостоверение.

URL
Url string

URL-адрес ссылки на удостоверение.

Идентификатор
Id string

Идентификатор ссылки на удостоверение.

ReleaseDefinitionShallowReference

Неглубокая ссылка на определение выпуска

Имя Путь Тип Описание
Идентификатор
Id integer

Уникальный идентификатор определения выпуска.

Имя
Name string

Имя определения выпуска.

URL
Url string

URL-адрес REST API для доступа к определению выпуска.

Object

ObjectWithoutType

Релиз

Релиз

Имя Путь Тип Описание
Комментарий
Comment string

Комментарий к выпуску.

Создано пользователем
CreatedBy IdentityRef

Ссылка на удостоверение

Создано
CreatedOn date-time

Дата создания выпуска.

Description
Description string

Описание выпуска.

Идентификатор
Id integer

Уникальный идентификатор выпуска.

Сохранить навсегда
KeepForever boolean

Следует ли исключить выпуск из политик хранения.

URL-адрес контейнера журналов
LogsContainerUrl string

URL-адрес контейнера журнала этого выпуска.

ModifiedBy
ModifiedBy IdentityRef

Ссылка на удостоверение

Изменено
ModifiedOn date-time

Дата изменения выпуска.

Имя
Name string

Имя выпуска.

Причина
Reason string

Причина выпуска.

ReleaseDefinition
ReleaseDefinition ReleaseDefinitionShallowReference

Неглубокая ссылка на определение выпуска

Состояние
Status string

Состояние выпуска.

URL
Url string

URL-адрес выпуска.

VstsList[TfvcChangeset]

Список моделей VSTS.

Имя Путь Тип Описание
Ценность
value array of TfvcChangeset

Модели VSTS

TfvcChangeset

Набор изменений управления версиями Team Foundation

Имя Путь Тип Описание
Идентификатор набора изменений
changesetId integer

Уникальный идентификатор набора изменений.

автор
author ChangesetAuthor

Автор набора изменений

checkedInBy
checkedInBy ChangesetCheckedInBy

Набор изменений, зарегистрированный по

Дата создания
createdDate date-time

Дата создания набора изменений.

Комментарий
comment string

Комментарий, описывающий набор изменений.

ChangesetAuthor

Автор набора изменений

Имя Путь Тип Описание
Имя автора
displayName string

Имя пользователя, создавшего набор изменений.

Уникальное имя автора
uniqueName string

Уникальное имя пользователя, создавшего набор изменений.

ChangesetCheckedInBy

Набор изменений, зарегистрированный по

Имя Путь Тип Описание
Возвращено по имени
displayName string

Имя пользователя, который проверил набор изменений.

Зарегистрировано по уникальному имени
uniqueName string

Уникальное имя пользователя, создавшего набор изменений.

VstsList[WorkItemType]

Список моделей VSTS.

Имя Путь Тип Описание
Ценность
value array of WorkItemType

Модели VSTS.

WorkItemHit

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

Имя Путь Тип Описание
Имя ссылки на поле
fieldReferenceName string

Имя выделенного поля.

Основные моменты
highlights array of string

Сопоставленные или выделенные фрагменты поля.

WorkItemResult

Результат рабочего элемента, соответствующий запросу на поиск рабочих элементов

Имя Путь Тип Описание
проект
project SearchProject

Project сведения о результатах поиска

Fields
fields object

Стандартный набор полей рабочего элемента и их значения.

Хиты
hits array of WorkItemHit

Выделены фрагменты полей, которые соответствуют запросу поиска.

URL
url string

Ссылка на рабочий элемент.

SearchProject

Project сведения о результатах поиска

Имя Путь Тип Описание
Идентификатор
id string

Идентификатор проекта.

Имя
name string

Имя проекта.

WorkItemSearchResponse

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

Имя Путь Тип Описание
Численность
count integer

Общее количество сопоставленных рабочих элементов.

Results
results array of WorkItemResult

Список наиболее подходящих рабочих элементов.

Код сведений
infoCode integer

Числовой код, указывающий любую дополнительную информацию.

Аспекты
facets object

Словарь, сохраняющий массив объекта Filter по каждому аспекту.

WorkItemType

Тип рабочего элемента

Имя Путь Тип Описание
Description
Description string

Описание типа.

Имя
Name string

Имя типа.

XML-форма
XmlForm string

XML-представление типа.

Fields
FieldInstances array of WorkItemTypeFieldInstance

Список экземпляров полей, связанных с типом.

Идентификатор значка
icon.id string

Идентификатор значка

URL-адрес значка
icon.url string

URL-адрес REST ресурса

States
states array of WorkItemStateColor

Состояния типа рабочего элемента

WorkItemTypeFieldInstance

Экземпляр поля типа рабочего элемента

Имя Путь Тип Описание
Всегда обязательный
AlwaysRequired boolean

Указывает, всегда ли требуется экземпляр поля.

Имя ссылки
ReferenceName string

Имя ссылки экземпляра поля.

Имя
Name string

Имя экземпляра поля.

URL
Url string

URL-адрес, указывающий на сведения о экземпляре поля.

WorkItemComment

Комментарий рабочего элемента

Имя Путь Тип Описание
_дюны
_links ReferenceLinks

Коллекция ссылок REST.

Идентификатор комментария
id integer

Уникальный идентификатор комментария.

Идентификатор рабочего элемента
workItemId integer

Идентификатор рабочего элемента, к которому принадлежит комментарий.

Версия
version integer

Редакция рабочего элемента, связанная с этим комментарием.

Формат комментариев
format CommentFormat

Указывает, как интерпретируется текст комментариев.

Текст примечания
text string

Текст комментария.

Отрисованный текст
renderedText string

Отрисованная HTML-версия текста примечания.

создано кем
createdBy IdentityRef

Ссылка на удостоверение

Дата создания
createdDate date-time

Дата создания комментария.

createdOnBehalfOf
createdOnBehalfOf IdentityRef

Ссылка на удостоверение

Дата создания от имени
createdOnBehalfDate date-time

Дата создания от имени другого удостоверения.

modifiedBy
modifiedBy IdentityRef

Ссылка на удостоверение

Дата изменения
modifiedDate date-time

Дата последнего изменения комментария.

Удаляется
isDeleted boolean

Указывает, удален ли комментарий.

Упоминания
mentions array of CommentMention

Упоминания, включенные в комментарий.

Реакции
reactions array of CommentReaction

Реакции на комментарий.

URL
url string

URL-адрес REST API комментария.

CommentFormat

Указывает, как интерпретируется текст комментариев.

Указывает, как интерпретируется текст комментариев.

Формат комментариев
string

CommentMention

Представляет упоминание в комментарии.

Имя Путь Тип Описание
_дюны
_links ReferenceLinks

Коллекция ссылок REST.

Идентификатор артефакта
artifactId string

Часть артефакта синтаксического текста (например, идентификатор рабочего элемента).

Тип артефакта
artifactType string

Тип, назначенный упоминаниям (человек, рабочий элемент и т. д.).

Идентификатор комментария
commentId integer

Идентификатор комментария, содержащий упоминание.

Идентификатор цели
targetId string

Разрешенный целевой объект упоминания.

URL
url string

URL-адрес REST API упоминания.

CommentReactionType

Тип реакции комментария.

Тип реакции комментария.

Тип реакции
string

CommentReaction

Содержит сведения о реакции комментариев рабочего элемента.

Имя Путь Тип Описание
_дюны
_links ReferenceLinks

Коллекция ссылок REST.

Идентификатор комментария
commentId integer

Идентификатор комментария, к которому относится эта реакция.

Численность
count integer

Общее количество реакций для этого типа реакции.

Занят ли текущий пользователь
isCurrentUserEngaged boolean

Указывает, участвует ли текущий пользователь с этой реакцией.

Тип реакции
type CommentReactionType

Тип реакции комментария.

URL
url string

URL-адрес REST API реакции.

Коллекция ссылок REST.

Имя Путь Тип Описание
object

Коллекция ссылок REST.

WorkItemAttachmentResponse

Имя Путь Тип Описание
attachmentId
attachmentId string

Идентификатор вложения.

Имя файла
fileName string

Имя файла вложения.

Тип контента
contentType string

Тип MIME вложения.

contentLength
contentLength integer

Размер вложения в байтах.

последнееИзменение
lastModified date-time

Последняя измененная метка времени для вложения.

содержимое
content byte

Содержимое вложения, закодированное как строка Base64.

WorkItemCommentsResponse

Представляет ответ, содержащий комментарии рабочего элемента.

Имя Путь Тип Описание
Численность
count integer

Общее количество комментариев.

Comments
comments array of WorkItemComment

Список комментариев.

VstsList[JObject]

Список моделей VSTS.

Имя Путь Тип Описание
Ценность
value array of Object

Модели VSTS

VstsList[WorkItemField]

Список моделей VSTS.

Имя Путь Тип Описание
Ценность
value array of WorkItemField

Модели VSTS

VstsList[QueryHierarchyItem]

Список моделей VSTS.

Имя Путь Тип Описание
Ценность
value array of QueryHierarchyItem

Модели VSTS

QueryHierarchyItem

Элемент иерархии запросов

Имя Путь Тип Описание
Дети
Children array of QueryHierarchyItem

Список дочерних элементов, связанных с элементом иерархии запросов.

Клаузулы
Clauses WorkItemQueryClause

Предложение запроса рабочих элементов

Колонны
Columns array of WorkItemFieldReference

Список столбцов полей рабочего элемента, связанных с элементом иерархии запросов.

Параметры фильтра
FilterOptions string

Параметры фильтра элемента иерархии запросов.

Имеет детей
HasChildren boolean

Указывает, имеет ли элемент иерархии запросов дочерние элементы.

Идентификатор
Id string

Уникальный идентификатор элемента иерархии запросов.

Удаляется
IsDeleted boolean

Указывает, удаляется ли элемент иерархии запросов.

Папка Is
IsFolder boolean

Указывает, является ли элемент иерархии запросов папкой.

Недопустимый синтаксис
IsInvalidSyntax boolean

Указывает, имеет ли элемент иерархии запросов недопустимый синтаксис.

Общедоступная
IsPublic boolean

Указывает, является ли элемент иерархии запросов общедоступным.

LinkClauses
LinkClauses WorkItemQueryClause

Предложение запроса рабочих элементов

Имя
Name string

Имя элемента иерархии запросов.

Путь
Path string

Путь к элементу иерархии запросов.

Тип запроса
QueryType string

Тип запроса элемента иерархии запросов.

Сортировка столбцов
SortColumns array of WorkItemQuerySortColumn

Список столбцов сортировки элемента иерархии запросов.

SourceClauses
SourceClauses WorkItemQueryClause

Предложение запроса рабочих элементов

TargetClauses
TargetClauses WorkItemQueryClause

Предложение запроса рабочих элементов

Wiql
Wiql string

WIQL элемента иерархии запросов.

Links
_links object

Коллекция ссылок, относящихся к элементу иерархии запросов.

URL
Url string

Полная http-ссылка на элемент иерархии запросов.

WorkItemStateColor

Цвет состояния рабочего элемента

Имя Путь Тип Описание
категория состояния
category string

категория состояния

Значение цвета
color string

Значение цвета

имя состояния
name string

Имя состояния типа рабочего элемента

WorkItemQueryClause

Предложение запроса рабочих элементов

Имя Путь Тип Описание
Клаузулы
Clauses WorkItemQueryClause

Предложение запроса рабочих элементов

Поле
Field WorkItemFieldReference

Справочник по полю рабочего элемента

FieldValue
FieldValue WorkItemFieldReference

Справочник по полю рабочего элемента

Значение поля
IsFieldValue boolean

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

Логический оператор
LogicalOperator string

Логический оператор предложения запроса рабочего элемента.

Operator
Operator WorkItemFieldOperation

Операция поля рабочего элемента

Ценность
Value string

Значение предложения запроса рабочего элемента.

WorkItemFieldReference

Справочник по полю рабочего элемента

Имя Путь Тип Описание
Имя
Name string

Имя ссылки на поле рабочего элемента.

Имя ссылки
ReferenceName string

Имя ссылки на поле рабочего элемента.

URL
Url string

URL-адрес ссылки на поле рабочего элемента.

WorkItemQuerySortColumn

Столбец сортировки запросов рабочих элементов

Имя Путь Тип Описание
Descending
Descending boolean

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

Поле
Field WorkItemFieldReference

Справочник по полю рабочего элемента

WorkItemField

Поле рабочего элемента

Имя Путь Тип Описание
Имя
Name string

Отображаемое имя поля рабочего элемента.

Только для чтения
ReadOnly boolean

Указывает, доступно ли поле только для чтения.

Идентичность
IsIdentity boolean

Указывает, содержит ли поле сведения об удостоверениях.

Список выбора
IsPicklist boolean

Указывает, использует ли поле список выбора.

Имя ссылки
ReferenceName string

Имя ссылки поля рабочего элемента.

Description
Description string

Описание поля рабочего элемента.

Поддерживаемые операции
SupportedOperations array of WorkItemFieldOperation

Список операций, поддерживаемых полем.

Тип
Type string

Тип данных поля рабочего элемента.

URL
Url string

URL-адрес поля рабочего элемента.

WorkItemFieldOperation

Операция поля рабочего элемента

Имя Путь Тип Описание
Имя
Name string

Имя операции поля рабочего элемента.

Имя ссылки
ReferenceName string

Имя ссылки для операции поля рабочего элемента.

Pipeline

Имя Путь Тип Описание
count
count integer

count

value
value array of object

Массив, имеющий список всех конвейеров

href
value._links.self.href string

href

href
value._links.web.href string

href

folder
value.folder string

folder

id
value.id integer

id

имя
value.name string

имя

ревизия
value.revision integer

ревизия

URL-адрес
value.url string

URL-адрес

Run

Имя Путь Тип Описание
count
count integer

count

value
value array of object

Прогон конвейера

href
value._links.self.href string
href
value._links.web.href string
href
value._links.pipeline.web.href string
href
value._links.pipeline.href string
URL-адрес
value.pipeline.url string
id
value.pipeline.id integer
ревизия
value.pipeline.revision integer
имя
value.pipeline.name string
folder
value.pipeline.folder string
государство
value.state RunState

Состояние выполнения

дата создания
value.createdDate string

дата создания

URL-адрес
value.url string

URL-адрес конвейера

id
value.id integer

Идентификатор конвейера

имя
value.name string

имя

результат
value.result RunResult

Результат выполнения

Готовоеdate
value.finishedDate string

Дата завершения выполнения

RunResult

Результат выполнения

Результат выполнения

RunState

Состояние выполнения

Состояние выполнения