Branches - Get Branch Refs

参考

服务:: Tfvc

API 版本:: 7.1

获取指定 scopePath 下方的分支层次结构

GET https://dev.azure.com/{organization}/{project}/_apis/tfvc/branches?scopePath={scopePath}&api-version=7.1

具有可选参数:

GET https://dev.azure.com/{organization}/{project}/_apis/tfvc/branches?scopePath={scopePath}&includeDeleted={includeDeleted}&includeLinks={includeLinks}&api-version=7.1

URI 参数

名称	在	必需	类型	说明
organization	path	True	string	Azure DevOps 组织的名称。
project	path		string	项目 ID 或项目名称
api-version	query	True	string	要使用的 API 版本。这应设置为“7.1”才能使用此版本的 API。
scopePath	query	True	string	分支的完整路径。默认值：$/ 示例：$/、$/MyProject、$/MyProject/SomeFolder。
includeDeleted	query		boolean	返回已删除的分支。默认值：False
includeLinks	query		boolean	返回链接。默认值：False

响应

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

安全性

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	授予读取有关提交、更改集、分支和其他版本控制项目的源代码和元数据的能力。此外，还可以通过服务挂钩搜索代码并获取有关版本控制事件的通知。

示例

GET a list of branch refs

GET a list of branch refs including deleted

GET a list of branch refs with links

GET a list of branch refs

示例请求

HTTP

GET https://dev.azure.com/{organization}/_apis/tfvc/branches?scopePath=$/&api-version=7.1

示例响应

状态代码:: 200

{
  "count": 2,
  "value": [
    {
      "path": "$/Project01/ExampleFolder",
      "owner": {
        "displayName": "Chuck Reinhart",
        "url": "https://vssps.codedev.ms/e/MSFT/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
        "id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
        "uniqueName": "fabrikamfiber3@hotmail.com",
        "imageUrl": "https://codedev.ms/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
      },
      "createdDate": "2019-04-12T14:28:02.703Z",
      "url": "https://codedev.ms/fabrikam/_apis/tfvc/branches/$/Project01/ExampleFolder"
    },
    {
      "path": "$/Project01/ExampleFolder-branch",
      "description": "Sample Branch",
      "owner": {
        "displayName": "Chuck Reinhart",
        "url": "https://vssps.codedev.ms/e/MSFT/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
        "id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
        "uniqueName": "fabrikamfiber3@hotmail.com",
        "imageUrl": "https://codedev.ms/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
      },
      "createdDate": "2019-04-12T14:28:13.27Z",
      "url": "https://codedev.ms/fabrikam/_apis/tfvc/branches/$/Project01/ExampleFolder-branch"
    }
  ]
}

GET a list of branch refs including deleted

示例请求

HTTP

GET https://dev.azure.com/{organization}/_apis/tfvc/branches?scopePath=$/&includeDeleted=True&api-version=7.1

示例响应

状态代码:: 200

{
  "count": 3,
  "value": [
    {
      "path": "$/Project01/ExampleFolder",
      "owner": {
        "displayName": "Chuck Reinhart",
        "url": "https://vssps.codedev.ms/e/MSFT/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
        "id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
        "uniqueName": "fabrikamfiber3@hotmail.com",
        "imageUrl": "https://codedev.ms/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
      },
      "createdDate": "2019-04-12T14:28:02.703Z",
      "url": "https://codedev.ms/fabrikam/_apis/tfvc/branches/$/Project01/ExampleFolder"
    },
    {
      "path": "$/Project01/ExampleFolder-branch",
      "description": "Sample Branch",
      "owner": {
        "displayName": "Chuck Reinhart",
        "url": "https://vssps.codedev.ms/e/MSFT/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
        "id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
        "uniqueName": "fabrikamfiber3@hotmail.com",
        "imageUrl": "https://codedev.ms/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
      },
      "createdDate": "2019-04-12T14:28:13.27Z",
      "url": "https://codedev.ms/fabrikam/_apis/tfvc/branches/$/Project01/ExampleFolder-branch"
    },
    {
      "path": "$/Project01/ExampleFolder-branch1",
      "description": "Branched from $/Project01/ExampleFolder",
      "owner": {
        "displayName": "Chuck Reinhart",
        "url": "https://vssps.codedev.ms/e/MSFT/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
        "id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
        "uniqueName": "fabrikamfiber3@hotmail.com",
        "imageUrl": "https://codedev.ms/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
      },
      "createdDate": "2019-04-12T14:28:35.033Z",
      "isDeleted": true,
      "url": "https://codedev.ms/fabrikam/_apis/tfvc/branches/$/Project01/ExampleFolder-branch1"
    }
  ]
}

GET a list of branch refs with links

示例请求

HTTP

GET https://dev.azure.com/{organization}/_apis/tfvc/branches?scopePath=$/&includeLinks=True&api-version=7.1

示例响应

状态代码:: 200

{
  "count": 2,
  "value": [
    {
      "_links": {
        "self": {
          "href": "https://codedev.ms/fabrikam/_apis/tfvc/branches/$/Project01/ExampleFolder"
        },
        "owner": {
          "href": "https://vssps.codedev.ms/e/MSFT/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
        }
      },
      "path": "$/Project01/ExampleFolder",
      "owner": {
        "displayName": "Chuck Reinhart",
        "url": "https://vssps.codedev.ms/e/MSFT/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
        "id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
        "uniqueName": "fabrikamfiber3@hotmail.com",
        "imageUrl": "https://codedev.ms/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
      },
      "createdDate": "2019-04-12T14:28:02.703Z",
      "url": "https://codedev.ms/fabrikam/_apis/tfvc/branches/$/Project01/ExampleFolder"
    },
    {
      "_links": {
        "self": {
          "href": "https://codedev.ms/fabrikam/_apis/tfvc/branches/$/Project01/ExampleFolder-branch"
        },
        "owner": {
          "href": "https://vssps.codedev.ms/e/MSFT/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
        }
      },
      "path": "$/Project01/ExampleFolder-branch",
      "description": "Sample Branch",
      "owner": {
        "displayName": "Chuck Reinhart",
        "url": "https://vssps.codedev.ms/e/MSFT/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
        "id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
        "uniqueName": "fabrikamfiber3@hotmail.com",
        "imageUrl": "https://codedev.ms/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
      },
      "createdDate": "2019-04-12T14:28:13.27Z",
      "url": "https://codedev.ms/fabrikam/_apis/tfvc/branches/$/Project01/ExampleFolder-branch"
    }
  ]
}

定义

名称	说明
IdentityRef
ReferenceLinks	表示 REST 引用链接集合的类。
TfvcBranchRef	Branchref 的元数据。

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 是指向此图形主题的源资源的完整路由。

ReferenceLinks

Object

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

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

TfvcBranchRef

Object

Branchref 的元数据。

名称	类型	说明
_links	ReferenceLinks	REST 引用链接的集合。
createdDate	string (date-time)	分支的创建日期。
description	string	分支说明。
isDeleted	boolean	是否删除了分支？
owner	IdentityRef	用户的别名或显示名称
path	string	分支的路径。
url	string	用于检索项的 URL。

通过

Branches - Get Branch Refs

URI 参数

响应

安全性

oauth2

作用域

示例

GET a list of branch refs

示例请求

示例响应

GET a list of branch refs including deleted

示例请求

示例响应

GET a list of branch refs with links

示例请求

示例响应

定义

IdentityRef

ReferenceLinks

TfvcBranchRef