Pull Request Statuses - Get

参考

服务:: Git

API 版本:: 7.1

按 ID 获取特定的拉取请求状态。在所有迭代的拉取请求中，状态 ID 是唯一的。

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)	拉取请求的 ID。
repositoryId	path	True	string	拉取请求的目标分支的存储库 ID。
statusId	path	True	integer (int32)	拉取请求状态的 ID。
project	path		string	项目 ID 或项目名称
api-version	query	True	string	要使用的 API 版本。这应设置为“7.1”才能使用此版本的 API。

响应

名称	类型	说明
200 OK	GitPullRequestStatus	成功作

安全性

oauth2

类型: oauth2
流向: 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	授予读取和写入提交和拉取请求状态的能力。

示例

示例请求

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	类将属性包表示为键值对的集合。接受除 `DBNull` 以外的所有基元类型（具有 `TypeCode != TypeCode.Object`的任何类型）的值。 Byte[]、Int32、Double、DateType 和 String 类型的值将保留其类型，其他基元将重新调整为 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)	要与状态关联的迭代的 ID。最小值为 1。
properties	PropertiesCollection	状态的自定义属性。
state	GitStatusState	状态。
targetUrl	string	包含状态详细信息的 URL。
updatedDate	string (date-time)	状态的上次更新日期和时间。

GitStatusContext

Object

唯一标识状态的状态上下文。

名称	类型	说明
genre	string	状态的流派。通常，生成状态的服务/工具的名称可以为空。
name	string	状态的名称标识符不能为 null 或为空。

GitStatusState

枚举

状态。

值	说明
error	状态，出现错误。
failed	状态失败。
notApplicable	状态不适用于目标对象。
notSet	未设置状态。默认状态。
pending	状态挂起。
succeeded	状态成功。

IdentityRef

Object

名称	类型	说明
_links	ReferenceLinks	此字段包含有关图形主题的零个或多个有趣的链接。可以调用这些链接以获取有关此图形主题的其他关系或更详细的信息。
descriptor	string	描述符是在系统运行时引用图形主题的主要方法。此字段将唯一标识帐户和组织中的同一图形主题。
directoryAlias	string	已弃用 - 可以通过查询 IdentityRef“_links”字典的“self”条目中引用的 Graph 用户来检索
displayName	string	这是图形主题的非唯一显示名称。若要更改此字段，必须在源提供程序中更改其值。
id	string
imageUrl	string	已弃用 - 在 IdentityRef“_links”字典的“虚拟形象”条目中可用
inactive	boolean	已弃用 - 可以通过查询 GraphUser“_links”字典的“membershipState”条目中引用的 Graph 成员身份状态来检索
isAadIdentity	boolean	已弃用 - 可以从描述符的主题类型推断（Descriptor.IsAadUserType/Descriptor.IsAadGroupType）
isContainer	boolean	已弃用 - 可以从描述符的主题类型推断（描述符.IsGroupType）
isDeletedInOrigin	boolean
profileUrl	string	已弃用 - 不在 ToIdentityRef 的大多数预先存在的实现中使用
uniqueName	string	已弃用 - 请改用 Domain+PrincipalName
url	string	此 URL 是指向此图形主题的源资源的完整路由。

PropertiesCollection

Object

类将属性包表示为键值对的集合。接受除 DBNull 以外的所有基元类型（具有 TypeCode != TypeCode.Object的任何类型）的值。 Byte[]、Int32、Double、DateType 和 String 类型的值将保留其类型，其他基元将重新调整为 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

其他资源