Labels - Get Label Items

Référence

Service:: Tfvc

Version d'API:: 7.1

Obtenir des éléments sous une étiquette.

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

Avec des paramètres facultatifs:

GET https://dev.azure.com/{organization}/_apis/tfvc/labels/{labelId}/items?$top={$top}&$skip={$skip}&api-version=7.1

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
labelId	path	True	string	Identificateur unique d’étiquette
organization	path	True	string	Nom de l’organisation Azure DevOps.
api-version	query	True	string	Version de l’API à utiliser. Cette valeur doit être définie sur « 7.1 » pour utiliser cette version de l’API.
$skip	query		integer (int32)	Nombre d’éléments à ignorer
$top	query		integer (int32)	Nombre maximal d’éléments à retourner

Réponses

Nom	Type	Description
200 OK	TfvcItem[]	opération réussie

Sécurité

oauth2

Type: oauth2
Flux: accessCode
URL d’autorisation: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL du jeton: 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

Étendues

Nom	Description
vso.code	Accorde la possibilité de lire le code source et les métadonnées sur les validations, les ensembles de modifications, les branches et d’autres artefacts de contrôle de version. Accorde également la possibilité de rechercher du code et d’être averti des événements de contrôle de version via des hooks de service.

Exemples

items

top and skip

items

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 200

{
  "count": 10,
  "value": [
    {
      "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"
    }
  ]
}

top and skip

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 200

{
  "count": 2,
  "value": [
    {
      "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"
    }
  ]
}

Définitions

Nom	Description
FileContentMetadata
ReferenceLinks	Classe à représenter une collection de liens de référence REST.
TfvcItem	Métadonnées d’un élément.

FileContentMetadata

Object

Nom	Type	Description
contentType	string
encoding	integer (int32)
extension	string
fileName	string
isBinary	boolean
isImage	boolean
vsLink	string

ReferenceLinks

Object

Classe à représenter une collection de liens de référence REST.

Nom	Type	Description
links	object	Vue en lecture seule des liens. Étant donné que les liens de référence sont en lecture seule, nous voulons uniquement les exposer en lecture seule.

TfvcItem

Object

Métadonnées d’un élément.

Nom	Type	Description
_links	ReferenceLinks	Classe à représenter une collection de liens de référence REST.
changeDate	string (date-time)	Élément modifié datetime.
content	string
contentMetadata	FileContentMetadata
deletionId	integer (int32)	Supérieur à 0 si l’élément est supprimé.
encoding	integer (int32)	L’encodage de fichiers à partir de la base de données, -1 représente le binaire.
hashValue	string	Le hachage MD5 en tant que chaîne de base 64 s’applique uniquement aux fichiers.
isBranch	boolean	True si l’élément est une branche.
isFolder	boolean
isPendingChange	boolean	True s’il existe une modification en attente.
isSymLink	boolean
path	string
size	integer (int64)	Taille du fichier, le cas échéant.
url	string
version	integer (int32)	ID de version de l’ensemble de modifications.

Partager via

Labels - Get Label Items

Paramètres URI

Réponses

Sécurité

oauth2

Étendues

Exemples

items

Exemple de requête

Exemple de réponse

top and skip

Exemple de requête

Exemple de réponse

Définitions

FileContentMetadata

ReferenceLinks

TfvcItem