Items - Get

Referencia

Servicio:: Tfvc

Versión de la API:: 7.1

Obtener metadatos de elemento o contenido para un solo elemento. El parámetro de descarga es indicar si el contenido debe estar disponible como una descarga o simplemente enviar 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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
organization	path	True	string	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" 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 el contenido del 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 Version.
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"

Nombre

Tipo

Description

200 OK

TfvcItem

operación correcta

Media Types: "text/plain", "application/octet-stream", "application/zip", "application/json"

Seguridad

oauth2

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Dirección URL del token: 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

Ámbitos

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.

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

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 representa una colección de vínculos de referencia rest.
TfvcItem	Metadatos de un elemento.
TfvcVersionOption	El valor predeterminado es Ninguno.
TfvcVersionType	El valor predeterminado es Latest( Más reciente).
VersionControlRecursionType	El valor predeterminado es OneLevel.

FileContentMetadata

Object

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

ReferenceLinks

Object

Clase que representa una colección de vínculos de referencia rest.

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

TfvcItem

Object

Metadatos de un elemento.

Nombre	Tipo	Description
_links	ReferenceLinks	Clase que representa una colección de vínculos de referencia rest.
changeDate	string (date-time)	Elemento cambiado datetime.
content	string
contentMetadata	FileContentMetadata
deletionId	integer (int32)	Mayor que 0 si se elimina el elemento.
encoding	integer (int32)	La codificación de archivos de la base de datos -1 representa binario.
hashValue	string	El hash MD5 como una 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 (int64)	Tamaño del archivo, si procede.
url	string
version	integer (int32)	Identificador de versión del conjunto de cambios.

TfvcVersionOption

Enumeración

El valor predeterminado es Ninguno.

Valor	Description
none	Ninguno.
previous	Devuelve la versión anterior.
useRename	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

Enumeración

El valor predeterminado es Latest( Más reciente).

Valor	Description
change	La versión se trata como un cambio.
changeset	La versión se trata como changesetId.
date	La versión se trata como una fecha.
latest	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	La versión se tratará como MergeSource.
none	La versión se trata como changesetId.
shelveset	La versión se trata como un nombre y propietario del conjunto de estantes.
tip	La versión se tratará como sugerencia si no se define ninguna versión más reciente.

VersionControlRecursionType

Enumeración

El valor predeterminado es OneLevel.

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

Compartir a través de

Items - Get

Parámetros de identificador URI

Respuestas

Seguridad

oauth2

Ámbitos

Ejemplos

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

Solicitud de ejemplo

Respuesta de muestra

Definiciones

FileContentMetadata

ReferenceLinks

TfvcItem

TfvcVersionOption

TfvcVersionType

VersionControlRecursionType