Refs - Update Refs

参考

服务:: Git

API 版本:: 7.1

创建、更新或删除 refs（分支）。

更新 ref 意味着使其指向与以前不同的提交。必须同时指定旧提交和新提交以避免争用条件。

POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/refs?api-version=7.1

具有可选参数:

POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/refs?projectId={projectId}&api-version=7.1

URI 参数

名称	在	必需	类型	说明
organization	path	True	string	Azure DevOps 组织的名称。
repositoryId	path	True	string	存储库的名称或 ID。
project	path		string	项目 ID 或项目名称
api-version	query	True	string	要使用的 API 版本。这应设置为“7.1”才能使用此版本的 API。
projectId	query		string	团队项目的 ID 或名称。如果指定存储库的 ID，则为可选。

请求正文

名称	类型	说明
body	GitRefUpdate[]	要尝试执行的 ref 更新列表

响应

名称	类型	说明
200 OK	GitRefUpdateResult[]	成功作

安全性

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_write	授予读取、更新和删除源代码、访问有关提交、更改集、分支和其他版本控制项目的元数据的能力。此外，还授予创建和管理拉取请求和代码评审以及通过服务挂钩接收有关版本控制事件的通知的能力。

示例

Create/Update/Delete a ref by repositoryId

示例请求

HTTP

POST https://dev.azure.com/fabrikam/_apis/git/repositories/{repositoryId}/refs?api-version=7.1

[
  {
    "name": "refs/heads/vsts-api-sample/answer-woman-flame",
    "oldObjectId": "0000000000000000000000000000000000000000",
    "newObjectId": "ffe9cba521f00d7f60e322845072238635edb451"
  }
]

示例响应

状态代码:: 200

transfer-Encoding: chunked

{
  "value": [
    {
      "repositoryId": "d3d1760b-311c-4175-a726-20dfc6a7f885",
      "name": "refs/heads/vsts-api-sample/answer-woman-flame",
      "oldObjectId": "0000000000000000000000000000000000000000",
      "newObjectId": "ffe9cba521f00d7f60e322845072238635edb451",
      "isLocked": false,
      "updateStatus": "succeeded",
      "success": true
    }
  ],
  "count": 1
}

定义

名称	说明
GitRefUpdate
GitRefUpdateResult
GitRefUpdateStatus	TFS 服务器的更新状态。

GitRefUpdate

Object

名称	类型	说明
isLocked	boolean
name	string
newObjectId	string
oldObjectId	string
repositoryId	string (uuid)

GitRefUpdateResult