Pull Request Statuses - Get

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

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

Параметры URI

Name In Required Type Description
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 необходимо задать значение 4.1-preview.1.

Ответы

Name Type Description
200 OK

успешная операция

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

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token 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

Scopes

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

Примеры

Sample Request

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

Sample Response

{
  "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

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

ReferenceLinks

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

GitPullRequestStatus

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

Name Type Description
_links

Ссылки на справочные материалы.

context

Контекст состояния.

createdBy

Удостоверение, создающее состояние.

creationDate
  • string

Дата и время создания состояния.

description
  • string

Описание состояния. Обычно описывает текущее состояние состояния.

id
  • integer

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

iterationId
  • integer

Идентификатор итерации, с которым необходимо связать состояние. Минимальное значение — 1.

properties

Пользовательские свойства состояния.

state

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

targetUrl
  • string

URL-адрес со сведениями о состоянии.

updatedDate
  • string

Дата и время последнего обновления состояния.

GitStatusContext

Контекст состояния, однозначно определяющий состояние.

Name Type Description
genre
  • string

Жанр состояния. Обычно имя службы или средства, создающего состояние, может быть пустым.

name
  • string

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

GitStatusState

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

Name Type Description
error
  • string

Состояние с ошибкой.

failed
  • string

Сбой состояния.

notApplicable
  • string

Состояние неприменимо к целевому объекту.

notSet
  • string

Состояние состояния не задано. Состояние по умолчанию.

pending
  • string

Состояние ожидается.

succeeded
  • string

Состояние выполнено успешно.

IdentityRef

Name Type Description
_links

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

descriptor
  • string

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

directoryAlias
  • string
displayName
  • string

Это неуникальное отображаемое имя субъекта графа. Чтобы изменить это поле, необходимо изменить его значение в поставщике источника.

id
  • string
imageUrl
  • string
inactive
  • boolean
isAadIdentity
  • boolean
isContainer
  • boolean
profileUrl
  • string
uniqueName
  • string
url
  • string

Этот URL-адрес является полным маршрутом к исходному ресурсу этой темы графа.

PropertiesCollection

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

Name Type Description
count
  • integer

Количество свойств в коллекции.

item
  • object
keys
  • string[]

Набор ключей в коллекции.

values
  • string[]

Набор значений в коллекции.

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

Name Type Description
links
  • object

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