Pull Request Statuses - Create

参考

Service:: Git

API Version:: 7.1-preview.1

创建拉取请求状态。

状态的唯一必填字段是 Context.Name 唯一标识状态的字段。请注意，可以在请求正文中指定 iterationId，以发布迭代的状态。

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

URI 参数

名称	在	必需	类型	说明
organization	path	True	string	Azure DevOps 组织的名称。
pullRequestId	path	True	integer int32	拉取请求的 ID。
repositoryId	path	True	string	拉取请求的目标分支的存储库 ID。
project	path		string	项目 ID 或项目名称
api-version	query	True	string	要使用的 API 版本。这应设置为“7.1-preview.1”才能使用此版本的 API。

请求正文

名称	类型	说明
_links	ReferenceLinks	参考链接。
context	GitStatusContext	状态的上下文。
createdBy	IdentityRef	创建状态的标识。
creationDate	string	状态的创建日期和时间。
description	string	状态说明。通常描述状态的当前状态。
id	integer	状态标识符。
iterationId	integer	要与状态关联的迭代的 ID。最小值为 1。
properties	PropertiesCollection	状态的自定义属性。
state	GitStatusState	状态的状态。
targetUrl	string	包含状态详细信息的 URL。
updatedDate	string	状态的上次更新日期和时间。

响应

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

安全性

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

名称	说明
vso.code_write	授予读取、更新和删除源代码、访问有关提交、更改集、分支和其他版本控制项目元数据的能力。此外，还授予创建和管理拉取请求和代码评审以及通过服务挂钩接收有关版本控制事件的通知的能力。
vso.code_status	授予读取和写入提交以及拉取请求状态的能力。

示例

On iteration

On pull request

With properties

On iteration

Sample Request

HTTP

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

{
  "iterationId": 1,
  "state": "succeeded",
  "description": "Sample status succeeded",
  "context": {
    "name": "sample-status-2",
    "genre": "vsts-samples"
  },
  "targetUrl": "http://fabrikam-fiber-inc.com/CI/builds/1"
}

Sample Response

Status code:: 200

{
  "iterationId": 1,
  "id": 1,
  "state": "succeeded",
  "description": "Sample status succeeded",
  "context": {
    "name": "sample-status-2",
    "genre": "vsts-samples"
  },
  "creationDate": "2017-09-19T14:50:26.4429056Z",
  "updatedDate": "2017-09-19T14:50:26.4429056Z",
  "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/2/statuses/1"
    },
    "repository": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/b92c8408-a0c9-4292-88af-bc005a1b8272"
    }
  }
}

On pull request

Sample Request

HTTP

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

{
  "state": "succeeded",
  "description": "Sample status succeeded",
  "context": {
    "name": "sample-status-4",
    "genre": "vsts-samples"
  },
  "targetUrl": "http://fabrikam-fiber-inc.com/CI/builds/1"
}

Sample Response

Status code:: 200

{
  "id": 1,
  "state": "succeeded",
  "description": "Sample status succeeded",
  "context": {
    "name": "sample-status-4",
    "genre": "vsts-samples"
  },
  "creationDate": "2017-09-19T14:50:25.1680228Z",
  "updatedDate": "2017-09-19T14:50:25.1680228Z",
  "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/1/statuses/1"
    },
    "repository": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/b92c8408-a0c9-4292-88af-bc005a1b8272"
    }
  }
}

With properties

Sample Request

HTTP

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

{
  "properties": {
    "sampleId": 7,
    "customInfo": "Custom status information",
    "startedDateTime": {
      "$type": "System.DateTime",
      "$value": "2017-09-19T14:50:26.7410146Z"
    },
    "weight": {
      "$type": "System.Double",
      "$value": 1.75
    },
    "bytes": {
      "$type": "System.Byte[]",
      "$value": "dGhpcyBpcyBzYW1wbGUgYmFzZTY0IGVuY29kZWQgc3RyaW5n"
    },
    "globalId": {
      "$type": "System.Guid",
      "$value": "1e788cb9-9d3d-4dc6-ac05-822092d17f90"
    }
  },
  "state": "succeeded",
  "description": "Sample status succeeded",
  "context": {
    "name": "sample-status-1",
    "genre": "vsts-samples"
  },
  "targetUrl": "http://fabrikam-fiber-inc.com/CI/builds/1"
}

Sample Response

Status code:: 200

{
  "properties": {
    "bytes": {
      "$type": "System.Byte[]",
      "$value": "dGhpcyBpcyBzYW1wbGUgYmFzZTY0IGVuY29kZWQgc3RyaW5n"
    },
    "customInfo": {
      "$type": "System.String",
      "$value": "Custom status information"
    },
    "globalId": {
      "$type": "System.String",
      "$value": "1e788cb99d3d4dc6ac05822092d17f90"
    },
    "sampleId": {
      "$type": "System.Int32",
      "$value": 7
    },
    "startedDateTime": {
      "$type": "System.DateTime",
      "$value": "2017-09-19T14:50:26.74Z"
    },
    "weight": {
      "$type": "System.Double",
      "$value": 1.75
    }
  },
  "id": 1,
  "state": "succeeded",
  "description": "Sample status succeeded",
  "context": {
    "name": "sample-status-1",
    "genre": "vsts-samples"
  },
  "creationDate": "2017-09-19T14:50:26.7780242Z",
  "updatedDate": "2017-09-19T14:50:26.7780242Z",
  "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/3/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

此类包含服务/扩展发布拉取请求状态的元数据。状态可与拉取请求或迭代相关联。

名称	类型	说明
_links	ReferenceLinks	参考链接。
context	GitStatusContext	状态的上下文。
createdBy	IdentityRef	创建状态的标识。
creationDate	string	状态的创建日期和时间。
description	string	状态说明。通常描述状态的当前状态。
id	integer	状态标识符。
iterationId	integer	要与状态关联的迭代的 ID。最小值为 1。
properties	PropertiesCollection	状态的自定义属性。
state	GitStatusState	状态的状态。
targetUrl	string	包含状态详细信息的 URL。
updatedDate	string	状态的上次更新日期和时间。

GitStatusContext

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

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

GitStatusState

状态的状态。

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

IdentityRef

名称	类型	说明
_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

类将属性包表示为键值对的集合。接受除之外DBNull的所有基元类型的值 (具有TypeCode != TypeCode.Object) 的任何类型。 Byte[]、Int32、Double、DateType 和 String 类型的值保留其类型，其他基元将重新调整为 String。 Byte[] 应为 base64 编码字符串。

名称	类型	说明
count	integer	集合中的属性计数。
item	object
keys	string[]	集合中的键集。
values	string[]	集合中的值集。

ReferenceLinks

表示 REST 引用链接集合的类。

名称	类型	说明
links	object	链接的只读视图。由于引用链接是只读的，因此我们只想将其公开为只读。

通过

Pull Request Statuses - Create

URI 参数

请求正文

响应

安全性

oauth2

Scopes

示例

On iteration

Sample Request

Sample Response

On pull request

Sample Request

Sample Response

With properties

Sample Request

Sample Response

定义

GitPullRequestStatus

GitStatusContext

GitStatusState

IdentityRef

PropertiesCollection

ReferenceLinks

其他资源