Forks - Get fork sync request

Служба:

Git

Версия API:

7.1

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

GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryNameOrId}/forkSyncRequests/{forkSyncOperationId}?api-version=7.1

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

GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryNameOrId}/forkSyncRequests/{forkSyncOperationId}?includeLinks={includeLinks}&api-version=7.1

Параметры URI

Имя	В	Обязательно	Тип	Описание
forkSyncOperationId	path	True	integer (int32)	OperationId запроса синхронизации.
organization	path	True	string	Имя организации Azure DevOps.
repositoryNameOrId	path	True	string	Имя или идентификатор репозитория.
project	path		string	Идентификатор проекта или имя проекта
api-version	query	True	string	Используемая версия API. Для использования этой версии API необходимо задать значение "7.1".
includeLinks	query		boolean	Значение true для включения ссылок.

Ответы

Имя	Тип	Описание
200 OK	GitForkSyncRequest	успешная операция

Безопасность

oauth2

Тип: oauth2
Flow: accessCode
URL-адрес авторизации: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL-адрес токена: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Области

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

Определения

Имя	Описание
GitAsyncOperationStatus
GitForkOperationStatusDetail	Сведения о состоянии запрошенной операции вилки.
GitForkSyncRequest	Запрос на синхронизацию данных между двумя вилками.
GlobalGitRepositoryKey	Глобальный уникальный ключ для репозитория.
ReferenceLinks	Класс, представляющий коллекцию ссылок REST.
SourceToTargetRef

GitAsyncOperationStatus

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

Значение	Описание
abandoned	Операция была прекращена.
completed	Операция завершена.
failed	Операция завершилась ошибкой. Проверьте сообщение об ошибке.
inProgress	В настоящее время выполняется операция.
queued	Операция ожидается в очереди и еще не запущена.

GitForkOperationStatusDetail

Object

Сведения о состоянии запрошенной операции вилки.

Имя	Тип	Описание
allSteps	string[]	Все допустимые шаги для процесса вилки
currentStep	integer (int32)	Индекс в AllSteps для текущего шага
errorMessage	string	Сообщение об ошибке, если операция завершилась ошибкой.

GitForkSyncRequest

Object

Запрос на синхронизацию данных между двумя вилками.

Имя	Тип	Описание
_links	ReferenceLinks	Коллекция связанных ссылок
detailedStatus	GitForkOperationStatusDetail	Сведения о состоянии запрошенной операции вилки.
operationId	integer (int32)	Уникальный идентификатор операции.
source	GlobalGitRepositoryKey	Полный идентификатор исходного репозитория.
sourceToTargetRefs	SourceToTargetRef[]	Если задано, набор сопоставлений ссылок, используемых при выполнении синхронизации или создания. При отсутствии все ссылки будут синхронизированы.
status	GitAsyncOperationStatus

GlobalGitRepositoryKey

Object

Глобальный уникальный ключ для репозитория.

Имя	Тип	Описание
collectionId	string (uuid)	Идентификатор коллекции командных проектов для репозитория.
projectId	string (uuid)	Идентификатор командного проекта проекта для репозитория.
repositoryId	string (uuid)	Идентификатор репозитория.

ReferenceLinks

Object

Класс, представляющий коллекцию ссылок REST.

Имя	Тип	Описание
links	object	Режим чтения ссылок. Так как ссылки ссылки доступны только для чтения, мы хотим предоставлять их только как доступные только для чтения.

SourceToTargetRef

Object

Имя	Тип	Описание
sourceRef	string	Исходный ссылка для копирования. Например, refs/heads/master.
targetRef	string	Целевой ссылка для обновления. Например, refs/heads/master.