Labels - Get

Reference

Service:: Tfvc

API Version:: 7.1-preview.1

Get a single deep label.

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

With optional parameters:

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

URI Parameters

Name	In	Required	Type	Description
labelId	path	True	string	Unique identifier of label
organization	path	True	string	The name of the Azure DevOps organization.
project	path		string	Project ID or project name
api-version	query	True	string	Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.
requestData.includeLinks	query		boolean	Whether to include the _links field on the shallow references
requestData.itemLabelFilter	query		string	maxItemCount
requestData.labelScope	query		string	maxItemCount
requestData.maxItemCount	query		integer int32	maxItemCount
requestData.name	query		string	maxItemCount
requestData.owner	query		string	maxItemCount

Responses

Name	Type	Description
200 OK	TfvcLabel	successful operation

Security

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

Name	Description
vso.code	Grants the ability to read source code and metadata about commits, changesets, branches, and other version control artifacts. Also grants the ability to search code and get notified about version control events via service hooks.

Examples

labelId

maxItemCount

labelId

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/_apis/tfvc/labels/2883"
    },
    "items": {
      "href": "https://dev.azure.com/fabrikam/_apis/tfvc/labels/2883/items"
    },
    "owner": {
      "href": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
    }
  },
  "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"
}

maxItemCount

Sample Request

HTTP

GET https://dev.azure.com/fabrikam/_apis/tfvc/labels/2883?requestData.maxItemCount=100&api-version=7.1-preview.1

Sample Response

Status code:: 200

{
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/_apis/tfvc/labels/2883"
    },
    "items": {
      "href": "https://dev.azure.com/fabrikam/_apis/tfvc/labels/2883/items"
    },
    "owner": {
      "href": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
    }
  },
  "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"
  },
  "items": [
    {
      "version": 12,
      "path": "$/Fabrikam-Fiber-TFVC/AuthSample-dev/AuthSample.sln",
      "url": "https://dev.azure.com/fabrikam/_apis/tfvc/items/%24/Fabrikam-Fiber-TFVC/AuthSample-dev/AuthSample.sln?versionType=Changeset&version=12"
    },
    {
      "version": 12,
      "path": "$/Fabrikam-Fiber-TFVC/AuthSample-dev/AuthSample.vssscc",
      "url": "https://dev.azure.com/fabrikam/_apis/tfvc/items/%24/Fabrikam-Fiber-TFVC/AuthSample-dev/AuthSample.vssscc?versionType=Changeset&version=12"
    },
    {
      "version": 12,
      "path": "$/Fabrikam-Fiber-TFVC/AuthSample-dev/Code",
      "isFolder": true,
      "url": "https://dev.azure.com/fabrikam/_apis/tfvc/items/%24/Fabrikam-Fiber-TFVC/AuthSample-dev/Code?versionType=Changeset&version=12"
    },
    {
      "version": 12,
      "path": "$/Fabrikam-Fiber-TFVC/AuthSample-dev/Code/App.config",
      "url": "https://dev.azure.com/fabrikam/_apis/tfvc/items/%24/Fabrikam-Fiber-TFVC/AuthSample-dev/Code/App.config?versionType=Changeset&version=12"
    },
    {
      "version": 12,
      "path": "$/Fabrikam-Fiber-TFVC/AuthSample-dev/Code/AuthSample.cs",
      "url": "https://dev.azure.com/fabrikam/_apis/tfvc/items/%24/Fabrikam-Fiber-TFVC/AuthSample-dev/Code/AuthSample.cs?versionType=Changeset&version=12"
    },
    {
      "version": 12,
      "path": "$/Fabrikam-Fiber-TFVC/AuthSample-dev/Code/AuthSample.csproj.vspscc",
      "url": "https://dev.azure.com/fabrikam/_apis/tfvc/items/%24/Fabrikam-Fiber-TFVC/AuthSample-dev/Code/AuthSample.csproj.vspscc?versionType=Changeset&version=12"
    },
    {
      "version": 12,
      "path": "$/Fabrikam-Fiber-TFVC/AuthSample-dev/Code/AuthSample.csproj",
      "url": "https://dev.azure.com/fabrikam/_apis/tfvc/items/%24/Fabrikam-Fiber-TFVC/AuthSample-dev/Code/AuthSample.csproj?versionType=Changeset&version=12"
    },
    {
      "version": 12,
      "path": "$/Fabrikam-Fiber-TFVC/AuthSample-dev/Code/Properties",
      "isFolder": true,
      "url": "https://dev.azure.com/fabrikam/_apis/tfvc/items/%24/Fabrikam-Fiber-TFVC/AuthSample-dev/Code/Properties?versionType=Changeset&version=12"
    },
    {
      "version": 12,
      "path": "$/Fabrikam-Fiber-TFVC/AuthSample-dev/Code/Properties/AssemblyInfo.cs",
      "url": "https://dev.azure.com/fabrikam/_apis/tfvc/items/%24/Fabrikam-Fiber-TFVC/AuthSample-dev/Code/Properties/AssemblyInfo.cs?versionType=Changeset&version=12"
    },
    {
      "version": 12,
      "path": "$/Fabrikam-Fiber-TFVC/AuthSample-dev",
      "isFolder": true,
      "url": "https://dev.azure.com/fabrikam/_apis/tfvc/items/%24/Fabrikam-Fiber-TFVC/AuthSample-dev?versionType=Changeset&version=12"
    }
  ],
  "url": "https://dev.azure.com/fabrikam/_apis/tfvc/labels/2883"
}

Definitions

Name	Description
FileContentMetadata
IdentityRef
ReferenceLinks	The class to represent a collection of REST reference links.
TfvcItem	Metadata for an item.
TfvcLabel	Metadata for a label.

FileContentMetadata

Name	Type	Description
contentType	string
encoding	integer
extension	string
fileName	string
isBinary	boolean
isImage	boolean
vsLink	string

IdentityRef

Name	Type	Description
_links	ReferenceLinks	This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject.
descriptor	string	The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.
directoryAlias	string	Deprecated - Can be retrieved by querying the Graph user referenced in the "self" entry of the IdentityRef "_links" dictionary
displayName	string	This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.
id	string
imageUrl	string	Deprecated - Available in the "avatar" entry of the IdentityRef "_links" dictionary
inactive	boolean	Deprecated - Can be retrieved by querying the Graph membership state referenced in the "membershipState" entry of the GraphUser "_links" dictionary
isAadIdentity	boolean	Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Deprecated - not in use in most preexisting implementations of ToIdentityRef
uniqueName	string	Deprecated - use Domain+PrincipalName instead
url	string	This url is the full route to the source resource of this graph subject.

ReferenceLinks

The class to represent a collection of REST reference links.

Name	Type	Description
links	object	The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.

TfvcItem

Metadata for an item.

Name	Type	Description
_links	ReferenceLinks	The class to represent a collection of REST reference links.
changeDate	string	Item changed datetime.
content	string
contentMetadata	FileContentMetadata
deletionId	integer	Greater than 0 if item is deleted.
encoding	integer	File encoding from database, -1 represents binary.
hashValue	string	MD5 hash as a base 64 string, applies to files only.
isBranch	boolean	True if item is a branch.
isFolder	boolean
isPendingChange	boolean	True if there is a change pending.
isSymLink	boolean
path	string
size	integer	The size of the file, if applicable.
url	string
version	integer	Changeset version Id.

TfvcLabel

Metadata for a label.

Name	Type	Description
_links	ReferenceLinks	Collection of reference links.
description	string	Label description.
id	integer	Label Id.
items	TfvcItem[]	List of items.
labelScope	string	Label scope.
modifiedDate	string	Last modified datetime for the label.
name	string	Label name.
owner	IdentityRef	Label owner.
url	string	Label Url.

Labels - Get

URI Parameters

Responses

Security

oauth2

Scopes

Examples

labelId

Sample Request

Sample Response

maxItemCount

Sample Request

Sample Response

Definitions

FileContentMetadata

IdentityRef

ReferenceLinks

TfvcItem

TfvcLabel

Feedback

Additional resources