Items - Get

Service:

Git

API Version:

7.1-preview.1

Obtenez les métadonnées d’élément et/ou le contenu d’un seul élément. Le paramètre download permet d’indiquer si le contenu doit être disponible en tant que téléchargement ou simplement envoyé en tant que flux dans la réponse. Ne s’applique pas au contenu compressé, qui est toujours retourné en tant que téléchargement.

GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/items?path={path}&api-version=7.1-preview.1

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/items?path={path}&scopePath={scopePath}&recursionLevel={recursionLevel}&includeContentMetadata={includeContentMetadata}&latestProcessedChange={latestProcessedChange}&download={download}&$format={$format}&versionDescriptor.version={versionDescriptor.version}&versionDescriptor.versionOptions={versionDescriptor.versionOptions}&versionDescriptor.versionType={versionDescriptor.versionType}&includeContent={includeContent}&resolveLfs={resolveLfs}&sanitize={sanitize}&api-version=7.1-preview.1

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
organization	path	True	string	Nom de l’organisation Azure DevOps.
repositoryId	path	True	string	Nom ou ID du dépôt.
project	path		string	ID de projet ou nom du projet
api-version	query	True	string	Version de l’API à utiliser. Cette valeur doit être définie sur « 7.1-preview.1 » pour utiliser cette version de l’API.
path	query	True	string	Chemin d’accès de l’élément.
$format	query		string	Si elle est spécifiée, l’en-tête de la demande d’acceptation HTTP est remplacée par « json » ou « zip ». Si $format est spécifié, api-version doit également être spécifié en tant que paramètre de requête.
download	query		boolean	Définissez sur true pour télécharger la réponse sous forme de fichier. La valeur par défaut est false.
includeContent	query		boolean	Définissez sur true pour inclure le contenu de l’élément lors de la demande json. La valeur par défaut est false.
includeContentMetadata	query		boolean	Définissez sur true pour inclure les métadonnées de contenu. La valeur par défaut est false.
latestProcessedChange	query		boolean	Définissez sur true pour inclure les dernières modifications. La valeur par défaut est false.
recursionLevel	query		VersionControlRecursionType	Niveau de récursivité de cette requête. La valeur par défaut est « none », aucune récursivité.
resolveLfs	query		boolean	Affectez la valeur true pour résoudre les fichiers de pointeur git LFS afin de retourner le contenu réel de Git LFS. La valeur par défaut est false.
sanitize	query		boolean	Définissez sur true pour nettoyer un fichier svg et le retourner en tant qu’image. Utile uniquement si le fichier svg est demandé. La valeur par défaut est false.
scopePath	query		string	Étendue du chemin d’accès. La valeur par défaut est null.
versionDescriptor.version	query		string	Identificateur de chaîne de version (nom de la balise/branche, SHA1 de la validation)
versionDescriptor.versionOptions	query		GitVersionOptions	Options de version : spécifiez des modificateurs supplémentaires à la version (par exemple, Précédent)
versionDescriptor.versionType	query		GitVersionType	Type de version (branche, balise ou commit). Détermine comment l’ID est interprété

Réponses

Nom	Type	Description
200 OK	GitItem	opération réussie Media Types: "application/zip", "text/plain", "application/octet-stream", "application/json"

Sécurité

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

Nom	Description
vso.code	Accorde la possibilité de lire le code source et les métadonnées sur les commits, 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 informé des événements de contrôle de version via des hooks de service.

Exemples

Download

Get metadata

Download

Sample Request

HTTP

GET https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/items?scopePath=/MyWebSite/MyWebSite/Views/Home/_Home.cshtml&download=true&api-version=7.1-preview.1

Sample Response

Status code:

200

{
  "count": 1,
  "value": [
    {
      "objectId": "61a86fdaa79e5c6f5fb6e4026508489feb6ed92c",
      "gitObjectType": "blob",
      "commitId": "23d0bc5b128a10056dc68afece360d8a0fabb014",
      "path": "/MyWebSite/MyWebSite/Views/Home/_Home.cshtml",
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/items/MyWebSite/MyWebSite/Views/Home/_Home.cshtml?versionType=Branch&versionOptions=None"
    }
  ]
}

Get metadata

Sample Request

HTTP

GET https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/items?scopePath=/MyWebSite/MyWebSite/Views/Home/_Home.cshtml&api-version=7.1-preview.1

Sample Response

Status code:

200

{
  "count": 1,
  "value": [
    {
      "objectId": "61a86fdaa79e5c6f5fb6e4026508489feb6ed92c",
      "gitObjectType": "blob",
      "commitId": "23d0bc5b128a10056dc68afece360d8a0fabb014",
      "path": "/MyWebSite/MyWebSite/Views/Home/_Home.cshtml",
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/items/MyWebSite/MyWebSite/Views/Home/_Home.cshtml?versionType=Branch&versionOptions=None"
    }
  ]
}

Définitions

Nom	Description
ChangeCountDictionary
FileContentMetadata
GitChange
GitCommitRef	Fournit des propriétés qui décrivent un commit Git et les métadonnées associées.
GitItem
GitObjectType	Type d’objet (Commit, Tree, Blob, Tag)
GitPushRef
GitStatus	Cette classe contient les métadonnées d’un service/extension qui publie un status.
GitStatusContext	Contexte d’état qui identifie de manière unique le status.
GitStatusState	État du status.
GitTemplate
GitUserDate	Informations utilisateur et date pour les opérations Git.
GitVersionOptions	Options de version : spécifiez des modificateurs supplémentaires à la version (par exemple, Précédent)
GitVersionType	Type de version (branche, balise ou commit). Détermine comment l’ID est interprété
IdentityRef
ItemContent
ItemContentType
ReferenceLinks	Classe pour représenter une collection de liens de référence REST.
ResourceRef
VersionControlChangeType	Type de modification apportée à l’élément.
VersionControlRecursionType	Spécifie s’il faut inclure les enfants (OneLevel), tous les descendants (Full) ou None

ChangeCountDictionary

FileContentMetadata

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

GitChange

Nom	Type	Description
changeId	integer	ID de la modification dans le groupe de modifications.
changeType	VersionControlChangeType	Type de modification apportée à l’élément.
item	string	Version actuelle.
newContent	ItemContent	Contenu de l’élément après la modification.
newContentTemplate	GitTemplate	Nouveau modèle de contenu à utiliser lors de l’envoi de nouvelles modifications.
originalPath	string	Chemin d’accès d’origine de l’élément s’il est différent du chemin actuel.
sourceServerItem	string	Chemin d’accès de l’élément sur le serveur.
url	string	URL pour récupérer l’élément.

GitCommitRef

Fournit des propriétés qui décrivent un commit Git et les métadonnées associées.

Nom	Type	Description
_links	ReferenceLinks	Collection de liens de référence REST associés.
author	GitUserDate	Auteur de la validation.
changeCounts	ChangeCountDictionary	Nombre de types de modifications (modifications, suppressions, etc.) inclus dans la validation.
changes	GitChange[]	Énumération des modifications incluses dans le commit.
comment	string	Commentaire ou message du commit.
commentTruncated	boolean	Indique si le commentaire est tronqué à partir du message de commentaire de validation Git complet.
commitId	string	ID (SHA-1) du commit.
commitTooManyChanges	boolean	Indique que la validation contient trop de modifications pour être affichées
committer	GitUserDate	Commiter du commit.
parents	string[]	Énumération des ID de validation parent pour cette validation.
push	GitPushRef	Envoi (push) associé à ce commit.
remoteUrl	string	Chemin d’URL distante du commit.
statuses	GitStatus[]	Liste des métadonnées status des services et des extensions qui peuvent associer des informations supplémentaires à la validation.
url	string	URL REST pour cette ressource.
workItems	ResourceRef[]	Liste des éléments de travail associés à cette validation.

GitItem

Nom	Type	Description
_links	ReferenceLinks	Classe pour représenter une collection de liens de référence REST.
commitId	string	SHA1 de l’élément de validation a été extrait à l’adresse
content	string
contentMetadata	FileContentMetadata
gitObjectType	GitObjectType	Type d’objet (Commit, Tree, Blob, Tag, ...)
isFolder	boolean
isSymLink	boolean
latestProcessedChange	GitCommitRef	Ref superficiel pour valider la dernière modification de cet élément Uniquement si latestProcessedChange est demandé Peut ne pas être exact si la dernière modification n’est pas encore mise en cache
objectId	string	ID d’objet Git
originalObjectId	string	ID d’objet Git
path	string
url	string

GitObjectType

Type d’objet (Commit, Tree, Blob, Tag)

Nom	Type	Description
bad	string
blob	string
commit	string
ext2	string
ofsDelta	string
refDelta	string
tag	string
tree	string

GitPushRef

Nom	Type	Description
_links	ReferenceLinks	Classe pour représenter une collection de liens de référence REST.
date	string
pushId	integer
pushedBy	IdentityRef
url	string

GitStatus

Cette classe contient les métadonnées d’un service/extension qui publie un status.

Nom	Type	Description
_links	ReferenceLinks	Liens de référence.
context	GitStatusContext	Contexte du status.
createdBy	IdentityRef	Identité qui a créé le status.
creationDate	string	Date et heure de création du status.
description	string	Description de l’état. Décrit généralement l’état actuel du status.
id	integer	Identificateur d’état.
state	GitStatusState	État du status.
targetUrl	string	URL avec status détails.
updatedDate	string	Date et heure de la dernière mise à jour du status.

GitStatusContext

Contexte d’état qui identifie de manière unique le status.

Nom	Type	Description
genre	string	Genre du status. En règle générale, le nom du service/de l’outil qui génère le status peut être vide.
name	string	Identificateur de nom du status, ne peut pas être null ou vide.

GitStatusState

État du status.

Nom	Type	Description
error	string	État avec une erreur.
failed	string	Échec de l’état.
notApplicable	string	L’état n’est pas applicable à l’objet cible.
notSet	string	État non défini. État par défaut.
pending	string	État en attente.
succeeded	string	État réussi.

GitTemplate

Nom	Type	Description
name	string	Nom du modèle
type	string	Type du modèle

GitUserDate

Informations utilisateur et date pour les opérations Git.

Nom	Type	Description
date	string	Date de l’opération Git.
email	string	Email adresse de l’utilisateur effectuant l’opération Git.
imageUrl	string	URL de l’avatar de l’utilisateur.
name	string	Nom de l’utilisateur effectuant l’opération Git.

GitVersionOptions

Options de version : spécifiez des modificateurs supplémentaires à la version (par exemple, Précédent)

Nom	Type	Description
firstParent	string	Premier parent de commit (HEAD^)
none	string	Non spécifié
previousChange	string	Valider l’élément modifié avant la version actuelle

GitVersionType

Type de version (branche, balise ou commit). Détermine comment l’ID est interprété

Nom	Type	Description
branch	string	Interpréter la version en tant que nom de branche
commit	string	Interpréter la version en tant qu’ID de validation (SHA1)
tag	string	Interpréter la version comme un nom de balise

IdentityRef

Nom	Type	Description
_links	ReferenceLinks	Ce champ contient zéro ou plus de liens intéressants sur l’objet du graphique. Ces liens peuvent être appelés pour obtenir des relations supplémentaires ou des informations plus détaillées sur ce sujet de graphique.
descriptor	string	Le descripteur est le principal moyen de référencer l’objet du graphique pendant l’exécution du système. Ce champ identifie de manière unique le même sujet de graphique dans les comptes et les organisations.
directoryAlias	string	Déconseillé : peut être récupéré en interrogeant l’utilisateur Graph référencé dans l’entrée « self » du dictionnaire IdentityRef « _links »
displayName	string	Il s’agit du nom d’affichage non unique de l’objet du graphique. Pour modifier ce champ, vous devez modifier sa valeur dans le fournisseur source.
id	string
imageUrl	string	Déprécié : disponible dans l’entrée « avatar » du dictionnaire IdentityRef « _links »
inactive	boolean	Déconseillé : peut être récupéré en interrogeant l’état d’appartenance Graph référencé dans l’entrée « membershipState » du dictionnaire GraphUser « _links »
isAadIdentity	boolean	Déprécié : peut être déduit du type d’objet du descripteur (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Déprécié : peut être déduit du type d’objet du descripteur (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Déconseillé : non utilisé dans la plupart des implémentations préexistantes de ToIdentityRef
uniqueName	string	Déconseillé : utilisez à la place Domain+PrincipalName
url	string	Cette URL est l’itinéraire complet vers la ressource source de ce sujet de graphique.

ItemContent

Nom	Type	Description
content	string
contentType	ItemContentType

ItemContentType

Nom	Type	Description
base64Encoded	string
rawText	string

ReferenceLinks

Classe pour 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 référence sont en lecture seule, nous voulons uniquement les exposer en lecture seule.

ResourceRef

Nom	Type	Description
id	string
url	string

VersionControlChangeType

Type de modification apportée à l’élément.

Nom	Type	Description
add	string
all	string
branch	string
delete	string
edit	string
encoding	string
lock	string
merge	string
none	string
property	string
rename	string
rollback	string
sourceRename	string
targetRename	string
undelete	string

VersionControlRecursionType

Spécifie s’il faut inclure les enfants (OneLevel), tous les descendants (Full) ou None

Nom	Type	Description
full	string	Retourner l’élément spécifié et tous les descendants
none	string	Retourne uniquement l’élément spécifié.
oneLevel	string	Retourne l’élément spécifié et ses enfants directs.
oneLevelPlusNestedEmptyFolders	string	Retourne l’élément spécifié et ses enfants directs, ainsi que des chaînes récursives de dossiers enfants imbriqués qui ne contiennent qu’un seul dossier.