Labels - List

参考

服务:: Tfvc

API 版本:: 7.1

获取浅表标签引用的集合。

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

具有可选参数:

GET https://dev.azure.com/{organization}/{project}/_apis/tfvc/labels?requestData.includeLinks={requestData.includeLinks}&requestData.itemLabelFilter={requestData.itemLabelFilter}&requestData.labelScope={requestData.labelScope}&requestData.maxItemCount={requestData.maxItemCount}&requestData.name={requestData.name}&requestData.owner={requestData.owner}&$top={$top}&$skip={$skip}&api-version=7.1

URI 参数

名称	在	必需	类型	说明
organization	path	True	string	Azure DevOps 组织的名称。
project	path		string	项目 ID 或项目名称
api-version	query	True	string	要使用的 API 版本。这应设置为“7.1”才能使用此版本的 API。
$skip	query		integer (int32)	要跳过的标签数
$top	query		integer (int32)	要返回的最大标签数，未定义时默认为 100
requestData.includeLinks	query		boolean	是否在浅层引用中包含_links字段
requestData.itemLabelFilter	query		string	labelScope、name、owner 和 itemLabelFilter
requestData.labelScope	query		string	labelScope、name、owner 和 itemLabelFilter
requestData.maxItemCount	query		integer (int32)	labelScope、name、owner 和 itemLabelFilter
requestData.name	query		string	labelScope、name、owner 和 itemLabelFilter
requestData.owner	query		string	labelScope、name、owner 和 itemLabelFilter

响应

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

安全性

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

示例

itemLabelFilter

Labels

Name

Owner

top and skip

itemLabelFilter

示例请求

HTTP

GET https://dev.azure.com/fabrikam/_apis/tfvc/labels?requestData.itemLabelFilter=$/Fabrikam-Fiber-TFVC/AuthSample-Dev/Code/AuthSample.cs&api-version=7.1

示例响应

状态代码:: 200

{
  "count": 1,
  "value": [
    {
      "id": 2883,
      "name": "That label",
      "description": "",
      "labelScope": "$/Fabrikam-Fiber-TFVC",
      "modifiedDate": "2014-03-24T18:56:32.097Z",
      "owner": {
        "id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabrikamfiber3@hotmail.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
      },
      "url": "https://dev.azure.com/fabrikam/_apis/tfvc/labels/2883"
    }
  ]
}

Labels

示例请求

HTTP

GET https://dev.azure.com/fabrikam/_apis/tfvc/labels?api-version=7.1

示例响应

状态代码:: 200

{
  "count": 3,
  "value": [
    {
      "id": 2884,
      "name": "Another label",
      "description": "",
      "labelScope": "$/Fabrikam-Fiber-TFVC",
      "modifiedDate": "2014-03-24T19:10:53.22Z",
      "owner": {
        "id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabrikamfiber3@hotmail.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
      },
      "url": "https://dev.azure.com/fabrikam/_apis/tfvc/labels/2884"
    },
    {
      "id": 2883,
      "name": "That label",
      "description": "",
      "labelScope": "$/Fabrikam-Fiber-TFVC",
      "modifiedDate": "2014-03-24T18:56:32.097Z",
      "owner": {
        "id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabrikamfiber3@hotmail.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
      },
      "url": "https://dev.azure.com/fabrikam/_apis/tfvc/labels/2883"
    },
    {
      "id": 2882,
      "name": "This label",
      "description": "",
      "labelScope": "$/Fabrikam-Fiber-TFVC",
      "modifiedDate": "2014-03-24T18:56:21.77Z",
      "owner": {
        "id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabrikamfiber3@hotmail.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
      },
      "url": "https://dev.azure.com/fabrikam/_apis/tfvc/labels/2882"
    }
  ]
}

Name

示例请求

HTTP

GET https://dev.azure.com/fabrikam/_apis/tfvc/labels?requestData.name=Th*Label&api-version=7.1

示例响应

状态代码:: 200

{
  "count": 2,
  "value": [
    {
      "id": 2883,
      "name": "That label",
      "description": "",
      "labelScope": "$/Fabrikam-Fiber-TFVC",
      "modifiedDate": "2014-03-24T18:56:32.097Z",
      "owner": {
        "id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabrikamfiber3@hotmail.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
      },
      "url": "https://dev.azure.com/fabrikam/_apis/tfvc/labels/2883"
    },
    {
      "id": 2882,
      "name": "This label",
      "description": "",
      "labelScope": "$/Fabrikam-Fiber-TFVC",
      "modifiedDate": "2014-03-24T18:56:21.77Z",
      "owner": {
        "id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabrikamfiber3@hotmail.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
      },
      "url": "https://dev.azure.com/fabrikam/_apis/tfvc/labels/2882"
    }
  ]
}

Owner

示例请求

HTTP

GET https://dev.azure.com/fabrikam/_apis/tfvc/labels?requestData.owner=fabrikamfiber3@hotmail.com&api-version=7.1

示例响应

状态代码:: 200

{
  "count": 3,
  "value": [
    {
      "id": 2884,
      "name": "Another label",
      "description": "",
      "labelScope": "$/Fabrikam-Fiber-TFVC",
      "modifiedDate": "2014-03-24T19:10:53.22Z",
      "owner": {
        "id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabrikamfiber3@hotmail.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
      },
      "url": "https://dev.azure.com/fabrikam/_apis/tfvc/labels/2884"
    },
    {
      "id": 2883,
      "name": "That label",
      "description": "",
      "labelScope": "$/Fabrikam-Fiber-TFVC",
      "modifiedDate": "2014-03-24T18:56:32.097Z",
      "owner": {
        "id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabrikamfiber3@hotmail.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
      },
      "url": "https://dev.azure.com/fabrikam/_apis/tfvc/labels/2883"
    },
    {
      "id": 2882,
      "name": "This label",
      "description": "",
      "labelScope": "$/Fabrikam-Fiber-TFVC",
      "modifiedDate": "2014-03-24T18:56:21.77Z",
      "owner": {
        "id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabrikamfiber3@hotmail.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
      },
      "url": "https://dev.azure.com/fabrikam/_apis/tfvc/labels/2882"
    }
  ]
}

top and skip

示例请求

HTTP

GET https://dev.azure.com/fabrikam/_apis/tfvc/labels?$top=2&$skip=2&api-version=7.1

示例响应

状态代码:: 200

{
  "count": 1,
  "value": [
    {
      "id": 2882,
      "name": "This label",
      "description": "",
      "labelScope": "$/Fabrikam-Fiber-TFVC",
      "modifiedDate": "2014-03-24T18:56:21.77Z",
      "owner": {
        "id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabrikamfiber3@hotmail.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
      },
      "url": "https://dev.azure.com/fabrikam/_apis/tfvc/labels/2882"
    }
  ]
}

定义

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

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	链接的只读视图。由于引用链接是只读的，因此我们只想将其公开为只读链接。

TfvcLabelRef

Object

标签的元数据。

名称	类型	说明
_links	ReferenceLinks	引用链接的集合。
description	string	标签说明。
id	integer (int32)	标签 ID。
labelScope	string	标签范围。
modifiedDate	string (date-time)	标签的上次修改日期/时间。
name	string	标签名称。
owner	IdentityRef	标签所有者。
url	string	标签 URL。

通过

Labels - List

URI 参数

响应

安全性

oauth2

作用域

示例

itemLabelFilter

示例请求

示例响应

Labels

示例请求

示例响应

Name

示例请求

示例响应

Owner

示例请求

示例响应

top and skip

示例请求

示例响应

定义

IdentityRef

ReferenceLinks

TfvcLabelRef

其他资源