GitRestClient class

Пакет:: azure-devops-extension-api

Базовый класс, который должен использоваться (производный от) для выполнения запросов к REST API VSS

Extends: RestClientBase

Конструкторы

Свойства

Методы

createAnnotatedTag(GitAnnotatedTag, string, string)	Создайте помеченный тег.
createAttachment(any, string, string, number, string)	Вложите новый файл в запрос на вытягивание.
createCherryPick(GitAsyncRefOperationParameters, string, string)	Вишня выбирает определенную фиксацию или фиксации, связанные с запросом на вытягивание в новую ветвь.
createComment(Comment, string, number, number, string)	Создайте комментарий для определенного потока в запросе на вытягивание (на поток можно создать до 500 комментариев).
createCommitStatus(GitStatus, string, string, string)	Создание состояния фиксации Git.
createFavorite(GitRefFavorite, string)	Создает избранное ссылки
createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)	Запросите, чтобы ссылка другого репозитория была возвращена в эту. Он синхронизирует две существующие вилки. Чтобы создать форк, пожалуйста, см. <a href="https://docs.microsoft.com/en-us/rest/api/vsts/git/repositories/create?view=azure-devops-rest-5.1" > репозитории endpoint</a>
createImportRequest(GitImportRequest, string, string)	Создайте запрос импорта.
createLike(string, number, number, number, string)	Добавьте подобный комментарий.
createMergeRequest(GitMergeParameters, string, string, boolean)	Запрос операции слияния Git. В настоящее время мы поддерживаем объединение только 2 фиксации.
createPullRequest(GitPullRequest, string, string, boolean)	Создайте запрос на вытягивание.
createPullRequestIterationStatus(GitPullRequestStatus, string, number, number, string)	Создайте состояние запроса на вытягивание в итерации. Эта операция будет иметь тот же результат, что и состояние создания запроса на вытягивание с указанным идентификатором итерации в тексте запроса.
createPullRequestLabel(WebApiCreateTagRequestData, string, number, string, string)	Создайте тег (если это еще не существует) и добавьте его как метку (тег) для указанного запроса на вытягивание. Единственное обязательное поле — имя новой метки (тега).
createPullRequestReviewer(IdentityRefWithVote, string, number, string, string)	Добавьте рецензента в запрос на вытягивание или приведение голоса.
createPullRequestReviewers(IdentityRef[], string, number, string)	Добавьте рецензентов в запрос на вытягивание.
createPullRequestStatus(GitPullRequestStatus, string, number, string)	Создайте состояние запроса на вытягивание.
createPush(GitPush, string, string)	Отправка изменений в репозиторий.
createRepository(GitRepositoryCreateOptions, string, string)	Создайте git-репозиторий в командной project.
createRevert(GitAsyncRefOperationParameters, string, string)	Запускает операцию, чтобы создать новую ветвь, которая отменяет изменения, внесенные определенным фиксацией или фиксацией, связанными с запросом на вытягивание.
createThread(GitPullRequestCommentThread, string, number, string)	Создайте поток в запросе на вытягивание.
createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)	Добавьте нематериализованное удостоверение рецензентам запроса на вытягивание.
deleteAttachment(string, string, number, string)	Удаление вложения запроса на вытягивание.
deleteComment(string, number, number, number, string)	Удалите комментарий, связанный с определенным потоком в запросе на вытягивание.
deleteEnablementStatus(boolean, boolean, string[])	DELETE Удаляет состояние включения и данные BillableCommitters из базы данных. Удаление данных включения будет эффективно отключать его для затронутых репозиториев.
deleteLike(string, number, number, number, string)	Удалите подобный комментарий.
deletePullRequestIterationStatus(string, number, number, number, string)	Удаление состояния итерации запроса на вытягивание.
deletePullRequestLabels(string, number, string, string, string)	Удаляет метку (тег) из набора назначенных запросу на вытягивание. Сам тег не будет удален.
deletePullRequestReviewer(string, number, string, string)	Удалите рецензента из запроса на вытягивание.
deletePullRequestStatus(string, number, number, string)	Удаление состояния запроса на вытягивание.
deleteRefFavorite(string, number)	Удаляет избранное ссылки
deleteRepository(string, string)	Удаление репозитория Git
deleteRepositoryFromRecycleBin(string, string)	Уничтожить (жесткое удаление) обратимо удаленный репозиторий Git.
getAccessibleRepositories(GetAccessibleRepositoriesRequest)	POST-запрос на получение доступных репозиториев на основе разрешения (пакетная операция).
getAnnotatedTag(string, string, string)	Получите помеченный тег.
getAttachmentContent(string, string, number, string)	Получение содержимого файла вложения запроса на вытягивание.
getAttachments(string, number, string)	Получите список файлов, присоединенных к заданному запросу на вытягивание.
getAttachmentZip(string, string, number, string)	Получение содержимого файла вложения запроса на вытягивание.
getBillableCommitters(string, Date, number, number)	Получение фактических оплачиваемых фиксаций для расширенной службы безопасности для заданной даты.
getBillableCommittersDetail(string, string, Date)	Получение подробных фактических оплачиваемых фиксаций для расширенной службы безопасности для заданной даты. Подробные результаты намеренно не фильтруют обратимые удаленные проекты и репозитории для диагностики проблем с выставлением счетов.
getBlob(string, string, string, boolean, string, boolean)	Получение одного большого двоичного объекта.
getBlobContent(string, string, string, boolean, string, boolean)	Получение одного большого двоичного объекта.
getBlobsZip(string[], string, string, string)	Возвращает один или несколько больших двоичных объектов в скачивание ZIP-файла.
getBlobZip(string, string, string, boolean, string, boolean)	Получение одного большого двоичного объекта.
getBranch(string, string, string, GitVersionDescriptor)	Получение статистики о одной ветви.
getBranches(string, string, GitVersionDescriptor)	Получение статистики обо всех ветвях в репозитории.
getBranchStatsBatch(GitQueryBranchStatsCriteria, string, string)	Получение статистики для нескольких фиксаций
getChanges(string, string, string, number, number)	Получение изменений для конкретной фиксации.
getCherryPick(string, number, string)	Получение сведений об операции выбора вишни по идентификатору выбора вишни.
getCherryPickConflict(string, number, number, string)	Получение одного конфликта для выбора вишни по идентификатору
getCherryPickConflicts(string, number, string, string, number, boolean, boolean, boolean)	Получение всех конфликтов для выбора вишни
getCherryPickForRefName(string, string, string)	Получение сведений об операции выбора вишни для определенной ветви. Эта операция является дорогой из-за базовой структуры объектов, поэтому этот API смотрит только на 1000 последних операций выбора вишни.
getCherryPickRelationships(string, string, string, boolean)	При наличии commitId возвращает список фиксаций, которые находятся в той же семье вишневого выбора.
getComment(string, number, number, number, string)	Получение комментария, связанного с определенным потоком в запросе на вытягивание.
getComments(string, number, number, string)	Извлеките все комментарии, связанные с определенным потоком в запросе на вытягивание.
getCommit(string, string, string, number)	Получение определенной фиксации.
getCommitDiffs(string, string, boolean, number, number, GitBaseVersionDescriptor, GitTargetVersionDescriptor)	Найдите ближайшую общую фиксацию (базу слияния) между базовыми и целевыми фиксациями и получите дифф между базовыми и целевыми фиксациями или общими и целевыми фиксациями.
getCommits(string, GitQueryCommitsCriteria, string)	Retrieve git commit for a project
getCommitsBatch(GitQueryCommitsCriteria, string, string, number, number, boolean)	Получить git-коммиты для project, соответствующего критериям поиска
getDeletedRepositories(string)	Получение удаленных репозиториев Git.
getEnablementStatus(string[], Date, number, number)	GET статус Enablement для репозиториев project.
getEnableOnCreateHost(boolean)
getEnableOnCreateProject(string)
getEstimatedBillableCommittersRepo(string, string)	Получение предполагаемых оплачиваемых фиксаций для репозитория за последние 90 дней.
getEstimatedBillablePushersOrg()	Получение предполагаемых оплачиваемых push-уведомлений для организации за последние 90 дней.
getEstimatedBillablePushersProject(string)	Получите оценочные оплачиваемые pushers за project за последние 90 дней.
getFileDiffs(FileDiffsCriteria, string, string)	Получение диффов файлов для каждого из указанных файлов
getForks(string, string, string, boolean)	Извлеките все вилки репозитория в коллекции.
getForkSyncRequest(string, number, string, boolean)	Получение сведений о конкретной операции синхронизации вилки.
getForkSyncRequests(string, string, boolean, boolean)	Получение всех запрошенных операций синхронизации вилки в этом репозитории.
getHfsItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Получение метаданных элементов и (или) содержимого для одного элемента. Параметр скачивания заключается в том, чтобы указать, должно ли содержимое быть доступным как скачивание или просто отправлено в виде потока в ответе. Не применяется к архивам содержимого, которое всегда возвращается в качестве скачивания.
getHfsItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Получение метаданных элементов и (или) содержимого для одного элемента. Параметр скачивания заключается в том, чтобы указать, должно ли содержимое быть доступным как скачивание или просто отправлено в виде потока в ответе. Не применяется к архивам содержимого, которое всегда возвращается в качестве скачивания.
getHfsItems(string, string, string, VersionControlRecursionType, boolean, boolean, boolean, boolean, GitVersionDescriptor, boolean)	Получение метаданных и/или содержимого элемента для коллекции элементов. Параметр скачивания заключается в том, чтобы указать, должно ли содержимое быть доступным как скачивание или просто отправлено в виде потока в ответе. Не применяется к zippped содержимому, которое всегда возвращается в качестве скачивания.
getHfsItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Получение метаданных элементов и (или) содержимого для одного элемента. Параметр скачивания заключается в том, чтобы указать, должно ли содержимое быть доступным как скачивание или просто отправлено в виде потока в ответе. Не применяется к архивам содержимого, которое всегда возвращается в качестве скачивания.
getHfsItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Получение метаданных элементов и (или) содержимого для одного элемента. Параметр скачивания заключается в том, чтобы указать, должно ли содержимое быть доступным как скачивание или просто отправлено в виде потока в ответе. Не применяется к архивам содержимого, которое всегда возвращается в качестве скачивания.
getImportRequest(string, string, number)	Получение определенного запроса на импорт.
getItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Получение метаданных элементов и (или) содержимого для одного элемента. Параметр скачивания заключается в том, чтобы указать, должно ли содержимое быть доступным как скачивание или просто отправлено в виде потока в ответе. Не применяется к архивам содержимого, которое всегда возвращается в качестве скачивания.
getItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Получение метаданных элементов и (или) содержимого для одного элемента. Параметр скачивания заключается в том, чтобы указать, должно ли содержимое быть доступным как скачивание или просто отправлено в виде потока в ответе. Не применяется к архивам содержимого, которое всегда возвращается в качестве скачивания.
getItems(string, string, string, VersionControlRecursionType, boolean, boolean, boolean, boolean, GitVersionDescriptor, boolean)	Получение метаданных и/или содержимого элемента для коллекции элементов. Параметр скачивания заключается в том, чтобы указать, должно ли содержимое быть доступным как скачивание или просто отправлено в виде потока в ответе. Не применяется к zippped содержимому, которое всегда возвращается в качестве скачивания.
getItemsBatch(GitItemRequestData, string, string)	Получает набор элементов из репозитория / project для заданного списка путей или длинного пути
getItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Получение метаданных элементов и (или) содержимого для одного элемента. Параметр скачивания заключается в том, чтобы указать, должно ли содержимое быть доступным как скачивание или просто отправлено в виде потока в ответе. Не применяется к архивам содержимого, которое всегда возвращается в качестве скачивания.
getItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Получение метаданных элементов и (или) содержимого для одного элемента. Параметр скачивания заключается в том, чтобы указать, должно ли содержимое быть доступным как скачивание или просто отправлено в виде потока в ответе. Не применяется к архивам содержимого, которое всегда возвращается в качестве скачивания.
getLikes(string, number, number, number, string)	Получите нравится для комментария.
getMergeBases(string, string, string, string, string, string)	Найдите базы слиянием двух фиксаций, при необходимости в разных вилках. Если другой идентификаторRepositoryId не указан, базы слияния будут вычисляться только в контексте локального репозиторияNameOrId.
getMergeRequest(string, string, number, boolean)	Получение сведений о конкретной операции слияния.
getPermission(string, string, string)	Получение состояния расширенного разрешения безопасности.
getPullRequest(string, number, string, number, number, number, boolean, boolean)	Получение запроса на вытягивание.
getPullRequestById(number, string)	Получение запроса на вытягивание.
getPullRequestCommits(string, number, string)	Получите фиксации для указанного запроса на вытягивание.
getPullRequestConflict(string, number, number, string)	Получение одного конфликта для запроса на вытягивание по идентификатору
getPullRequestConflicts(string, number, string, number, number, boolean, boolean, boolean)	Получение всех конфликтов для запроса на вытягивание
getPullRequestIteration(string, number, number, string)	Получите указанную итерацию для запроса на вытягивание.
getPullRequestIterationChanges(string, number, number, string, number, number, number)	Извлеките изменения, внесенные в запрос на вытягивание между двумя итерациями.
getPullRequestIterationCommits(string, number, number, string, number, number)	Получите фиксации для указанной итерации запроса на вытягивание.
getPullRequestIterations(string, number, string, boolean)	Получите список итераций для указанного запроса на вытягивание.
getPullRequestIterationStatus(string, number, number, number, string)	Получение определенного состояния итерации запроса на вытягивание по идентификатору. Идентификатор состояния является уникальным в запросе на вытягивание во всех итерациях.
getPullRequestIterationStatuses(string, number, number, string)	Получение всех состояний, связанных с итерацией запроса на вытягивание.
getPullRequestLabel(string, number, string, string, string)	Извлекает одну метку (тег), назначенную запросу на вытягивание.
getPullRequestLabels(string, number, string, string)	Получите все метки (теги), назначенные запросу на вытягивание.
getPullRequestProperties(string, number, string)	Получение внешних свойств запроса на вытягивание.
getPullRequestQuery(GitPullRequestQuery, string, string)	Этот API используется для поиска запросов на вытягивание, связанных с данной фиксацией. Его можно использовать для поиска запроса на вытягивание, создавшего определенную фиксацию слияния, или его можно использовать для поиска всех запросов на вытягивание, которые когда-либо объединили определенную фиксацию. Входные данные — это список запросов, каждый из которых содержит список фиксаций. Для каждой фиксации, которую выполняется поиск, вы получите словарь фиксации — запросы на вытягивание.
getPullRequestReviewer(string, number, string, string)	Получение сведений о конкретном рецензентах по запросу на вытягивание
getPullRequestReviewers(string, number, string)	Получение рецензентов для запроса на вытягивание
getPullRequests(string, GitPullRequestSearchCriteria, string, number, number, number)	Извлеките все запросы на вытягивание, соответствующие указанному критерию.
getPullRequestsByProject(string, GitPullRequestSearchCriteria, number, number, number)	Извлеките все запросы на вытягивание, соответствующие указанному критерию.
getPullRequestStatus(string, number, number, string)	Получение определенного состояния запроса на вытягивание по идентификатору. Идентификатор состояния является уникальным в запросе на вытягивание во всех итерациях.
getPullRequestStatuses(string, number, string)	Получите все состояния, связанные с запросом на вытягивание.
getPullRequestThread(string, number, number, string, number, number)	Получение потока в запросе на вытягивание.
getPullRequestWorkItemRefs(string, number, string)	Получение списка рабочих элементов, связанных с запросом на вытягивание.
getPush(string, number, string, number, boolean)	Извлекает определенную отправку.
getPushCommits(string, number, string, number, number, boolean)	Получение списка фиксаций, связанных с определенной отправкой.
getPushes(string, string, number, number, GitPushSearchCriteria)	Извлекает push-уведомления, связанные с указанным репозиторием.
getRecycleBinRepositories(string)	Получение обратимо удаленных репозиториев Git из корзины.
getRefFavorite(string, number)	Возвращает ссылку на избранное для избранного идентификатора.
getRefFavorites(string, string, string)	Возвращает избранное ссылок для репозитория и удостоверения.
getRefFavoritesForProject(string, string)
getRefs(string, string, string, boolean, boolean, boolean, boolean, boolean, string, boolean)	Запрашивает предоставленный репозиторий для его ссылок и возвращает их.
getRepositories(string, boolean, boolean, boolean)	Получение репозиториев Git.
getRepositoriesPaged(string, boolean, boolean, boolean, string, number, string)	Извлеките репозитории Git с фильтром по имени и разбиению на страницы.
getRepository(string, string)	Получение репозитория Git.
getRepositoryWithParent(string, boolean, string)	Получение репозитория Git.
getRevert(string, number, string)	Получение сведений об операции восстановления путем возврата идентификатора.
getRevertConflict(string, number, number, string)	Получение одного конфликта для возврата по идентификатору
getRevertConflicts(string, number, string, string, number, boolean, boolean, boolean)	Получение всех конфликтов для возврата
getRevertForRefName(string, string, string)	Получение сведений об операции восстановления для определенной ветви.
getStatuses(string, string, string, number, number, boolean)	Получение состояний, связанных с фиксацией Git.
getSuggestions(string, string, boolean)	Получите предложение pull request-запроса для конкретного репозитория или командного project.
getThreads(string, number, string, number, number)	Извлеките все потоки в запросе на вытягивание.
getTree(string, string, string, string, boolean, string)	Конечная точка "Дерево" возвращает коллекцию объектов под указанным деревом. Деревья — это папки в репозитории Git.
getTreeZip(string, string, string, string, boolean, string)	Конечная точка "Дерево" возвращает коллекцию объектов под указанным деревом. Деревья — это папки в репозитории Git.
queryImportRequests(string, string, boolean)	Получение запросов импорта для репозитория.
restoreRepositoryFromRecycleBin(GitRecycleBinRepositoryDetails, string, string)	Восстановите обратимо удаленный репозиторий Git. Недавно удаленные репозитории попадают в состояние обратимого удаления в течение определенного периода времени, прежде чем они будут удалены и становятся невосстановимыми.
setEnableOnCreateHost(boolean)
setEnableOnCreateProject(string, boolean)
sharePullRequest(ShareNotificationContext, string, number, string)	Отправляет уведомление по электронной почте о конкретном запросе на вытягивание набору получателей
updateCherryPickConflict(GitConflict, string, number, number, string)	Обновление разрешения конфликтов слиянием
updateCherryPickConflicts(GitConflict[], string, number, string)	Обновление нескольких разрешений конфликтов слиянием
updateComment(Comment, string, number, number, number, string)	Обновите комментарий, связанный с определенным потоком в запросе на вытягивание.
updateEnablementStatus(AdvSecEnablementUpdate[])	Состояние включения POST для репозиториев.
updateImportRequest(GitImportRequest, string, string, number)	Повторите или отказаться от неудачного запроса на импорт.
updatePullRequest(GitPullRequest, string, number, string)	Обновление запроса на вытягивание
updatePullRequestConflict(GitConflict, string, number, number, string)	Обновление разрешения конфликтов слиянием
updatePullRequestConflicts(GitConflict[], string, number, string)	Обновление нескольких разрешений конфликтов слиянием
updatePullRequestIterationStatuses(JsonPatchDocument, string, number, number, string)	Обновление коллекции состояний итерации запроса на вытягивание. Единственным поддерживаемым типом операции является .
updatePullRequestProperties(JsonPatchDocument, string, number, string)	Создание или обновление внешних свойств запроса на вытягивание. Операция исправления может быть , или . Для операции путь может быть пустым. Если путь пуст, значение должно быть списком пар значений ключей. Для операции путь не может быть пустым. Если путь не существует, свойство будет добавлено в коллекцию. Для операции путь не может быть пустым. Если путь не существует, действие не будет выполнено.
updatePullRequestReviewer(IdentityRefWithVote, string, number, string, string)	Изменение записи рецензента. Эти поля доступны для исправления: isFlagged, hasDeclined
updatePullRequestReviewers(IdentityRefWithVote[], string, number, string)	Сброс голосов нескольких рецензентов по запросу на вытягивание. ПРИМЕЧАНИЕ. Эта конечная точка поддерживает только обновление голосов, но не поддерживает обновление необходимых рецензентов (использование политики) или отображаемых имен.
updatePullRequestStatuses(JsonPatchDocument, string, number, string)	Обновление коллекции состояний запроса на вытягивание. Единственным поддерживаемым типом операции является .
updateRef(GitRefUpdate, string, string, string, string)	Блокировка или разблокировка ветви.
updateRefs(GitRefUpdate[], string, string, string)	Создание, обновление или удаление ссылок (ветвей).
updateRepository(GitRepository, string, string)	Обновляет репозиторий Git с новым именем репозитория или новой ветвью по умолчанию.
updateRevertConflict(GitConflict, string, number, number, string)	Обновление разрешения конфликтов слиянием
updateRevertConflicts(GitConflict[], string, number, string)	Обновление нескольких разрешений конфликтов слиянием
updateThread(GitPullRequestCommentThread, string, number, number, string)	Обновите поток в запросе на вытягивание.

Сведения о конструкторе

GitRestClient(IVssRestClientOptions)

new GitRestClient(options: IVssRestClientOptions)

Параметры

options: IVssRestClientOptions

Сведения о свойстве

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Значение свойства

string

Сведения о методе

createAnnotatedTag(GitAnnotatedTag, string, string)

Создайте помеченный тег.

function createAnnotatedTag(tagObject: GitAnnotatedTag, project: string, repositoryId: string): Promise<GitAnnotatedTag>

Параметры

tagObject: GitAnnotatedTag

Объект, содержащий сведения о теге, который необходимо создать.

project: string

Project ID или название project

repositoryId: string

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

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

Promise<GitAnnotatedTag>

createAttachment(any, string, string, number, string)

Вложите новый файл в запрос на вытягивание.

function createAttachment(content: any, fileName: string, repositoryId: string, pullRequestId: number, project?: string): Promise<Attachment>

Параметры

content: any

Содержимое для отправки

fileName: string

Имя файла.

repositoryId: string

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

pullRequestId: number

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

project: string

Project ID или название project

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

Promise<Attachment>

createCherryPick(GitAsyncRefOperationParameters, string, string)

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

function createCherryPick(cherryPickToCreate: GitAsyncRefOperationParameters, project: string, repositoryId: string): Promise<GitCherryPick>

Параметры

cherryPickToCreate: GitAsyncRefOperationParameters

project: string

Project ID или название project

repositoryId: string

Идентификатор репозитория.

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

Promise<GitCherryPick>

createComment(Comment, string, number, number, string)

Создайте комментарий для определенного потока в запросе на вытягивание (на поток можно создать до 500 комментариев).

function createComment(comment: Comment, repositoryId: string, pullRequestId: number, threadId: number, project?: string): Promise<Comment>

Параметры

comment: Comment

Комментарий для создания. Примечания могут составлять до 150 000 символов.

repositoryId: string

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

pullRequestId: number

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

threadId: number

Идентификатор потока, в который входит нужный комментарий.

project: string

Project ID или название project

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

Promise<Comment>

createCommitStatus(GitStatus, string, string, string)

Создание состояния фиксации Git.

function createCommitStatus(gitCommitStatusToCreate: GitStatus, commitId: string, repositoryId: string, project?: string): Promise<GitStatus>

Параметры

gitCommitStatusToCreate: GitStatus

Объект состояния фиксации Git для создания.

commitId: string

Идентификатор фиксации Git.

repositoryId: string

Идентификатор репозитория.

project: string

Project ID или название project

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

Promise<GitStatus>

createFavorite(GitRefFavorite, string)

Создает избранное ссылки

function createFavorite(favorite: GitRefFavorite, project: string): Promise<GitRefFavorite>

Параметры

favorite: GitRefFavorite

Избранное ссылки для создания.

project: string

Project ID или название project

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

Promise<GitRefFavorite>

createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)

Запросите, чтобы ссылка другого репозитория была возвращена в эту. Он синхронизирует две существующие вилки. Чтобы создать форк, пожалуйста, см. <a href="https://docs.microsoft.com/en-us/rest/api/vsts/git/repositories/create?view=azure-devops-rest-5.1" > репозитории endpoint</a>

function createForkSyncRequest(syncParams: GitForkSyncRequestParameters, repositoryNameOrId: string, project?: string, includeLinks?: boolean): Promise<GitForkSyncRequest>

Параметры

syncParams: GitForkSyncRequestParameters

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

repositoryNameOrId: string

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

project: string

Project ID или название project

includeLinks: boolean

Значение true для включения ссылок

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

Promise<GitForkSyncRequest>

createImportRequest(GitImportRequest, string, string)

Создайте запрос импорта.

function createImportRequest(importRequest: GitImportRequest, project: string, repositoryId: string): Promise<GitImportRequest>

Параметры

importRequest: GitImportRequest

Запрос импорта для создания.

project: string

Project ID или название project

repositoryId: string

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

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

Promise<GitImportRequest>

createLike(string, number, number, number, string)

Добавьте подобный комментарий.

function createLike(repositoryId: string, pullRequestId: number, threadId: number, commentId: number, project?: string): Promise<void>

Параметры

repositoryId: string

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

pullRequestId: number

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

threadId: number

Идентификатор потока, содержащего комментарий.

commentId: number

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

project: string

Project ID или название project

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

Promise<void>

createMergeRequest(GitMergeParameters, string, string, boolean)

Запрос операции слияния Git. В настоящее время мы поддерживаем объединение только 2 фиксации.

function createMergeRequest(mergeParameters: GitMergeParameters, project: string, repositoryNameOrId: string, includeLinks?: boolean): Promise<GitMerge>

Параметры

mergeParameters: GitMergeParameters

Родители фиксируют Идентификаторы и слияние фиксации беспорядок.

project: string

Project ID или название project

repositoryNameOrId: string

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

includeLinks: boolean

Значение true для включения ссылок

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

Promise<GitMerge>

createPullRequest(GitPullRequest, string, string, boolean)

Создайте запрос на вытягивание.

function createPullRequest(gitPullRequestToCreate: GitPullRequest, repositoryId: string, project?: string, supportsIterations?: boolean): Promise<GitPullRequest>

Параметры

gitPullRequestToCreate: GitPullRequest

Запрос на вытягивание для создания.

repositoryId: string

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

project: string

Project ID или название project

supportsIterations: boolean

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

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

Promise<GitPullRequest>

createPullRequestIterationStatus(GitPullRequestStatus, string, number, number, string)

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

function createPullRequestIterationStatus(status: GitPullRequestStatus, repositoryId: string, pullRequestId: number, iterationId: number, project?: string): Promise<GitPullRequestStatus>

Параметры

status: GitPullRequestStatus

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

repositoryId: string

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

pullRequestId: number

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

iterationId: number

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

project: string

Project ID или название project

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

Promise<GitPullRequestStatus>

createPullRequestLabel(WebApiCreateTagRequestData, string, number, string, string)

Создайте тег (если это еще не существует) и добавьте его как метку (тег) для указанного запроса на вытягивание. Единственное обязательное поле — имя новой метки (тега).

function createPullRequestLabel(label: WebApiCreateTagRequestData, repositoryId: string, pullRequestId: number, project?: string, projectId?: string): Promise<WebApiTagDefinition>

Параметры

label: WebApiCreateTagRequestData

Метка для назначения запросу на вытягивание.

repositoryId: string

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

pullRequestId: number

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

project: string

Project ID или название project

projectId: string

Project ID или название project.

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

Promise<WebApiTagDefinition>

createPullRequestReviewer(IdentityRefWithVote, string, number, string, string)

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

function createPullRequestReviewer(reviewer: IdentityRefWithVote, repositoryId: string, pullRequestId: number, reviewerId: string, project?: string): Promise<IdentityRefWithVote>

Параметры

reviewer: IdentityRefWithVote

Голосование рецензента.br /Если идентификатор рецензента включен здесь, он должен соответствовать параметру рецензента.br /Рецензенты могут задать свой собственный голос с помощью этого метода. При добавлении других рецензентов голосование должно быть равно нулю.

repositoryId: string

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

pullRequestId: number

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

reviewerId: string

Идентификатор рецензента.

project: string

Project ID или название project

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

Promise<IdentityRefWithVote>

createPullRequestReviewers(IdentityRef[], string, number, string)

Добавьте рецензентов в запрос на вытягивание.

function createPullRequestReviewers(reviewers: IdentityRef[], repositoryId: string, pullRequestId: number, project?: string): Promise<IdentityRefWithVote[]>

Параметры

reviewers: IdentityRef[]

Рецензенты для добавления в запрос на вытягивание.

repositoryId: string

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

pullRequestId: number

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

project: string

Project ID или название project

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

Promise<IdentityRefWithVote[]>

createPullRequestStatus(GitPullRequestStatus, string, number, string)

Создайте состояние запроса на вытягивание.

function createPullRequestStatus(status: GitPullRequestStatus, repositoryId: string, pullRequestId: number, project?: string): Promise<GitPullRequestStatus>

Параметры

status: GitPullRequestStatus

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

repositoryId: string

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

pullRequestId: number

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

project: string

Project ID или название project

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

Promise<GitPullRequestStatus>

createPush(GitPush, string, string)

Отправка изменений в репозиторий.

function createPush(push: GitPush, repositoryId: string, project?: string): Promise<GitPush>

Параметры

push: GitPush

repositoryId: string

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

project: string

Project ID или название project

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

Promise<GitPush>

createRepository(GitRepositoryCreateOptions, string, string)

Создайте git-репозиторий в командной project.

function createRepository(gitRepositoryToCreate: GitRepositoryCreateOptions, project?: string, sourceRef?: string): Promise<GitRepository>

Параметры

gitRepositoryToCreate: GitRepositoryCreateOptions

Укажите имя репозитория, project команды и/или родительский репозиторий. Информация о командном проекте может быть опущена в gitRepositoryToCreate, если запрос ограничен project-scope (то есть включает project Id).

project: string

Project ID или название project

sourceRef: string

[необязательно] Укажите исходные ссылки для использования при создании репозитория вилки

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

Promise<GitRepository>

createRevert(GitAsyncRefOperationParameters, string, string)

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

function createRevert(revertToCreate: GitAsyncRefOperationParameters, project: string, repositoryId: string): Promise<GitRevert>

Параметры

revertToCreate: GitAsyncRefOperationParameters

project: string

Project ID или название project

repositoryId: string

Идентификатор репозитория.

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

Promise<GitRevert>

createThread(GitPullRequestCommentThread, string, number, string)

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

function createThread(commentThread: GitPullRequestCommentThread, repositoryId: string, pullRequestId: number, project?: string): Promise<GitPullRequestCommentThread>

Параметры

commentThread: GitPullRequestCommentThread

Поток для создания. Поток должен содержать хотя бы один комментарий.

repositoryId: string

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

pullRequestId: number

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

project: string

Project ID или название project

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

Promise<GitPullRequestCommentThread>

createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)

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

function createUnmaterializedPullRequestReviewer(reviewer: IdentityRefWithVote, repositoryId: string, pullRequestId: number, project?: string): Promise<IdentityRefWithVote>

Параметры

reviewer: IdentityRefWithVote

Рецензент, добавляемый в запрос на вытягивание.

repositoryId: string

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

pullRequestId: number

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

project: string

Project ID или название project

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

Promise<IdentityRefWithVote>

deleteAttachment(string, string, number, string)

Удаление вложения запроса на вытягивание.

function deleteAttachment(fileName: string, repositoryId: string, pullRequestId: number, project?: string): Promise<void>

Параметры

fileName: string

Имя удаления вложения.

repositoryId: string

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

pullRequestId: number

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

project: string

Project ID или название project

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

Promise<void>

deleteComment(string, number, number, number, string)

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

function deleteComment(repositoryId: string, pullRequestId: number, threadId: number, commentId: number, project?: string): Promise<void>

Параметры

repositoryId: string

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

pullRequestId: number

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

threadId: number

Идентификатор потока, в который входит нужный комментарий.

commentId: number

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

project: string

Project ID или название project

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

Promise<void>

deleteEnablementStatus(boolean, boolean, string[])

DELETE Удаляет состояние включения и данные BillableCommitters из базы данных. Удаление данных включения будет эффективно отключать его для затронутых репозиториев.

function deleteEnablementStatus(allProjects: boolean, includeBillableCommitters?: boolean, projectIds?: string[]): Promise<void>

Параметры

allProjects: boolean

includeBillableCommitters: boolean

projectIds: string[]

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

Promise<void>

deleteLike(string, number, number, number, string)

Удалите подобный комментарий.

function deleteLike(repositoryId: string, pullRequestId: number, threadId: number, commentId: number, project?: string): Promise<void>

Параметры

repositoryId: string

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

pullRequestId: number

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

threadId: number

Идентификатор потока, содержащего комментарий.

commentId: number

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

project: string

Project ID или название project

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

Promise<void>

deletePullRequestIterationStatus(string, number, number, number, string)

Удаление состояния итерации запроса на вытягивание.

function deletePullRequestIterationStatus(repositoryId: string, pullRequestId: number, iterationId: number, statusId: number, project?: string): Promise<void>

Параметры

repositoryId: string

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

pullRequestId: number

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

iterationId: number

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

statusId: number

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

project: string

Project ID или название project

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

Promise<void>

deletePullRequestLabels(string, number, string, string, string)

Удаляет метку (тег) из набора назначенных запросу на вытягивание. Сам тег не будет удален.

function deletePullRequestLabels(repositoryId: string, pullRequestId: number, labelIdOrName: string, project?: string, projectId?: string): Promise<void>

Параметры

repositoryId: string

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

pullRequestId: number

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

labelIdOrName: string

Имя или идентификатор запрошенной метки.

project: string

Project ID или название project

projectId: string

Project ID или название project.

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

Promise<void>

deletePullRequestReviewer(string, number, string, string)

Удалите рецензента из запроса на вытягивание.

function deletePullRequestReviewer(repositoryId: string, pullRequestId: number, reviewerId: string, project?: string): Promise<void>

Параметры

repositoryId: string

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

pullRequestId: number

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

reviewerId: string

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

project: string

Project ID или название project

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

Promise<void>

deletePullRequestStatus(string, number, number, string)

Удаление состояния запроса на вытягивание.

function deletePullRequestStatus(repositoryId: string, pullRequestId: number, statusId: number, project?: string): Promise<void>

Параметры

repositoryId: string

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

pullRequestId: number

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

statusId: number

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

project: string

Project ID или название project

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

Promise<void>

deleteRefFavorite(string, number)

Удаляет избранное ссылки

function deleteRefFavorite(project: string, favoriteId: number): Promise<void>

Параметры

project: string

Project ID или название project

favoriteId: number

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

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

Promise<void>

deleteRepository(string, string)

Удаление репозитория Git

function deleteRepository(repositoryId: string, project?: string): Promise<void>

Параметры

repositoryId: string

Идентификатор репозитория.

project: string

Project ID или название project

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

Promise<void>

deleteRepositoryFromRecycleBin(string, string)

Уничтожить (жесткое удаление) обратимо удаленный репозиторий Git.

function deleteRepositoryFromRecycleBin(project: string, repositoryId: string): Promise<void>

Параметры

project: string

Project ID или название project

repositoryId: string

Идентификатор репозитория.

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

Promise<void>

getAccessibleRepositories(GetAccessibleRepositoriesRequest)

POST-запрос на получение доступных репозиториев на основе разрешения (пакетная операция).

function getAccessibleRepositories(request: GetAccessibleRepositoriesRequest): Promise<GetAccessibleRepositoriesResponse>

Параметры

request: GetAccessibleRepositoriesRequest

Запрос с разрешениями и идентификаторами репозиториев для проверки

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

Promise<GetAccessibleRepositoriesResponse>

getAnnotatedTag(string, string, string)

Получите помеченный тег.

function getAnnotatedTag(project: string, repositoryId: string, objectId: string): Promise<GitAnnotatedTag>

Параметры

project: string

Project ID или название project

repositoryId: string

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

objectId: string

ObjectId (Sha1Id) тега для получения.

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

Promise<GitAnnotatedTag>

getAttachmentContent(string, string, number, string)

Получение содержимого файла вложения запроса на вытягивание.

function getAttachmentContent(fileName: string, repositoryId: string, pullRequestId: number, project?: string): Promise<ArrayBuffer>

Параметры

fileName: string

Имя вложения.

repositoryId: string

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

pullRequestId: number

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

project: string

Project ID или название project

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

Promise<ArrayBuffer>

getAttachments(string, number, string)

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

function getAttachments(repositoryId: string, pullRequestId: number, project?: string): Promise<Attachment[]>

Параметры

repositoryId: string

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

pullRequestId: number

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

project: string

Project ID или название project

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

Promise<Attachment[]>

getAttachmentZip(string, string, number, string)

Получение содержимого файла вложения запроса на вытягивание.

function getAttachmentZip(fileName: string, repositoryId: string, pullRequestId: number, project?: string): Promise<ArrayBuffer>

Параметры

fileName: string

Имя вложения.

repositoryId: string

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

pullRequestId: number

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

project: string

Project ID или название project

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

Promise<ArrayBuffer>

getBillableCommitters(string, Date, number, number)

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

function getBillableCommitters(project: string, billingDate?: Date, skip?: number, take?: number): Promise<BillableCommitter[]>

Параметры

project: string

Project ID или название project

billingDate: Date

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

skip: number

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

take: number

Возвращает строки Y набора результатов для имитации разбиения по страницам.

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

Promise<BillableCommitter[]>

getBillableCommittersDetail(string, string, Date)

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

function getBillableCommittersDetail(project: string, includeDetails: string, billingDate?: Date): Promise<BillableCommitterDetail[]>

Параметры

project: string

Project ID или название project

includeDetails: string

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

billingDate: Date

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

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

Promise<BillableCommitterDetail[]>

getBlob(string, string, string, boolean, string, boolean)

Получение одного большого двоичного объекта.

function getBlob(repositoryId: string, sha1: string, project?: string, download?: boolean, fileName?: string, resolveLfs?: boolean): Promise<GitBlobRef>

Параметры

repositoryId: string

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

sha1: string

Хэш SHA1 файла. Вы можете получить SHA1 файла с помощью конечной точки "Git/Items/Get Item".

project: string

Project ID или название project

download: boolean

Если значение true, запрос на загрузку, а не отрисовку в браузере. Примечание. Это значение по умолчанию имеет значение true, если $format является ZIP

fileName: string

Укажите имя файла, используемое для скачивания.

resolveLfs: boolean

Если значение true, попробуйте разрешить большой двоичный объект содержимому LFS, если это файл указателя LFS. Совместим только с заголовками или типами $format

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

Promise<GitBlobRef>

getBlobContent(string, string, string, boolean, string, boolean)

Получение одного большого двоичного объекта.

function getBlobContent(repositoryId: string, sha1: string, project?: string, download?: boolean, fileName?: string, resolveLfs?: boolean): Promise<ArrayBuffer>

Параметры

repositoryId: string

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

sha1: string

Хэш SHA1 файла. Вы можете получить SHA1 файла с помощью конечной точки "Git/Items/Get Item".

project: string

Project ID или название project

download: boolean

fileName: string

Укажите имя файла, используемое для скачивания.

resolveLfs: boolean

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

Promise<ArrayBuffer>

getBlobsZip(string[], string, string, string)

Возвращает один или несколько больших двоичных объектов в скачивание ZIP-файла.

function getBlobsZip(blobIds: string[], repositoryId: string, project?: string, filename?: string): Promise<ArrayBuffer>

Параметры

blobIds: string[]

Идентификаторы BLOB-объектов (хэши SHA1), возвращаемые в ZIP-файле.

repositoryId: string

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

project: string

Project ID или название project

filename: string

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

Promise<ArrayBuffer>

getBlobZip(string, string, string, boolean, string, boolean)

Получение одного большого двоичного объекта.

function getBlobZip(repositoryId: string, sha1: string, project?: string, download?: boolean, fileName?: string, resolveLfs?: boolean): Promise<ArrayBuffer>

Параметры

repositoryId: string

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

sha1: string

Хэш SHA1 файла. Вы можете получить SHA1 файла с помощью конечной точки "Git/Items/Get Item".

project: string

Project ID или название project

download: boolean

fileName: string

Укажите имя файла, используемое для скачивания.

resolveLfs: boolean

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

Promise<ArrayBuffer>

getBranch(string, string, string, GitVersionDescriptor)

Получение статистики о одной ветви.

function getBranch(repositoryId: string, name: string, project?: string, baseVersionDescriptor?: GitVersionDescriptor): Promise<GitBranchStats>

Параметры

repositoryId: string

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

name: string

Имя ветви.

project: string

Project ID или название project

baseVersionDescriptor: GitVersionDescriptor

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

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

Promise<GitBranchStats>

getBranches(string, string, GitVersionDescriptor)

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

function getBranches(repositoryId: string, project?: string, baseVersionDescriptor?: GitVersionDescriptor): Promise<GitBranchStats[]>

Параметры

repositoryId: string

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

project: string

Project ID или название project

baseVersionDescriptor: GitVersionDescriptor

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

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

Promise<GitBranchStats[]>

getBranchStatsBatch(GitQueryBranchStatsCriteria, string, string)

Получение статистики для нескольких фиксаций

function getBranchStatsBatch(searchCriteria: GitQueryBranchStatsCriteria, repositoryId: string, project?: string): Promise<GitBranchStats[]>

Параметры

searchCriteria: GitQueryBranchStatsCriteria

Базовая фиксация и список целевых фиксаций для сравнения.

repositoryId: string

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

project: string

Project ID или название project

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

Promise<GitBranchStats[]>

getChanges(string, string, string, number, number)

Получение изменений для конкретной фиксации.

function getChanges(commitId: string, repositoryId: string, project?: string, top?: number, skip?: number): Promise<GitCommitChanges>

Параметры

commitId: string

Идентификатор фиксации.

repositoryId: string

Идентификатор или понятное имя репозитория. Чтобы использовать понятное имя, необходимо также указать projectId.

project: string

Project ID или название project

top: number

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

skip: number

Количество пропускаемых изменений.

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

Promise<GitCommitChanges>

getCherryPick(string, number, string)

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

function getCherryPick(project: string, cherryPickId: number, repositoryId: string): Promise<GitCherryPick>

Параметры

project: string

Project ID или название project

cherryPickId: number

Идентификатор вишни выбора.

repositoryId: string

Идентификатор репозитория.

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

Promise<GitCherryPick>

getCherryPickConflict(string, number, number, string)

Получение одного конфликта для выбора вишни по идентификатору

function getCherryPickConflict(repositoryId: string, cherryPickId: number, conflictId: number, project?: string): Promise<GitConflict>

Параметры

repositoryId: string

cherryPickId: number

conflictId: number

project: string

Project ID или название project

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

Promise<GitConflict>

getCherryPickConflicts(string, number, string, string, number, boolean, boolean, boolean)

Получение всех конфликтов для выбора вишни

function getCherryPickConflicts(repositoryId: string, cherryPickId: number, project?: string, continuationToken?: string, top?: number, excludeResolved?: boolean, onlyResolved?: boolean, includeObsolete?: boolean): Promise<PagedList<GitConflict>>

Параметры

repositoryId: string

cherryPickId: number

project: string

Project ID или название project

continuationToken: string

top: number

excludeResolved: boolean

onlyResolved: boolean

includeObsolete: boolean

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

Promise<PagedList<GitConflict>>

getCherryPickForRefName(string, string, string)

Получение сведений об операции выбора вишни для определенной ветви. Эта операция является дорогой из-за базовой структуры объектов, поэтому этот API смотрит только на 1000 последних операций выбора вишни.

function getCherryPickForRefName(project: string, repositoryId: string, refName: string): Promise<GitCherryPick>

Параметры

project: string

Project ID или название project

repositoryId: string

Идентификатор репозитория.

refName: string

Созданные GitAsyncRefOperationParameters создалиRefName, используемые для операции выбора вишни.

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

Promise<GitCherryPick>

getCherryPickRelationships(string, string, string, boolean)

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

function getCherryPickRelationships(repositoryNameOrId: string, commitId: string, project?: string, includeLinks?: boolean): Promise<GitCommitRef[]>

Параметры

repositoryNameOrId: string

commitId: string

project: string

Project ID или название project

includeLinks: boolean

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

Promise<GitCommitRef[]>

getComment(string, number, number, number, string)

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

function getComment(repositoryId: string, pullRequestId: number, threadId: number, commentId: number, project?: string): Promise<Comment>

Параметры

repositoryId: string

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

pullRequestId: number

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

threadId: number

Идентификатор потока, в который входит нужный комментарий.

commentId: number

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

project: string

Project ID или название project

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

Promise<Comment>

getComments(string, number, number, string)

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

function getComments(repositoryId: string, pullRequestId: number, threadId: number, project?: string): Promise<Comment[]>

Параметры

repositoryId: string

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

pullRequestId: number

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

threadId: number

Идентификатор потока.

project: string

Project ID или название project

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

Promise<Comment[]>

getCommit(string, string, string, number)

Получение определенной фиксации.

function getCommit(commitId: string, repositoryId: string, project?: string, changeCount?: number): Promise<GitCommit>

Параметры

commitId: string

Идентификатор фиксации.

repositoryId: string

Идентификатор или понятное имя репозитория. Чтобы использовать понятное имя, необходимо также указать projectId.

project: string

Project ID или название project

changeCount: number

Количество изменений, включаемых в результат.

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

Promise<GitCommit>

getCommitDiffs(string, string, boolean, number, number, GitBaseVersionDescriptor, GitTargetVersionDescriptor)

Найдите ближайшую общую фиксацию (базу слияния) между базовыми и целевыми фиксациями и получите дифф между базовыми и целевыми фиксациями или общими и целевыми фиксациями.

function getCommitDiffs(repositoryId: string, project?: string, diffCommonCommit?: boolean, top?: number, skip?: number, baseVersionDescriptor?: GitBaseVersionDescriptor, targetVersionDescriptor?: GitTargetVersionDescriptor): Promise<GitCommitDiffs>

Параметры

repositoryId: string

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

project: string

Project ID или название project

diffCommonCommit: boolean

Если задано значение true, диффайт между общими и целевыми фиксациями. Если значение false, различает между базовыми и целевыми фиксациями.

top: number

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

skip: number

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

baseVersionDescriptor: GitBaseVersionDescriptor

Дескриптор для базовой фиксации.

targetVersionDescriptor: GitTargetVersionDescriptor

Дескриптор для целевой фиксации.

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

Promise<GitCommitDiffs>

getCommits(string, GitQueryCommitsCriteria, string)

Retrieve git commit for a project

function getCommits(repositoryId: string, searchCriteria: GitQueryCommitsCriteria, project?: string): Promise<GitCommitRef[]>

Параметры

repositoryId: string

Идентификатор или понятное имя репозитория. Чтобы использовать понятное имя, необходимо также указать projectId.

searchCriteria: GitQueryCommitsCriteria

project: string

Project ID или название project

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

Promise<GitCommitRef[]>

getCommitsBatch(GitQueryCommitsCriteria, string, string, number, number, boolean)

Получить git-коммиты для project, соответствующего критериям поиска

function getCommitsBatch(searchCriteria: GitQueryCommitsCriteria, repositoryId: string, project?: string, skip?: number, top?: number, includeStatuses?: boolean): Promise<GitCommitRef[]>

Параметры

searchCriteria: GitQueryCommitsCriteria

Параметры поиска

repositoryId: string

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

project: string

Project ID или название project

skip: number

Количество фиксаций, которые нужно пропустить. Значение не может превышать 3000 000.

top: number

Максимальное количество возвращаемых фиксаций. Значение не может превышать 50 000.

includeStatuses: boolean

Значение true, чтобы включить дополнительные сведения о состоянии фиксации.

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

Promise<GitCommitRef[]>

getDeletedRepositories(string)

Получение удаленных репозиториев Git.

function getDeletedRepositories(project: string): Promise<GitDeletedRepository[]>

Параметры

project: string

Project ID или название project

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

Promise<GitDeletedRepository[]>

getEnablementStatus(string[], Date, number, number)

GET статус Enablement для репозиториев project.

function getEnablementStatus(projectIds?: string[], billingDate?: Date, skip?: number, take?: number): Promise<AdvSecEnablementStatus[]>

Параметры

projectIds: string[]

Null по умолчанию отображает все проекты в хосте, список repos статуса project возвращается

billingDate: Date

Ожидаемое значение UTC, значение NULL по умолчанию для UTCNow() может быть предоставлено для состояния точки во времени

skip: number

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

take: number

Возвращает строки Y набора результатов для имитации разбиения по страницам.

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

Promise<AdvSecEnablementStatus[]>

getEnableOnCreateHost(boolean)

function getEnableOnCreateHost(enableOnCreateHost: boolean): Promise<boolean>

Параметры

enableOnCreateHost: boolean

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

Promise<boolean>

getEnableOnCreateProject(string)

function getEnableOnCreateProject(enableOnCreateProjectId: string): Promise<boolean>

Параметры

enableOnCreateProjectId: string

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

Promise<boolean>

getEstimatedBillableCommittersRepo(string, string)

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

function getEstimatedBillableCommittersRepo(project: string, repositoryId: string): Promise<BillableCommitter[]>

Параметры

project: string

Project ID или название project

repositoryId: string

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

Promise<BillableCommitter[]>

getEstimatedBillablePushersOrg()

Получение предполагаемых оплачиваемых push-уведомлений для организации за последние 90 дней.

function getEstimatedBillablePushersOrg(): Promise<BillablePusher[]>

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

Promise<BillablePusher[]>

getEstimatedBillablePushersProject(string)

Получите оценочные оплачиваемые pushers за project за последние 90 дней.

function getEstimatedBillablePushersProject(project: string): Promise<BillablePusher[]>

Параметры

project: string

Project ID или название project

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

Promise<BillablePusher[]>

getFileDiffs(FileDiffsCriteria, string, string)

Получение диффов файлов для каждого из указанных файлов

function getFileDiffs(fileDiffsCriteria: FileDiffsCriteria, project: string, repositoryId: string): Promise<FileDiff[]>

Параметры

fileDiffsCriteria: FileDiffsCriteria

Список объектов параметров файла

project: string

Project ID или название project

repositoryId: string

Имя или идентификатор репозитория

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

Promise<FileDiff[]>

getForks(string, string, string, boolean)

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

function getForks(repositoryNameOrId: string, collectionId: string, project?: string, includeLinks?: boolean): Promise<GitRepositoryRef[]>

Параметры

repositoryNameOrId: string

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

collectionId: string

Команда project удостоверение коллекции.

project: string

Project ID или название project

includeLinks: boolean

Значение true для включения ссылок.

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

Promise<GitRepositoryRef[]>

getForkSyncRequest(string, number, string, boolean)

Получение сведений о конкретной операции синхронизации вилки.

function getForkSyncRequest(repositoryNameOrId: string, forkSyncOperationId: number, project?: string, includeLinks?: boolean): Promise<GitForkSyncRequest>

Параметры

repositoryNameOrId: string

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

forkSyncOperationId: number

OperationId запроса синхронизации.

project: string

Project ID или название project

includeLinks: boolean

Значение true для включения ссылок.

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

Promise<GitForkSyncRequest>

getForkSyncRequests(string, string, boolean, boolean)

Получение всех запрошенных операций синхронизации вилки в этом репозитории.

function getForkSyncRequests(repositoryNameOrId: string, project?: string, includeAbandoned?: boolean, includeLinks?: boolean): Promise<GitForkSyncRequest[]>

Параметры

repositoryNameOrId: string

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

project: string

Project ID или название project

includeAbandoned: boolean

Значение true для включения заброшенных запросов.

includeLinks: boolean

Значение true для включения ссылок.

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

Promise<GitForkSyncRequest[]>

getHfsItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

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

function getHfsItem(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveHfs?: boolean, sanitize?: boolean): Promise<GitItem>

Параметры

repositoryId: string

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

path: string

Путь к элементу.

project: string

Project ID или название project

scopePath: string

Область пути. Значение по умолчанию равно NULL.

recursionLevel: VersionControlRecursionType

Уровень рекурсии этого запроса. Значение по умолчанию — none, рекурсия не выполняется.

includeContentMetadata: boolean

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

latestProcessedChange: boolean

Установите значение true, чтобы включить последние изменения. Значение по умолчанию — false.

download: boolean

Задайте значение true, чтобы скачать ответ в виде файла. Значение по умолчанию — false.

versionDescriptor: GitVersionDescriptor

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

includeContent: boolean

Задайте значение true, чтобы включить содержимое элемента при запросе json. Значение по умолчанию — false.

resolveHfs: boolean

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

sanitize: boolean

Задайте значение true для очистки svg-файла и возврата его в виде изображения. Полезно только в том случае, если запрашивается svg-файл. Значение по умолчанию — false.

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

Promise<GitItem>

getHfsItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

function getHfsItemContent(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveHfs?: boolean, sanitize?: boolean): Promise<ArrayBuffer>

Параметры

repositoryId: string

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

path: string

Путь к элементу.

project: string

Project ID или название project

scopePath: string

Область пути. Значение по умолчанию равно NULL.

recursionLevel: VersionControlRecursionType

Уровень рекурсии этого запроса. Значение по умолчанию — none, рекурсия не выполняется.

includeContentMetadata: boolean

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

latestProcessedChange: boolean

Установите значение true, чтобы включить последние изменения. Значение по умолчанию — false.

download: boolean

Задайте значение true, чтобы скачать ответ в виде файла. Значение по умолчанию — false.

versionDescriptor: GitVersionDescriptor

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

includeContent: boolean

Задайте значение true, чтобы включить содержимое элемента при запросе json. Значение по умолчанию — false.

resolveHfs: boolean

sanitize: boolean

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

Promise<ArrayBuffer>

getHfsItems(string, string, string, VersionControlRecursionType, boolean, boolean, boolean, boolean, GitVersionDescriptor, boolean)

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

function getHfsItems(repositoryId: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, includeLinks?: boolean, versionDescriptor?: GitVersionDescriptor, zipForUnix?: boolean): Promise<GitItem[]>

Параметры

repositoryId: string

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

project: string

Project ID или название project

scopePath: string

Область пути. Значение по умолчанию равно NULL.

recursionLevel: VersionControlRecursionType

Уровень рекурсии этого запроса. Значение по умолчанию — none, рекурсия не выполняется.

includeContentMetadata: boolean

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

latestProcessedChange: boolean

Установите значение true, чтобы включить последние изменения. Значение по умолчанию — false.

download: boolean

Задайте значение true, чтобы скачать ответ в виде файла. Значение по умолчанию — false.

includeLinks: boolean

Задайте значение true, чтобы включить ссылки на элементы. Значение по умолчанию — false.

versionDescriptor: GitVersionDescriptor

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

zipForUnix: boolean

Задайте значение true, чтобы сохранить разрешения файлов для систем UNIX (и POSIX), таких как исполняемые файлы и символы.

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

Promise<GitItem[]>

getHfsItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

function getHfsItemText(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveHfs?: boolean, sanitize?: boolean): Promise<string>

Параметры

repositoryId: string

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

path: string

Путь к элементу.

project: string

Project ID или название project

scopePath: string

Область пути. Значение по умолчанию равно NULL.

recursionLevel: VersionControlRecursionType

Уровень рекурсии этого запроса. Значение по умолчанию — none, рекурсия не выполняется.

includeContentMetadata: boolean

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

latestProcessedChange: boolean

Установите значение true, чтобы включить последние изменения. Значение по умолчанию — false.

download: boolean

Задайте значение true, чтобы скачать ответ в виде файла. Значение по умолчанию — false.

versionDescriptor: GitVersionDescriptor

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

includeContent: boolean

Задайте значение true, чтобы включить содержимое элемента при запросе json. Значение по умолчанию — false.

resolveHfs: boolean

sanitize: boolean

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

Promise<string>

getHfsItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

function getHfsItemZip(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveHfs?: boolean, sanitize?: boolean): Promise<ArrayBuffer>

Параметры

repositoryId: string

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

path: string

Путь к элементу.

project: string

Project ID или название project

scopePath: string

Область пути. Значение по умолчанию равно NULL.

recursionLevel: VersionControlRecursionType

Уровень рекурсии этого запроса. Значение по умолчанию — none, рекурсия не выполняется.

includeContentMetadata: boolean

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

latestProcessedChange: boolean

Установите значение true, чтобы включить последние изменения. Значение по умолчанию — false.

download: boolean

Задайте значение true, чтобы скачать ответ в виде файла. Значение по умолчанию — false.

versionDescriptor: GitVersionDescriptor

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

includeContent: boolean

Задайте значение true, чтобы включить содержимое элемента при запросе json. Значение по умолчанию — false.

resolveHfs: boolean

sanitize: boolean

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

Promise<ArrayBuffer>

getImportRequest(string, string, number)

Получение определенного запроса на импорт.

function getImportRequest(project: string, repositoryId: string, importRequestId: number): Promise<GitImportRequest>

Параметры

project: string

Project ID или название project

repositoryId: string

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

importRequestId: number

Уникальный идентификатор запроса на импорт.

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

Promise<GitImportRequest>

getItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

function getItem(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveLfs?: boolean, sanitize?: boolean): Promise<GitItem>

Параметры

repositoryId: string

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

path: string

Путь к элементу.

project: string

Project ID или название project

scopePath: string

Область пути. Значение по умолчанию равно NULL.

recursionLevel: VersionControlRecursionType

Уровень рекурсии этого запроса. Значение по умолчанию — none, рекурсия не выполняется.

includeContentMetadata: boolean

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

latestProcessedChange: boolean

Установите значение true, чтобы включить последние изменения. Значение по умолчанию — false.

download: boolean

Задайте значение true, чтобы скачать ответ в виде файла. Значение по умолчанию — false.

versionDescriptor: GitVersionDescriptor

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

includeContent: boolean

Задайте значение true, чтобы включить содержимое элемента при запросе json. Значение по умолчанию — false.

resolveLfs: boolean

Задайте значение true, чтобы разрешить файлы указателя Git LFS, чтобы вернуть фактическое содержимое из Git LFS. Значение по умолчанию — false.

sanitize: boolean

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

Promise<GitItem>

getItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

function getItemContent(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveLfs?: boolean, sanitize?: boolean): Promise<ArrayBuffer>

Параметры

repositoryId: string

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

path: string

Путь к элементу.

project: string

Project ID или название project

scopePath: string

Область пути. Значение по умолчанию равно NULL.

recursionLevel: VersionControlRecursionType

Уровень рекурсии этого запроса. Значение по умолчанию — none, рекурсия не выполняется.

includeContentMetadata: boolean

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

latestProcessedChange: boolean

Установите значение true, чтобы включить последние изменения. Значение по умолчанию — false.

download: boolean

Задайте значение true, чтобы скачать ответ в виде файла. Значение по умолчанию — false.

versionDescriptor: GitVersionDescriptor

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

includeContent: boolean

Задайте значение true, чтобы включить содержимое элемента при запросе json. Значение по умолчанию — false.

resolveLfs: boolean

sanitize: boolean

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

Promise<ArrayBuffer>

getItems(string, string, string, VersionControlRecursionType, boolean, boolean, boolean, boolean, GitVersionDescriptor, boolean)

function getItems(repositoryId: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, includeLinks?: boolean, versionDescriptor?: GitVersionDescriptor, zipForUnix?: boolean): Promise<GitItem[]>

Параметры

repositoryId: string

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

project: string

Project ID или название project

scopePath: string

Область пути. Значение по умолчанию равно NULL.

recursionLevel: VersionControlRecursionType

Уровень рекурсии этого запроса. Значение по умолчанию — none, рекурсия не выполняется.

includeContentMetadata: boolean

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

latestProcessedChange: boolean

Установите значение true, чтобы включить последние изменения. Значение по умолчанию — false.

download: boolean

Задайте значение true, чтобы скачать ответ в виде файла. Значение по умолчанию — false.

includeLinks: boolean

Задайте значение true, чтобы включить ссылки на элементы. Значение по умолчанию — false.

versionDescriptor: GitVersionDescriptor

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

zipForUnix: boolean

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

Promise<GitItem[]>

getItemsBatch(GitItemRequestData, string, string)

Получает набор элементов из репозитория / project для заданного списка путей или длинного пути

function getItemsBatch(requestData: GitItemRequestData, repositoryId: string, project?: string): Promise<GitItem[][]>

Параметры

requestData: GitItemRequestData

Запрос атрибутов данных: ItemDescriptors, IncludeContentMetadata, LatestProcessedChange, IncludeLinks. ItemDescriptors: коллекция элементов для получения, включая путь, версию и уровень рекурсии. IncludeContentMetadata: следует ли включать метаданные для всех элементов LatestProcessedChange: следует ли включать неглубокий ссылочный код для фиксации последнего изменения каждого элемента. IncludeLinks: следует ли включать поле _links на мелкие ссылки.

repositoryId: string

Имя или идентификатор репозитория

project: string

Project ID или название project

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

Promise<GitItem[][]>

getItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

function getItemText(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveLfs?: boolean, sanitize?: boolean): Promise<string>

Параметры

repositoryId: string

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

path: string

Путь к элементу.

project: string

Project ID или название project

scopePath: string

Область пути. Значение по умолчанию равно NULL.

recursionLevel: VersionControlRecursionType

Уровень рекурсии этого запроса. Значение по умолчанию — none, рекурсия не выполняется.

includeContentMetadata: boolean

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

latestProcessedChange: boolean

Установите значение true, чтобы включить последние изменения. Значение по умолчанию — false.

download: boolean

Задайте значение true, чтобы скачать ответ в виде файла. Значение по умолчанию — false.

versionDescriptor: GitVersionDescriptor

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

includeContent: boolean

Задайте значение true, чтобы включить содержимое элемента при запросе json. Значение по умолчанию — false.

resolveLfs: boolean

sanitize: boolean

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

Promise<string>

getItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

function getItemZip(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveLfs?: boolean, sanitize?: boolean): Promise<ArrayBuffer>

Параметры

repositoryId: string

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

path: string

Путь к элементу.

project: string

Project ID или название project

scopePath: string

Область пути. Значение по умолчанию равно NULL.

recursionLevel: VersionControlRecursionType

Уровень рекурсии этого запроса. Значение по умолчанию — none, рекурсия не выполняется.

includeContentMetadata: boolean

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

latestProcessedChange: boolean

Установите значение true, чтобы включить последние изменения. Значение по умолчанию — false.

download: boolean

Задайте значение true, чтобы скачать ответ в виде файла. Значение по умолчанию — false.

versionDescriptor: GitVersionDescriptor

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

includeContent: boolean

Задайте значение true, чтобы включить содержимое элемента при запросе json. Значение по умолчанию — false.

resolveLfs: boolean

sanitize: boolean

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

Promise<ArrayBuffer>

getLikes(string, number, number, number, string)

Получите нравится для комментария.

function getLikes(repositoryId: string, pullRequestId: number, threadId: number, commentId: number, project?: string): Promise<IdentityRef[]>

Параметры

repositoryId: string

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

pullRequestId: number

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

threadId: number

Идентификатор потока, содержащего комментарий.

commentId: number

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

project: string

Project ID или название project

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

Promise<IdentityRef[]>

getMergeBases(string, string, string, string, string, string)

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

function getMergeBases(repositoryNameOrId: string, commitId: string, otherCommitId: string, project?: string, otherCollectionId?: string, otherRepositoryId?: string): Promise<GitCommitRef[]>

Параметры

repositoryNameOrId: string

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

commitId: string

Первая фиксация, как правило, подсказка целевой ветви потенциального слияния.

otherCommitId: string

Другая фиксация, как правило, подсказка исходной ветви потенциального слияния.

project: string

Project ID или название project

otherCollectionId: string

Идентификатор коллекции, в которой живет otherCommitId.

otherRepositoryId: string

Идентификатор репозитория, в котором живет otherCommitId.

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

Promise<GitCommitRef[]>

getMergeRequest(string, string, number, boolean)

Получение сведений о конкретной операции слияния.

function getMergeRequest(project: string, repositoryNameOrId: string, mergeOperationId: number, includeLinks?: boolean): Promise<GitMerge>

Параметры

project: string

Project ID или название project

repositoryNameOrId: string

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

mergeOperationId: number

OperationId запроса на слияние.

includeLinks: boolean

Значение true для включения ссылок

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

Promise<GitMerge>

getPermission(string, string, string)

Получение состояния расширенного разрешения безопасности.

function getPermission(projectName?: string, repositoryId?: string, permission?: string): Promise<boolean>

Параметры

projectName: string

repositoryId: string

Пользователь репозитория пытается access

permission: string

Запрашиваемое разрешение должно быть viewAlert "dismissAlert" "manage" viewEnablement или repoRead.

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

Promise<boolean>

getPullRequest(string, number, string, number, number, number, boolean, boolean)

Получение запроса на вытягивание.

function getPullRequest(repositoryId: string, pullRequestId: number, project?: string, maxCommentLength?: number, skip?: number, top?: number, includeCommits?: boolean, includeWorkItemRefs?: boolean): Promise<GitPullRequest>

Параметры

repositoryId: string

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

pullRequestId: number

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

project: string

Project ID или название project

maxCommentLength: number

Не используется.

skip: number

Не используется.

top: number

Не используется.

includeCommits: boolean

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

includeWorkItemRefs: boolean

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

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

Promise<GitPullRequest>

getPullRequestById(number, string)

Получение запроса на вытягивание.

function getPullRequestById(pullRequestId: number, project?: string): Promise<GitPullRequest>

Параметры

pullRequestId: number

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

project: string

Project ID или название project

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

Promise<GitPullRequest>

getPullRequestCommits(string, number, string)

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

function getPullRequestCommits(repositoryId: string, pullRequestId: number, project?: string): Promise<PagedList<GitCommitRef>>

Параметры

repositoryId: string

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

pullRequestId: number

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

project: string

Project ID или название project

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

Promise<PagedList<GitCommitRef>>

getPullRequestConflict(string, number, number, string)

Получение одного конфликта для запроса на вытягивание по идентификатору

function getPullRequestConflict(repositoryId: string, pullRequestId: number, conflictId: number, project?: string): Promise<GitConflict>

Параметры

repositoryId: string

pullRequestId: number

conflictId: number

project: string

Project ID или название project

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

Promise<GitConflict>

getPullRequestConflicts(string, number, string, number, number, boolean, boolean, boolean)

Получение всех конфликтов для запроса на вытягивание

function getPullRequestConflicts(repositoryId: string, pullRequestId: number, project?: string, skip?: number, top?: number, includeObsolete?: boolean, excludeResolved?: boolean, onlyResolved?: boolean): Promise<GitConflict[]>

Параметры

repositoryId: string

Репозиторий запроса на вытягивание.

pullRequestId: number

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

project: string

Project ID или название project

skip: number

Конфликты пропускают.

top: number

Конфликты, возвращаемые после пропуска.

includeObsolete: boolean

Включает устаревшие конфликты.

excludeResolved: boolean

Исключает уже разрешенные конфликты.

onlyResolved: boolean

Возвращает только разрешенные конфликты.

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

Promise<GitConflict[]>

getPullRequestIteration(string, number, number, string)

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

function getPullRequestIteration(repositoryId: string, pullRequestId: number, iterationId: number, project?: string): Promise<GitPullRequestIteration>

Параметры

repositoryId: string

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

pullRequestId: number

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

iterationId: number

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

project: string

Project ID или название project

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

Promise<GitPullRequestIteration>

getPullRequestIterationChanges(string, number, number, string, number, number, number)

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

function getPullRequestIterationChanges(repositoryId: string, pullRequestId: number, iterationId: number, project?: string, top?: number, skip?: number, compareTo?: number): Promise<GitPullRequestIterationChanges>

Параметры

repositoryId: string

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

pullRequestId: number

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

iterationId: number

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

project: string

Project ID или название project

top: number

Необязательный. Количество полученных изменений. Значение по умолчанию равно 100, а максимальное значение — 2000.

skip: number

Необязательный. Количество изменений, которые следует игнорировать. Например, чтобы получить изменения 101-150, задайте верхний 50 и перейдите к 100.

compareTo: number

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

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

Promise<GitPullRequestIterationChanges>

getPullRequestIterationCommits(string, number, number, string, number, number)

Получите фиксации для указанной итерации запроса на вытягивание.

function getPullRequestIterationCommits(repositoryId: string, pullRequestId: number, iterationId: number, project?: string, top?: number, skip?: number): Promise<GitCommitRef[]>

Параметры

repositoryId: string

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

pullRequestId: number

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

iterationId: number

Идентификатор итерации, из которой необходимо получить фиксации.

project: string

Project ID или название project

top: number

Максимальное количество возвращаемых фиксаций. Максимальное количество фиксаций, которые можно возвращать для каждого пакета, составляет 500.

skip: number

Количество фиксаций, которые нужно пропустить.

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

Promise<GitCommitRef[]>

getPullRequestIterations(string, number, string, boolean)

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

function getPullRequestIterations(repositoryId: string, pullRequestId: number, project?: string, includeCommits?: boolean): Promise<GitPullRequestIteration[]>

Параметры

repositoryId: string

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

pullRequestId: number

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

project: string

Project ID или название project

includeCommits: boolean

Если значение true, включите фиксации, связанные с каждой итерацией в ответе.

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

Promise<GitPullRequestIteration[]>

getPullRequestIterationStatus(string, number, number, number, string)

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

function getPullRequestIterationStatus(repositoryId: string, pullRequestId: number, iterationId: number, statusId: number, project?: string): Promise<GitPullRequestStatus>

Параметры

repositoryId: string

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

pullRequestId: number

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

iterationId: number

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

statusId: number

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

project: string

Project ID или название project

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

Promise<GitPullRequestStatus>

getPullRequestIterationStatuses(string, number, number, string)

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

function getPullRequestIterationStatuses(repositoryId: string, pullRequestId: number, iterationId: number, project?: string): Promise<GitPullRequestStatus[]>

Параметры

repositoryId: string

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

pullRequestId: number

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

iterationId: number

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

project: string

Project ID или название project

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

Promise<GitPullRequestStatus[]>

getPullRequestLabel(string, number, string, string, string)

Извлекает одну метку (тег), назначенную запросу на вытягивание.

function getPullRequestLabel(repositoryId: string, pullRequestId: number, labelIdOrName: string, project?: string, projectId?: string): Promise<WebApiTagDefinition>

Параметры

repositoryId: string

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

pullRequestId: number

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

labelIdOrName: string

Имя или идентификатор запрошенной метки.

project: string

Project ID или название project

projectId: string

Project ID или название project.

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

Promise<WebApiTagDefinition>

getPullRequestLabels(string, number, string, string)

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

function getPullRequestLabels(repositoryId: string, pullRequestId: number, project?: string, projectId?: string): Promise<WebApiTagDefinition[]>

Параметры

repositoryId: string

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

pullRequestId: number

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

project: string

Project ID или название project

projectId: string

Project ID или название project.

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

Promise<WebApiTagDefinition[]>

getPullRequestProperties(string, number, string)

Получение внешних свойств запроса на вытягивание.

function getPullRequestProperties(repositoryId: string, pullRequestId: number, project?: string): Promise<any>

Параметры

repositoryId: string

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

pullRequestId: number

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

project: string

Project ID или название project

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

Promise<any>

getPullRequestQuery(GitPullRequestQuery, string, string)

Этот API используется для поиска запросов на вытягивание, связанных с данной фиксацией. Его можно использовать для поиска запроса на вытягивание, создавшего определенную фиксацию слияния, или его можно использовать для поиска всех запросов на вытягивание, которые когда-либо объединили определенную фиксацию. Входные данные — это список запросов, каждый из которых содержит список фиксаций. Для каждой фиксации, которую выполняется поиск, вы получите словарь фиксации — запросы на вытягивание.

function getPullRequestQuery(queries: GitPullRequestQuery, repositoryId: string, project?: string): Promise<GitPullRequestQuery>

Параметры

queries: GitPullRequestQuery

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

repositoryId: string

Идентификатор репозитория.

project: string

Project ID или название project

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

Promise<GitPullRequestQuery>

getPullRequestReviewer(string, number, string, string)

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

function getPullRequestReviewer(repositoryId: string, pullRequestId: number, reviewerId: string, project?: string): Promise<IdentityRefWithVote>

Параметры

repositoryId: string

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

pullRequestId: number

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

reviewerId: string

Идентификатор рецензента.

project: string

Project ID или название project

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

Promise<IdentityRefWithVote>

getPullRequestReviewers(string, number, string)

Получение рецензентов для запроса на вытягивание

function getPullRequestReviewers(repositoryId: string, pullRequestId: number, project?: string): Promise<IdentityRefWithVote[]>

Параметры

repositoryId: string

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

pullRequestId: number

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

project: string

Project ID или название project

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

Promise<IdentityRefWithVote[]>

getPullRequests(string, GitPullRequestSearchCriteria, string, number, number, number)

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

function getPullRequests(repositoryId: string, searchCriteria: GitPullRequestSearchCriteria, project?: string, maxCommentLength?: number, skip?: number, top?: number): Promise<GitPullRequest[]>

Параметры

repositoryId: string

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

searchCriteria: GitPullRequestSearchCriteria

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

project: string

Project ID или название project

maxCommentLength: number

Не используется.

skip: number

Количество запросов на вытягивание, которые следует игнорировать. Например, чтобы получить результаты 101-150, установите верхний 50 и перейдите к 100.

top: number

Количество полученных запросов на вытягивание.

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

Promise<GitPullRequest[]>

getPullRequestsByProject(string, GitPullRequestSearchCriteria, number, number, number)

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

function getPullRequestsByProject(project: string, searchCriteria: GitPullRequestSearchCriteria, maxCommentLength?: number, skip?: number, top?: number): Promise<GitPullRequest[]>

Параметры

project: string

Project ID или название project

searchCriteria: GitPullRequestSearchCriteria

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

maxCommentLength: number

Не используется.

skip: number

top: number

Количество полученных запросов на вытягивание.

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

Promise<GitPullRequest[]>

getPullRequestStatus(string, number, number, string)

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

function getPullRequestStatus(repositoryId: string, pullRequestId: number, statusId: number, project?: string): Promise<GitPullRequestStatus>

Параметры

repositoryId: string

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

pullRequestId: number

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

statusId: number

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

project: string

Project ID или название project

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

Promise<GitPullRequestStatus>

getPullRequestStatuses(string, number, string)

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

function getPullRequestStatuses(repositoryId: string, pullRequestId: number, project?: string): Promise<GitPullRequestStatus[]>

Параметры

repositoryId: string

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

pullRequestId: number

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

project: string

Project ID или название project

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

Promise<GitPullRequestStatus[]>

getPullRequestThread(string, number, number, string, number, number)

Получение потока в запросе на вытягивание.

function getPullRequestThread(repositoryId: string, pullRequestId: number, threadId: number, project?: string, iteration?: number, baseIteration?: number): Promise<GitPullRequestCommentThread>

Параметры

repositoryId: string

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

pullRequestId: number

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

threadId: number

Идентификатор потока.

project: string

Project ID или название project

iteration: number

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

baseIteration: number

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

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

Promise<GitPullRequestCommentThread>

getPullRequestWorkItemRefs(string, number, string)

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

function getPullRequestWorkItemRefs(repositoryId: string, pullRequestId: number, project?: string): Promise<ResourceRef[]>

Параметры

repositoryId: string

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

pullRequestId: number

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

project: string

Project ID или название project

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

Promise<ResourceRef[]>

getPush(string, number, string, number, boolean)

Извлекает определенную отправку.

function getPush(repositoryId: string, pushId: number, project?: string, includeCommits?: number, includeRefUpdates?: boolean): Promise<GitPush>

Параметры

repositoryId: string

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

pushId: number

Идентификатор принудительной отправки.

project: string

Project ID или название project

includeCommits: number

Число фиксаций, включаемых в результат.

includeRefUpdates: boolean

Если значение true, добавьте список ссылок, которые были обновлены push-отправкой.

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

Promise<GitPush>

getPushCommits(string, number, string, number, number, boolean)

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

function getPushCommits(repositoryId: string, pushId: number, project?: string, top?: number, skip?: number, includeLinks?: boolean): Promise<GitCommitRef[]>

Параметры

repositoryId: string

Идентификатор или понятное имя репозитория. Чтобы использовать понятное имя, необходимо также указать projectId.

pushId: number

Идентификатор push-отправки.

project: string

Project ID или название project

top: number

Максимальное количество возвращаемых фиксаций ("получение верхних зафиксов x").

skip: number

Количество пропускаемых фиксаций.

includeLinks: boolean

Установите значение false, чтобы избежать включения ссылок URL-адреса REST для ресурсов. По умолчанию имеет значение true.

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

Promise<GitCommitRef[]>

getPushes(string, string, number, number, GitPushSearchCriteria)

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

function getPushes(repositoryId: string, project?: string, skip?: number, top?: number, searchCriteria?: GitPushSearchCriteria): Promise<GitPush[]>

Параметры

repositoryId: string

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

project: string

Project ID или название project

skip: number

Количество пропускаемых push-уведомлений.

top: number

Количество возвращаемых push-уведомлений.

searchCriteria: GitPushSearchCriteria

Атрибуты условий поиска: fromDate, toDate, pusherId, refName, includeRefUpdates или includeLinks. fromDate: дата начала поиска. toDate: дата окончания поиска. pusherId: удостоверение пользователя, отправившего push-сообщение. refName: имя ветви для рассмотрения. includeRefUpdates: если значение true, включите список ссылок, которые были обновлены push-запросом. includeLinks: следует ли включать поле _links на неглубокие ссылки.

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

Promise<GitPush[]>

getRecycleBinRepositories(string)

Получение обратимо удаленных репозиториев Git из корзины.

function getRecycleBinRepositories(project: string): Promise<GitDeletedRepository[]>

Параметры

project: string

Project ID или название project

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

Promise<GitDeletedRepository[]>

getRefFavorite(string, number)

Возвращает ссылку на избранное для избранного идентификатора.

function getRefFavorite(project: string, favoriteId: number): Promise<GitRefFavorite>

Параметры

project: string

Project ID или название project

favoriteId: number

Идентификатор запрошенного избранного ссылки.

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

Promise<GitRefFavorite>

getRefFavorites(string, string, string)

Возвращает избранное ссылок для репозитория и удостоверения.

function getRefFavorites(project: string, repositoryId?: string, identityId?: string): Promise<GitRefFavorite[]>

Параметры

project: string

Project ID или название project

repositoryId: string

Идентификатор репозитория.

identityId: string

Идентификатор удостоверения, избранное которого требуется получить. Если значение NULL, используется запрашивающее удостоверение.

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

Promise<GitRefFavorite[]>

getRefFavoritesForProject(string, string)

function getRefFavoritesForProject(project: string, identityId?: string): Promise<GitRefFavorite[]>

Параметры

project: string

Project ID или название project

identityId: string

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

Promise<GitRefFavorite[]>

getRefs(string, string, string, boolean, boolean, boolean, boolean, boolean, string, boolean)

Запрашивает предоставленный репозиторий для его ссылок и возвращает их.

function getRefs(repositoryId: string, project?: string, filter?: string, includeLinks?: boolean, includeStatuses?: boolean, includeMyBranches?: boolean, latestStatusesOnly?: boolean, peelTags?: boolean, filterContains?: string, includeTargetBranches?: boolean): Promise<PagedList<GitRef>>

Параметры

repositoryId: string

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

project: string

Project ID или название project

filter: string

[необязательно] Фильтр для применения к ссылкам (начинается с).

includeLinks: boolean

[необязательно] Указывает, следует ли включить ссылочные ссылки в результат. значение по умолчанию — false.

includeStatuses: boolean

[необязательно] Включает до первых 1000 состояний фиксации для каждого ссылок. Значение по умолчанию — false.

includeMyBranches: boolean

[необязательно] Включает только ветви, принадлежащие пользователю, ветви избранного пользователя и ветвь по умолчанию. Значение по умолчанию — false. Невозможно объединить с параметром фильтра.

latestStatusesOnly: boolean

[необязательно] Значение true, чтобы включить только состояние фиксации подсказки для каждого ссылки. Этот параметр требует, чтобы быть верным. Значение по умолчанию — false.

peelTags: boolean

[необязательно] Помеченные теги заполняют свойство PeeledObjectId. значение по умолчанию — false.

filterContains: string

[необязательно] Фильтр для применения к ссылкам (содержит).

includeTargetBranches: boolean

[необязательно] Включает целевые ветви, определенные шаблонами в pull_request_targets.yml.

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

Promise<PagedList<GitRef>>

getRepositories(string, boolean, boolean, boolean)

Получение репозиториев Git.

function getRepositories(project?: string, includeLinks?: boolean, includeAllUrls?: boolean, includeHidden?: boolean): Promise<GitRepository[]>

Параметры

project: string

Project ID или название project

includeLinks: boolean

[необязательно] Значение true для включения ссылочных ссылок. Значение по умолчанию — false.

includeAllUrls: boolean

[необязательно] Значение true, чтобы включить все удаленные URL-адреса. Значение по умолчанию — false.

includeHidden: boolean

[необязательно] Значение true для включения скрытых репозиториев. Значение по умолчанию — false.

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

Promise<GitRepository[]>

getRepositoriesPaged(string, boolean, boolean, boolean, string, number, string)

Извлеките репозитории Git с фильтром по имени и разбиению на страницы.

function getRepositoriesPaged(projectId: string, includeLinks?: boolean, includeAllUrls?: boolean, includeHidden?: boolean, filterContains?: string, top?: number, continuationToken?: string): Promise<PagedList<GitRepository>>

Параметры

projectId: string

ID или название команды project.

includeLinks: boolean

[необязательно] Значение true для включения ссылочных ссылок. Значение по умолчанию — false.

includeAllUrls: boolean

[необязательно] Значение true, чтобы включить все удаленные URL-адреса. Значение по умолчанию — false.

includeHidden: boolean

[необязательно] Значение true для включения скрытых репозиториев. Значение по умолчанию — false.

filterContains: string

[необязательно] Фильтр для применения к ссылкам (содержит).

top: number

[необязательно] Максимальное количество возвращаемых репозиториев. Она не может быть больше 500. Если он не указан, но продолжениеToken имеет значение 100.

continuationToken: string

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

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

Promise<PagedList<GitRepository>>

getRepository(string, string)

Получение репозитория Git.

function getRepository(repositoryId: string, project?: string): Promise<GitRepository>

Параметры

repositoryId: string

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

project: string

Project ID или название project

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

Promise<GitRepository>

getRepositoryWithParent(string, boolean, string)

Получение репозитория Git.

function getRepositoryWithParent(repositoryId: string, includeParent: boolean, project?: string): Promise<GitRepository>

Параметры

repositoryId: string

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

includeParent: boolean

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

project: string

Project ID или название project

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

Promise<GitRepository>

getRevert(string, number, string)

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

function getRevert(project: string, revertId: number, repositoryId: string): Promise<GitRevert>

Параметры

project: string

Project ID или название project

revertId: number

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

repositoryId: string

Идентификатор репозитория.

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

Promise<GitRevert>

getRevertConflict(string, number, number, string)

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

function getRevertConflict(repositoryId: string, revertId: number, conflictId: number, project?: string): Promise<GitConflict>

Параметры

repositoryId: string

revertId: number

conflictId: number

project: string

Project ID или название project

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

Promise<GitConflict>

getRevertConflicts(string, number, string, string, number, boolean, boolean, boolean)

Получение всех конфликтов для возврата

function getRevertConflicts(repositoryId: string, revertId: number, project?: string, continuationToken?: string, top?: number, excludeResolved?: boolean, onlyResolved?: boolean, includeObsolete?: boolean): Promise<PagedList<GitConflict>>

Параметры

repositoryId: string

revertId: number

project: string

Project ID или название project

continuationToken: string

top: number

excludeResolved: boolean

onlyResolved: boolean

includeObsolete: boolean

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

Promise<PagedList<GitConflict>>

getRevertForRefName(string, string, string)

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

function getRevertForRefName(project: string, repositoryId: string, refName: string): Promise<GitRevert>

Параметры

project: string

Project ID или название project

repositoryId: string

Идентификатор репозитория.

refName: string

GitAsyncRefOperationParameters, созданныйrefName, используемый для операции восстановления.

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

Promise<GitRevert>

getStatuses(string, string, string, number, number, boolean)

Получение состояний, связанных с фиксацией Git.

function getStatuses(commitId: string, repositoryId: string, project?: string, top?: number, skip?: number, latestOnly?: boolean): Promise<GitStatus[]>

Параметры

commitId: string

Идентификатор фиксации Git.

repositoryId: string

Идентификатор репозитория.

project: string

Project ID или название project

top: number

Необязательный. Количество полученных состояний. Значение по умолчанию — 1000.

skip: number

Необязательный. Количество состояний, которые следует игнорировать. Значение по умолчанию — 0. Например, чтобы получить результаты 101-150, установите верхний 50 и перейдите к 100.

latestOnly: boolean

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

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

Promise<GitStatus[]>

getSuggestions(string, string, boolean)

Получите предложение pull request-запроса для конкретного репозитория или командного project.

function getSuggestions(repositoryId: string, project?: string, preferCompareBranch?: boolean): Promise<GitSuggestion[]>

Параметры

repositoryId: string

Идентификатор репозитория Git.

project: string

Project ID или название project

preferCompareBranch: boolean

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

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

Promise<GitSuggestion[]>

getThreads(string, number, string, number, number)

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

function getThreads(repositoryId: string, pullRequestId: number, project?: string, iteration?: number, baseIteration?: number): Promise<GitPullRequestCommentThread[]>

Параметры

repositoryId: string

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

pullRequestId: number

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

project: string

Project ID или название project

iteration: number

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

baseIteration: number

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

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

Promise<GitPullRequestCommentThread[]>

getTree(string, string, string, string, boolean, string)

Конечная точка "Дерево" возвращает коллекцию объектов под указанным деревом. Деревья — это папки в репозитории Git.

function getTree(repositoryId: string, sha1: string, project?: string, projectId?: string, recursive?: boolean, fileName?: string): Promise<GitTreeRef>

Параметры

repositoryId: string

Идентификатор репозитория.

sha1: string

Хэш SHA1 объекта дерева.

project: string

Project ID или название project

projectId: string

Project Id.

recursive: boolean

Поиск рекурсивно. Включите деревья под этим деревом. Значение по умолчанию — false.

fileName: string

Имя для использования, если возвращается файл .zip. По умолчанию используется идентификатор объекта.

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

Promise<GitTreeRef>

getTreeZip(string, string, string, string, boolean, string)

function getTreeZip(repositoryId: string, sha1: string, project?: string, projectId?: string, recursive?: boolean, fileName?: string): Promise<ArrayBuffer>

Параметры

repositoryId: string

Идентификатор репозитория.

sha1: string

Хэш SHA1 объекта дерева.

project: string

Project ID или название project

projectId: string

Project Id.

recursive: boolean

Поиск рекурсивно. Включите деревья под этим деревом. Значение по умолчанию — false.

fileName: string

Имя для использования, если возвращается файл .zip. По умолчанию используется идентификатор объекта.

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

Promise<ArrayBuffer>

queryImportRequests(string, string, boolean)

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

function queryImportRequests(project: string, repositoryId: string, includeAbandoned?: boolean): Promise<GitImportRequest[]>

Параметры

project: string

Project ID или название project

repositoryId: string

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

includeAbandoned: boolean

Значение true, чтобы включить в результаты заброшенные запросы на импорт.

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

Promise<GitImportRequest[]>

restoreRepositoryFromRecycleBin(GitRecycleBinRepositoryDetails, string, string)

Восстановите обратимо удаленный репозиторий Git. Недавно удаленные репозитории попадают в состояние обратимого удаления в течение определенного периода времени, прежде чем они будут удалены и становятся невосстановимыми.

function restoreRepositoryFromRecycleBin(repositoryDetails: GitRecycleBinRepositoryDetails, project: string, repositoryId: string): Promise<GitRepository>

Параметры

repositoryDetails: GitRecycleBinRepositoryDetails

project: string

Project ID или название project

repositoryId: string

Идентификатор репозитория.

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

Promise<GitRepository>

setEnableOnCreateHost(boolean)

function setEnableOnCreateHost(enableOnCreateHost: boolean): Promise<void>

Параметры

enableOnCreateHost: boolean

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

Promise<void>

setEnableOnCreateProject(string, boolean)

function setEnableOnCreateProject(enableOnCreateProjectId: string, enableOnStatus: boolean): Promise<void>

Параметры

enableOnCreateProjectId: string

enableOnStatus: boolean

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

Promise<void>

sharePullRequest(ShareNotificationContext, string, number, string)

Отправляет уведомление по электронной почте о конкретном запросе на вытягивание набору получателей

function sharePullRequest(userMessage: ShareNotificationContext, repositoryId: string, pullRequestId: number, project?: string): Promise<void>

Параметры

userMessage: ShareNotificationContext

repositoryId: string

Идентификатор репозитория Git.

pullRequestId: number

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

project: string

Project ID или название project

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

Promise<void>

updateCherryPickConflict(GitConflict, string, number, number, string)

Обновление разрешения конфликтов слиянием

function updateCherryPickConflict(conflict: GitConflict, repositoryId: string, cherryPickId: number, conflictId: number, project?: string): Promise<GitConflict>

Параметры

conflict: GitConflict

repositoryId: string

cherryPickId: number

conflictId: number

project: string

Project ID или название project

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

Promise<GitConflict>

updateCherryPickConflicts(GitConflict[], string, number, string)

Обновление нескольких разрешений конфликтов слиянием

function updateCherryPickConflicts(conflictUpdates: GitConflict[], repositoryId: string, cherryPickId: number, project?: string): Promise<GitConflictUpdateResult[]>

Параметры

conflictUpdates: GitConflict[]

repositoryId: string

cherryPickId: number

project: string

Project ID или название project

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

Promise<GitConflictUpdateResult[]>

updateComment(Comment, string, number, number, number, string)

Обновите комментарий, связанный с определенным потоком в запросе на вытягивание.

function updateComment(comment: Comment, repositoryId: string, pullRequestId: number, threadId: number, commentId: number, project?: string): Promise<Comment>

Параметры

comment: Comment

Содержимое комментария, которое должно быть обновлено. Примечания могут составлять до 150 000 символов.

repositoryId: string

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

pullRequestId: number

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

threadId: number

Идентификатор потока, в который входит нужный комментарий.

commentId: number

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

project: string

Project ID или название project

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

Promise<Comment>

updateEnablementStatus(AdvSecEnablementUpdate[])

Состояние включения POST для репозиториев.

function updateEnablementStatus(enablementUpdates: AdvSecEnablementUpdate[]): Promise<void>

Параметры

enablementUpdates: AdvSecEnablementUpdate[]

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

Promise<void>

updateImportRequest(GitImportRequest, string, string, number)

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

function updateImportRequest(importRequestToUpdate: GitImportRequest, project: string, repositoryId: string, importRequestId: number): Promise<GitImportRequest>

Параметры

importRequestToUpdate: GitImportRequest

Обновленная версия запроса на импорт. В настоящее время единственным разрешенным изменением является установка состояния в очередь или отказ.

project: string

Project ID или название project

repositoryId: string

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

importRequestId: number

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

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

Promise<GitImportRequest>

updatePullRequest(GitPullRequest, string, number, string)

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

function updatePullRequest(gitPullRequestToUpdate: GitPullRequest, repositoryId: string, pullRequestId: number, project?: string): Promise<GitPullRequest>

Параметры

gitPullRequestToUpdate: GitPullRequest

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

repositoryId: string

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

pullRequestId: number

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

project: string

Project ID или название project

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

Promise<GitPullRequest>

updatePullRequestConflict(GitConflict, string, number, number, string)

Обновление разрешения конфликтов слиянием

function updatePullRequestConflict(conflict: GitConflict, repositoryId: string, pullRequestId: number, conflictId: number, project?: string): Promise<GitConflict>

Параметры

conflict: GitConflict

repositoryId: string

pullRequestId: number

conflictId: number

project: string

Project ID или название project

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

Promise<GitConflict>

updatePullRequestConflicts(GitConflict[], string, number, string)

Обновление нескольких разрешений конфликтов слиянием

function updatePullRequestConflicts(conflictUpdates: GitConflict[], repositoryId: string, pullRequestId: number, project?: string): Promise<GitConflictUpdateResult[]>

Параметры

conflictUpdates: GitConflict[]

repositoryId: string

pullRequestId: number

project: string

Project ID или название project

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

Promise<GitConflictUpdateResult[]>

updatePullRequestIterationStatuses(JsonPatchDocument, string, number, number, string)

Обновление коллекции состояний итерации запроса на вытягивание. Единственным поддерживаемым типом операции является .

function updatePullRequestIterationStatuses(patchDocument: JsonPatchDocument, repositoryId: string, pullRequestId: number, iterationId: number, project?: string): Promise<void>

Параметры

patchDocument: JsonPatchDocument

Операции, применяемые к состояниям запроса на вытягивание в формате исправлений JSON.

repositoryId: string

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

pullRequestId: number

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

iterationId: number

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

project: string

Project ID или название project

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

Promise<void>

updatePullRequestProperties(JsonPatchDocument, string, number, string)

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

function updatePullRequestProperties(patchDocument: JsonPatchDocument, repositoryId: string, pullRequestId: number, project?: string): Promise<any>

Параметры

patchDocument: JsonPatchDocument

Свойства для добавления, замены или удаления в формате исправлений JSON.

repositoryId: string

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

pullRequestId: number

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

project: string

Project ID или название project

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

Promise<any>

updatePullRequestReviewer(IdentityRefWithVote, string, number, string, string)

Изменение записи рецензента. Эти поля доступны для исправления: isFlagged, hasDeclined

function updatePullRequestReviewer(reviewer: IdentityRefWithVote, repositoryId: string, pullRequestId: number, reviewerId: string, project?: string): Promise<IdentityRefWithVote>

Параметры

reviewer: IdentityRefWithVote

Данные рецензента.br /Если идентификатор рецензента включен здесь, он должен соответствовать параметру рецензента.

repositoryId: string

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

pullRequestId: number

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

reviewerId: string

Идентификатор рецензента.

project: string

Project ID или название project

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

Promise<IdentityRefWithVote>

updatePullRequestReviewers(IdentityRefWithVote[], string, number, string)

Сброс голосов нескольких рецензентов по запросу на вытягивание. ПРИМЕЧАНИЕ. Эта конечная точка поддерживает только обновление голосов, но не поддерживает обновление необходимых рецензентов (использование политики) или отображаемых имен.

function updatePullRequestReviewers(patchVotes: IdentityRefWithVote[], repositoryId: string, pullRequestId: number, project?: string): Promise<void>

Параметры

patchVotes: IdentityRefWithVote[]

Идентификаторы рецензентов, голоса которых будут сбрасываться до нуля

repositoryId: string

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

pullRequestId: number

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

project: string

Project ID или название project

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

Promise<void>

updatePullRequestStatuses(JsonPatchDocument, string, number, string)

Обновление коллекции состояний запроса на вытягивание. Единственным поддерживаемым типом операции является .

function updatePullRequestStatuses(patchDocument: JsonPatchDocument, repositoryId: string, pullRequestId: number, project?: string): Promise<void>

Параметры

patchDocument: JsonPatchDocument

Операции, применяемые к состояниям запроса на вытягивание в формате исправлений JSON.

repositoryId: string

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

pullRequestId: number

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

project: string

Project ID или название project

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

Promise<void>

updateRef(GitRefUpdate, string, string, string, string)

Блокировка или разблокировка ветви.

function updateRef(newRefInfo: GitRefUpdate, repositoryId: string, filter: string, project?: string, projectId?: string): Promise<GitRef>

Параметры

newRefInfo: GitRefUpdate

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

repositoryId: string

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

filter: string

Имя ветви для блокировки и разблокировки

project: string

Project ID или название project

projectId: string

ID или название команды project. Необязательно, если указать идентификатор для репозитория.

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

Promise<GitRef>

updateRefs(GitRefUpdate[], string, string, string)

Создание, обновление или удаление ссылок (ветвей).

function updateRefs(refUpdates: GitRefUpdate[], repositoryId: string, project?: string, projectId?: string): Promise<GitRefUpdateResult[]>

Параметры

refUpdates: GitRefUpdate[]

Список обновлений ссылок для выполнения попытки выполнить

repositoryId: string

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

project: string

Project ID или название project

projectId: string

ID или название команды project. Необязательно, если указать идентификатор для репозитория.

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

Promise<GitRefUpdateResult[]>

updateRepository(GitRepository, string, string)

Обновляет репозиторий Git с новым именем репозитория или новой ветвью по умолчанию.

function updateRepository(newRepositoryInfo: GitRepository, repositoryId: string, project?: string): Promise<GitRepository>

Параметры

newRepositoryInfo: GitRepository

Укажите новое имя репозитория или новую ветвь по умолчанию репозитория

repositoryId: string

Идентификатор репозитория.

project: string

Project ID или название project

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

Promise<GitRepository>

updateRevertConflict(GitConflict, string, number, number, string)

Обновление разрешения конфликтов слиянием

function updateRevertConflict(conflict: GitConflict, repositoryId: string, revertId: number, conflictId: number, project?: string): Promise<GitConflict>

Параметры

conflict: GitConflict

repositoryId: string

revertId: number

conflictId: number

project: string

Project ID или название project

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

Promise<GitConflict>

updateRevertConflicts(GitConflict[], string, number, string)

Обновление нескольких разрешений конфликтов слиянием

function updateRevertConflicts(conflictUpdates: GitConflict[], repositoryId: string, revertId: number, project?: string): Promise<GitConflictUpdateResult[]>

Параметры

conflictUpdates: GitConflict[]

repositoryId: string

revertId: number

project: string

Project ID или название project

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

Promise<GitConflictUpdateResult[]>

updateThread(GitPullRequestCommentThread, string, number, number, string)

Обновите поток в запросе на вытягивание.

function updateThread(commentThread: GitPullRequestCommentThread, repositoryId: string, pullRequestId: number, threadId: number, project?: string): Promise<GitPullRequestCommentThread>

Параметры

commentThread: GitPullRequestCommentThread

Содержимое потока, которое должно быть обновлено.

repositoryId: string

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

pullRequestId: number

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

threadId: number

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

project: string

Project ID или название project

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

Promise<GitPullRequestCommentThread>

Обратная связь

Были ли сведения на этой странице полезными?

Поделиться через

GitRestClient class

Конструкторы

Свойства

Методы

Сведения о конструкторе

GitRestClient(IVssRestClientOptions)

Параметры

Сведения о свойстве

RESOURCE_AREA_ID

Значение свойства

Сведения о методе

createAnnotatedTag(GitAnnotatedTag, string, string)

Параметры

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

createAttachment(any, string, string, number, string)

Параметры

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

createCherryPick(GitAsyncRefOperationParameters, string, string)

Параметры

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

createComment(Comment, string, number, number, string)

Параметры

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

createCommitStatus(GitStatus, string, string, string)

Параметры

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

createFavorite(GitRefFavorite, string)

Параметры

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

createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)

Параметры

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

createImportRequest(GitImportRequest, string, string)

Параметры

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

createLike(string, number, number, number, string)

Параметры

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

createMergeRequest(GitMergeParameters, string, string, boolean)

Параметры

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

createPullRequest(GitPullRequest, string, string, boolean)

Параметры

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

createPullRequestIterationStatus(GitPullRequestStatus, string, number, number, string)

Параметры

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

createPullRequestLabel(WebApiCreateTagRequestData, string, number, string, string)

Параметры

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

createPullRequestReviewer(IdentityRefWithVote, string, number, string, string)

Параметры

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

createPullRequestReviewers(IdentityRef[], string, number, string)

Параметры

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

createPullRequestStatus(GitPullRequestStatus, string, number, string)

Параметры

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

createPush(GitPush, string, string)

Параметры

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

createRepository(GitRepositoryCreateOptions, string, string)

Параметры

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

createRevert(GitAsyncRefOperationParameters, string, string)

Параметры

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

createThread(GitPullRequestCommentThread, string, number, string)

Параметры

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

createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)

Параметры

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

deleteAttachment(string, string, number, string)

Параметры

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

deleteComment(string, number, number, number, string)

Параметры