Pull Request Statuses - Get

Ссылка

Служба:: Git

Версия API:: 7.1

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

GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/statuses/{statusId}?api-version=7.1

Параметры URI

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

Ответы

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

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

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	Предоставляет возможность читать исходный код и метаданные о фиксациях, изменениях, ветвях и других артефактах управления версиями. Кроме того, предоставляет возможность искать код и получать уведомления о событиях управления версиями с помощью перехватчиков служб.
vso.code_status	Предоставляет возможность считывания и записи состояния запроса на вытягивание и фиксацию.

Имя

Описание

vso.code

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

vso.code_status

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

Примеры

Образец запроса

HTTP

GET https://dev.azure.com/fabrikam/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/statuses/{statusId}?api-version=7.1

Пример ответа

Код состояния:: 200

{
  "id": 1,
  "state": "succeeded",
  "description": "Sample status succeeded",
  "context": {
    "name": "sample-status-1",
    "genre": "vsts-samples"
  },
  "creationDate": "2017-09-19T14:50:27.4949745Z",
  "updatedDate": "2017-09-19T14:50:27.4949745Z",
  "createdBy": {
    "id": "6f168adb-59d4-4fc0-be3b-fb21b939b2a6",
    "displayName": "Normal Paulk",
    "uniqueName": "fabrikamfiber16@hotmail.com",
    "url": "https://dev.azure.com/fabrikam/_apis/Identities/6f168adb-59d4-4fc0-be3b-fb21b939b2a6",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=6f168adb-59d4-4fc0-be3b-fb21b939b2a6"
  },
  "targetUrl": "http://fabrikam-fiber-inc.com/CI/builds/1",
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/b92c8408-a0c9-4292-88af-bc005a1b8272/pullRequests/5/statuses/1"
    },
    "repository": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/b92c8408-a0c9-4292-88af-bc005a1b8272"
    }
  }
}

Определения

Имя	Описание
GitPullRequestStatus	Этот класс содержит метаданные службы или расширения, публикующие состояние запроса на вытягивание. Состояние может быть связано с запросом на вытягивание или итерацией.
GitStatusContext	Контекст состояния, который однозначно идентифицирует состояние.
GitStatusState	Состояние состояния.
IdentityRef
PropertiesCollection	Класс представляет контейнер свойств в виде коллекции пар "ключ-значение". Принимаются значения всех примитивных типов (любого типа с `TypeCode != TypeCode.Object`), кроме `DBNull`. Значения типа Byte[], Int32, Double, DateType и String сохраняют их тип, другие примитивы повторно настраиваются в виде строки. Byte[] ожидается как строка в кодировке Base64.
ReferenceLinks	Класс, представляющий коллекцию ссылок REST.

GitPullRequestStatus

Object

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

Имя	Тип	Описание
_links	ReferenceLinks	Справочные ссылки.
context	GitStatusContext	Контекст состояния.
createdBy	IdentityRef	Удостоверение, создающее состояние.
creationDate	string (date-time)	Дата и время создания состояния.
description	string	Описание состояния. Обычно описывает текущее состояние состояния.
id	integer (int32)	Идентификатор состояния.
iterationId	integer (int32)	Идентификатор итерации для сопоставления состояния. Минимальное значение равно 1.
properties	PropertiesCollection	Настраиваемые свойства состояния.
state	GitStatusState	Состояние состояния.
targetUrl	string	URL-адрес со сведениями о состоянии.
updatedDate	string (date-time)	Дата последнего обновления и время состояния.

GitStatusContext

Object

Контекст состояния, который однозначно идентифицирует состояние.

Имя	Тип	Описание
genre	string	Жанр состояния. Обычно имя службы или инструмента, создающего состояние, может быть пустым.
name	string	Идентификатор имени состояния не может быть пустым или пустым.

GitStatusState

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

Состояние состояния.

Значение	Описание
error	Состояние с ошибкой.
failed	Сбой состояния.
notApplicable	Состояние не применимо к целевому объекту.
notSet	Состояние состояния не задано. Состояние по умолчанию.
pending	Состояние ожидается.
succeeded	Состояние выполнено успешно.

IdentityRef

Object

Имя	Тип	Описание
_links	ReferenceLinks	Это поле содержит нулевые или более интересные ссылки на тему графа. Эти ссылки могут вызываться для получения дополнительных связей или более подробных сведений об этой теме графа.
descriptor	string	Дескриптор является основным способом ссылки на тему графа во время выполнения системы. Это поле однозначно определяет одну и ту же тему графа как в учетных записях, так и в организациях.
directoryAlias	string	Нерекомендуемое. Можно получить, запросив пользователя Graph, на который ссылается пользователь Graph в записи "self" словаря IdentityRef "_links"
displayName	string	Это не уникальное отображаемое имя субъекта графа. Чтобы изменить это поле, необходимо изменить его значение в исходном поставщике.
id	string
imageUrl	string	Не рекомендуется . Доступно в записи "аватар" словаря IdentityRef "_links"
inactive	boolean	Нерекомендуемый — можно получить, запросив состояние членства Graph, на которое ссылается запись "membershipState" словаря GraphUser "_links"
isAadIdentity	boolean	Нерекомендуемый — можно выводить из типа субъекта дескриптора (descriptor.IsAadUserType/descriptor.IsAadGroupType)
isContainer	boolean	Нерекомендуемый — можно выводить из типа субъекта дескриптора (descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Не рекомендуется — не используется в большинстве стандартных реализаций ToIdentityRef
uniqueName	string	Не рекомендуется — вместо этого используйте domain+PrincipalName
url	string	Этот URL-адрес является полным маршрутом к исходному ресурсу данного субъекта графа.

PropertiesCollection

Object

Класс представляет контейнер свойств в виде коллекции пар "ключ-значение". Принимаются значения всех примитивных типов (любого типа с TypeCode != TypeCode.Object), кроме DBNull. Значения типа Byte[], Int32, Double, DateType и String сохраняют их тип, другие примитивы повторно настраиваются в виде строки. Byte[] ожидается как строка в кодировке Base64.

Имя	Тип	Описание
count	integer (int32)	Количество свойств в коллекции.
item	object
keys	string[]	Набор ключей в коллекции.
values	string[]	Набор значений в коллекции.

ReferenceLinks

Object

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

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

Поделиться через

Pull Request Statuses - Get

Параметры URI

Ответы

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

oauth2

Области

Примеры

Образец запроса

Пример ответа

Определения

GitPullRequestStatus

GitStatusContext

GitStatusState

IdentityRef

PropertiesCollection

ReferenceLinks