Items - Get
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/tfvc/items?path={path}&api-version=7.1-preview.1GET https://dev.azure.com/{organization}/{project}/_apis/tfvc/items?path={path}&fileName={fileName}&download={download}&scopePath={scopePath}&recursionLevel={recursionLevel}&versionDescriptor.version={versionDescriptor.version}&versionDescriptor.versionOption={versionDescriptor.versionOption}&versionDescriptor.versionType={versionDescriptor.versionType}&includeContent={includeContent}&api-version=7.1-preview.1Paramètres URI
| Nom | Dans | Obligatoire | Type | Description |
|---|---|---|---|---|
|
organization
|
path | True |
string |
Nom de l’organisation Azure DevOps. |
|
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 du contrôle de version d’un élément individuel à retourner. |
|
download
|
query |
boolean |
Si la valeur est true, créez une pièce jointe téléchargeable. |
|
|
file
|
query |
string |
nom de fichier de l’élément retourné. |
|
|
include
|
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. |
|
|
recursion
|
query |
Aucun (uniquement l’élément) ou OneLevel (contenu d’un dossier). |
||
|
scope
|
query |
string |
Chemin du contrôle de version d’un dossier pour retourner plusieurs éléments. |
|
|
version
|
query |
string |
Objet de version. |
|
|
version
|
query |
Descripteur de version. La valeur par défaut est Null. |
||
|
version
|
query |
Descripteur de version. La valeur par défaut est Null. |
Réponses
| Nom | Type | Description |
|---|---|---|
| 200 OK |
opération réussie Media Types: "text/plain", "application/octet-stream", "application/zip", "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
GET item metadata and/or content for a single item.
Sample Request
GET https://dev.azure.com/{organization}/_apis/tfvc/items?path=$/MyFirstProject/ExampleFolder/TestFile01.txt&api-version=7.1-preview.1
Sample Response
{
"version": 10,
"changeDate": "2019-05-29T18:00:23.457Z",
"size": 4,
"hashValue": "CY9rzUYh03PK3k6DJie09g==",
"encoding": 65001,
"path": "$/MyFirstProject/ExampleFolder/TestFile01.txt",
"contentMetadata": {
"encoding": 65001,
"contentType": "text/plain",
"fileName": "TestFile01.txt",
"extension": ".txt",
"vsLink": "vsweb://vs/?Product=Visual_Studio&Gen=2013&EncFormat=UTF8&tfslink=dnN0ZnM6Ly8vVmVyc2lvbkNvbnRyb2wvTGF1bmNoTGF0ZXN0VmVyc2lvbmVkSXRlbS8lMjQlMmZNeUZpcnN0UHJvamVjdCUyZkV4YW1wbGVGb2xkZXIlMmZUZXN0RmlsZTAxLnR4dD9wcm9qZWN0PTg3NDQ2MjJkLTdmMGUtNDZlZi04ZjViLWUxNzk2MjNhNGI1YyZ1cmw9aHR0cHMlM0ElMkYlMkZjb2RlZGV2Lm1zJTJGa2V2aW5tY3B6NDIwJTJG"
},
"url": "https://codedev.ms/fabrikam/_apis/tfvc/items/$/MyFirstProject/ExampleFolder/TestFile01.txt?versionType=Latest&versionOptions=None",
"_links": {
"self": {
"href": "https://codedev.ms/fabrikam/_apis/tfvc/items/$/MyFirstProject/ExampleFolder/TestFile01.txt?versionType=Changeset&version=10"
}
}
}Définitions
| Nom | Description |
|---|---|
|
File |
|
|
Reference |
Classe pour représenter une collection de liens de référence REST. |
|
Tfvc |
Métadonnées d’un élément. |
|
Tfvc |
La valeur par défaut est None. |
|
Tfvc |
La valeur par défaut est La plus récente. |
|
Version |
La valeur par défaut est OneLevel. |
FileContentMetadata
| Nom | Type | Description |
|---|---|---|
| contentType |
string |
|
| encoding |
integer |
|
| extension |
string |
|
| fileName |
string |
|
| isBinary |
boolean |
|
| isImage |
boolean |
|
| vsLink |
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. |
TfvcItem
Métadonnées d’un élément.
| Nom | Type | Description |
|---|---|---|
| _links |
Classe pour représenter une collection de liens de référence REST. |
|
| changeDate |
string |
Dateheure modifiée de l’élément. |
| content |
string |
|
| contentMetadata | ||
| deletionId |
integer |
Supérieur à 0 si l’élément est supprimé. |
| encoding |
integer |
Encodage de fichier à partir de la base de données, -1 représente 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 si une modification est en attente. |
| isSymLink |
boolean |
|
| path |
string |
|
| size |
integer |
Taille du fichier, le cas échéant. |
| url |
string |
|
| version |
integer |
Id de version de l’ensemble de modifications. |
TfvcVersionOption
La valeur par défaut est None.
| Nom | Type | Description |
|---|---|---|
| none |
string |
Aucun. |
| previous |
string |
Retourne la version précédente. |
| useRename |
string |
Usuable uniquement avec le type de version MergeSource et les versions entières, utilise l’identificateur RenameSource au lieu de l’identificateur de fusion. |
TfvcVersionType
La valeur par défaut est La plus récente.
| Nom | Type | Description |
|---|---|---|
| change |
string |
La version est traitée comme une modification. |
| changeset |
string |
La version est traitée comme un Objet ChangesetId. |
| date |
string |
La version est traitée comme une date. |
| latest |
string |
Si Version est défini, la dernière version de cette version est utilisée, si aucune version n’est définie, l’ensemble de modifications le plus récent est utilisé. |
| mergeSource |
string |
La version sera traitée comme un MergeSource. |
| none |
string |
La version est traitée comme un Objet ChangesetId. |
| shelveset |
string |
La version est traitée comme un nom et un propriétaire du jeu d’étagères. |
| tip |
string |
La version sera traitée comme un conseil. Si aucune version n’est définie la plus récente, elle sera utilisée. |
VersionControlRecursionType
La valeur par défaut est OneLevel.
| 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. |