Items - Get

Service:

Tfvc

API Version:

7.1-preview.1

Obtener metadatos de elemento o contenido para un solo elemento. El parámetro download es indicar si el contenido debe estar disponible como una descarga o simplemente enviarse como una secuencia en la respuesta. No se aplica al contenido comprimido que siempre se devuelve como descarga.

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

With optional parameters:

GET 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.1

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
organization	path	True	string	El nombre de la organización de Azure DevOps.
project	path		string	Id. de proyecto o nombre del proyecto
api-version	query	True	string	Versión de la API que se va a usar. Debe establecerse en "7.1-preview.1" para usar esta versión de la API.
path	query	True	string	Ruta de acceso de control de versiones de un elemento individual que se va a devolver.
download	query		boolean	Si es true, cree un archivo adjunto descargable.
fileName	query		string	nombre de archivo del elemento devuelto.
includeContent	query		boolean	Establézcalo en true para incluir contenido de elemento al solicitar json. El valor predeterminado es False.
recursionLevel	query		VersionControlRecursionType	Ninguno (solo el elemento) o OneLevel (contenido de una carpeta).
scopePath	query		string	Ruta de acceso de control de versiones de una carpeta para devolver varios elementos.
versionDescriptor.version	query		string	Objeto de versión.
versionDescriptor.versionOption	query		TfvcVersionOption	Descriptor de versión. El valor predeterminado es null.
versionDescriptor.versionType	query		TfvcVersionType	Descriptor de versión. El valor predeterminado es null.

Respuestas

Nombre	Tipo	Description
200 OK	TfvcItem	operación correcta Media Types: "text/plain", "application/octet-stream", "application/zip", "application/json"

Seguridad

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

Nombre	Description
vso.code	Concede la capacidad de leer código fuente y metadatos sobre confirmaciones, conjuntos de cambios, ramas y otros artefactos de control de versiones. También concede la capacidad de buscar código y recibir notificaciones sobre eventos de control de versiones a través de enlaces de servicio.

Ejemplos

GET item metadata and/or content for a single item.

Sample Request

HTTP

GET https://dev.azure.com/{organization}/_apis/tfvc/items?path=$/MyFirstProject/ExampleFolder/TestFile01.txt&api-version=7.1-preview.1

Sample Response

Status code:

200

{
  "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"
    }
  }
}

Definiciones

Nombre	Description
FileContentMetadata
ReferenceLinks	Clase que se va a representar una colección de vínculos de referencia de REST.
TfvcItem	Metadatos de un elemento.
TfvcVersionOption	El valor predeterminado es None.
TfvcVersionType	El valor predeterminado es Latest.
VersionControlRecursionType	El valor predeterminado es OneLevel.

FileContentMetadata

Nombre	Tipo	Description
contentType	string
encoding	integer
extension	string
fileName	string
isBinary	boolean
isImage	boolean
vsLink	string

ReferenceLinks

Clase que se va a representar una colección de vínculos de referencia de REST.

Nombre	Tipo	Description
links	object	Vista de lectura de los vínculos. Dado que los vínculos de referencia son de solo lectura, solo queremos exponerlos como de solo lectura.

TfvcItem

Metadatos de un elemento.

Nombre	Tipo	Description
_links	ReferenceLinks	Clase que se va a representar una colección de vínculos de referencia de REST.
changeDate	string	El elemento cambió datetime.
content	string
contentMetadata	FileContentMetadata
deletionId	integer	Mayor que 0 si se elimina el elemento.
encoding	integer	Codificación de archivos de la base de datos, -1 representa binario.
hashValue	string	El hash MD5 como cadena base 64 solo se aplica a los archivos.
isBranch	boolean	True si item es una rama.
isFolder	boolean
isPendingChange	boolean	True si hay un cambio pendiente.
isSymLink	boolean
path	string
size	integer	Tamaño del archivo, si procede.
url	string
version	integer	Identificador de versión del conjunto de cambios.

TfvcVersionOption

El valor predeterminado es None.

Nombre	Tipo	Description
none	string	Ninguno.
previous	string	Devuelve la versión anterior.
useRename	string	Solo se puede usar con el tipo de versión MergeSource y las versiones de enteros, usa el identificador RenameSource en lugar del identificador merge.

TfvcVersionType

El valor predeterminado es Latest.

Nombre	Tipo	Description
change	string	La versión se trata como un cambio.
changeset	string	La versión se trata como changesetId.
date	string	La versión se trata como una fecha.
latest	string	Si version se define la versión más reciente de esa versión se usará, si no se define ninguna versión, se usará changesetId más reciente.
mergeSource	string	La versión se tratará como MergeSource.
none	string	La versión se trata como changesetId.
shelveset	string	La versión se trata como un nombre y propietario del conjunto de estantes.
tip	string	La versión se tratará como sugerencia, si no se define ninguna versión más reciente.

VersionControlRecursionType

El valor predeterminado es OneLevel.

Nombre	Tipo	Description
full	string	Devolver el elemento especificado y todos los descendientes
none	string	Solo devuelve el elemento especificado.
oneLevel	string	Devuelve el elemento especificado y sus elementos secundarios directos.
oneLevelPlusNestedEmptyFolders	string	Devuelve el elemento especificado y sus elementos secundarios directos, así como cadenas recursivas de carpetas secundarias anidadas que solo contienen una sola carpeta.