Items - Get

Referencia

Service:: Git

API Version:: 7.1-preview.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 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/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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
organization	path	True	string	El nombre de la organización de Azure DevOps.
repositoryId	path	True	string	Nombre o identificador del repositorio.
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 del elemento.
$format	query		string	Si se especifica, esto invalida el encabezado de solicitud HTTP Accept para devolver "json" o "zip". Si se especifica $format, también se debe especificar api-version como parámetro de consulta.
download	query		boolean	Establézcalo en true para descargar la respuesta como un archivo. El valor predeterminado es False.
includeContent	query		boolean	Establézcalo en true para incluir el contenido del elemento al solicitar json. El valor predeterminado es False.
includeContentMetadata	query		boolean	Establézcalo en true para incluir metadatos de contenido. El valor predeterminado es False.
latestProcessedChange	query		boolean	Establézcalo en true para incluir los cambios más recientes. El valor predeterminado es False.
recursionLevel	query		VersionControlRecursionType	El nivel de recursividad de esta solicitud. El valor predeterminado es "none", sin recursividad.
resolveLfs	query		boolean	Establézcalo en true para resolver los archivos de puntero de Git LFS para devolver contenido real de Git LFS. El valor predeterminado es False.
sanitize	query		boolean	Establézcalo en true para sanear un archivo svg y devolverlo como imagen. Solo es útil si se solicita para el archivo svg. El valor predeterminado es False.
scopePath	query		string	Ámbito de la ruta de acceso. El valor predeterminado es null.
versionDescriptor.version	query		string	Identificador de cadena de versión (nombre de etiqueta/rama, SHA1 de confirmación)
versionDescriptor.versionOptions	query		GitVersionOptions	Opciones de versión: especifique modificadores adicionales para la versión (por ejemplo, Anterior)
versionDescriptor.versionType	query		GitVersionType	Tipo de versión (rama, etiqueta o confirmación). Determina cómo se interpreta id.

Respuestas

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

Nombre

Tipo

Description

200 OK

GitItem

operación correcta

Media Types: "application/zip", "text/plain", "application/octet-stream", "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

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

Definiciones

Nombre	Description
ChangeCountDictionary
FileContentMetadata
GitChange
GitCommitRef	Proporciona propiedades que describen una confirmación de Git y los metadatos asociados.
GitItem
GitObjectType	Tipo de objeto (Commit, Tree, Blob, Tag)
GitPushRef
GitStatus	Esta clase contiene los metadatos de un servicio o extensión que publica un estado.
GitStatusContext	Contexto de estado que identifica de forma única el estado.
GitStatusState	Estado del estado.
GitTemplate
GitUserDate	Información de usuario y fecha para las operaciones de Git.
GitVersionOptions	Opciones de versión: especifique modificadores adicionales para la versión (por ejemplo, Anterior)
GitVersionType	Tipo de versión (rama, etiqueta o confirmación). Determina cómo se interpreta id.
IdentityRef
ItemContent
ItemContentType
ReferenceLinks	Clase que se va a representar una colección de vínculos de referencia de REST.
ResourceRef
VersionControlChangeType	Tipo de cambio realizado en el elemento.
VersionControlRecursionType	Especifica si se deben incluir elementos secundarios (OneLevel), todos los descendientes (completo) o Ninguno.

ChangeCountDictionary

FileContentMetadata

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

GitChange

Nombre	Tipo	Description
changeId	integer	Identificador del cambio dentro del grupo de cambios.
changeType	VersionControlChangeType	Tipo de cambio realizado en el elemento.
item	string	Versión actual.
newContent	ItemContent	Contenido del elemento después del cambio.
newContentTemplate	GitTemplate	Nueva plantilla de contenido que se usará al insertar nuevos cambios.
originalPath	string	Ruta de acceso original del elemento si es diferente de la ruta de acceso actual.
sourceServerItem	string	Ruta de acceso del elemento en el servidor.
url	string	Dirección URL para recuperar el elemento.

GitCommitRef

Proporciona propiedades que describen una confirmación de Git y los metadatos asociados.

Nombre	Tipo	Description
_links	ReferenceLinks	Colección de vínculos de referencia de REST relacionados.
author	GitUserDate	Autor de la confirmación.
changeCounts	ChangeCountDictionary	Recuentos de los tipos de cambios (ediciones, eliminaciones, etc.) incluidos con la confirmación.
changes	GitChange[]	Enumeración de los cambios incluidos con la confirmación.
comment	string	Comentario o mensaje de la confirmación.
commentTruncated	boolean	Indica si el comentario se trunca desde el mensaje completo del comentario de confirmación de Git.
commitId	string	Identificador (SHA-1) de la confirmación.
commitTooManyChanges	boolean	Indica que la confirmación contiene demasiados cambios que se van a mostrar.
committer	GitUserDate	Committer de la confirmación.
parents	string[]	Enumeración de los identificadores de confirmación primarios para esta confirmación.
push	GitPushRef	Inserción asociada a esta confirmación.
remoteUrl	string	Ruta de acceso de dirección URL remota a la confirmación.
statuses	GitStatus[]	Lista de metadatos de estado de servicios y extensiones que pueden asociar información adicional a la confirmación.
url	string	Dirección URL de REST para este recurso.
workItems	ResourceRef[]	Lista de elementos de trabajo asociados a esta confirmación.

GitItem

Nombre	Tipo	Description
_links	ReferenceLinks	Clase que se va a representar una colección de vínculos de referencia de REST.
commitId	string	SHA1 del elemento de confirmación se capturó en
content	string
contentMetadata	FileContentMetadata
gitObjectType	GitObjectType	Tipo de objeto (Commit, Tree, Blob, Tag, ...)
isFolder	boolean
isSymLink	boolean
latestProcessedChange	GitCommitRef	Ref superficial para confirmar que este último elemento ha cambiado por última vez solo se rellena si se solicita latestProcessedChange Puede que no sea preciso si el cambio más reciente aún no está almacenado en caché.
objectId	string	Identificador de objeto de Git
originalObjectId	string	Identificador de objeto de Git
path	string
url	string

GitObjectType

Tipo de objeto (Commit, Tree, Blob, Tag)

Nombre	Tipo	Description
bad	string
blob	string
commit	string
ext2	string
ofsDelta	string
refDelta	string
tag	string
tree	string

GitPushRef

Nombre	Tipo	Description
_links	ReferenceLinks	Clase que se va a representar una colección de vínculos de referencia de REST.
date	string
pushId	integer
pushedBy	IdentityRef
url	string

GitStatus

Esta clase contiene los metadatos de un servicio o extensión que publica un estado.

Nombre	Tipo	Description
_links	ReferenceLinks	Vínculos de referencia.
context	GitStatusContext	Contexto del estado.
createdBy	IdentityRef	Identidad que creó el estado.
creationDate	string	Fecha y hora de creación del estado.
description	string	Descripción del estado. Normalmente se describe el estado actual del estado.
id	integer	Identificador de estado.
state	GitStatusState	Estado del estado.
targetUrl	string	Dirección URL con detalles de estado.
updatedDate	string	Fecha y hora de la última actualización del estado.

GitStatusContext

Contexto de estado que identifica de forma única el estado.

Nombre	Tipo	Description
genre	string	Género del estado. Normalmente, el nombre del servicio o herramienta que genera el estado puede estar vacío.
name	string	El identificador de nombre del estado no puede ser nulo ni estar vacío.

GitStatusState

Estado del estado.

Nombre	Tipo	Description
error	string	Estado con un error.
failed	string	Error de estado.
notApplicable	string	El estado no es aplicable al objeto de destino.
notSet	string	Estado de estado no establecido. Estado predeterminado.
pending	string	Estado pendiente.
succeeded	string	El estado se realizó correctamente.

GitTemplate

Nombre	Tipo	Description
name	string	Nombre de la plantilla
type	string	Tipo de la plantilla

GitUserDate

Información de usuario y fecha para las operaciones de Git.

Nombre	Tipo	Description
date	string	Fecha de la operación de Git.
email	string	Email dirección del usuario que realiza la operación de Git.
imageUrl	string	Dirección URL del avatar del usuario.
name	string	Nombre del usuario que realiza la operación de Git.

GitVersionOptions

Opciones de versión: especifique modificadores adicionales para la versión (por ejemplo, Anterior)

Nombre	Tipo	Description
firstParent	string	Primer elemento primario de confirmación (HEAD^)
none	string	Sin especificar
previousChange	string	Confirmar que cambió el elemento antes de la versión actual

GitVersionType

Tipo de versión (rama, etiqueta o confirmación). Determina cómo se interpreta id.

Nombre	Tipo	Description
branch	string	Interpretar la versión como un nombre de rama
commit	string	Interpretar la versión como un identificador de confirmación (SHA1)
tag	string	Interpretar la versión como un nombre de etiqueta

IdentityRef

Nombre	Tipo	Description
_links	ReferenceLinks	Este campo contiene cero o más vínculos interesantes sobre el tema del grafo. Estos vínculos se pueden invocar para obtener relaciones adicionales o información más detallada sobre este tema del grafo.
descriptor	string	El descriptor es la forma principal de hacer referencia al asunto del grafo mientras se ejecuta el sistema. Este campo identificará de forma única el mismo asunto del grafo en cuentas y organizaciones.
directoryAlias	string	En desuso: se puede recuperar consultando al usuario de Graph al que se hace referencia en la entrada "self" del diccionario identityRef "_links".
displayName	string	Este es el nombre para mostrar no único del asunto del grafo. Para cambiar este campo, debe modificar su valor en el proveedor de origen.
id	string
imageUrl	string	En desuso: disponible en la entrada "avatar" del diccionario "_links" de IdentityRef
inactive	boolean	En desuso: se puede recuperar consultando el estado de pertenencia de Graph al que se hace referencia en la entrada "membershipState" del diccionario GraphUser "_links".
isAadIdentity	boolean	En desuso: se puede deducir del tipo de asunto del descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	En desuso: se puede deducir del tipo de sujeto del descriptor (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	En desuso: no en uso en la mayoría de las implementaciones preexistentes de ToIdentityRef
uniqueName	string	En desuso: use Domain+PrincipalName en su lugar.
url	string	Esta dirección URL es la ruta completa al recurso de origen de este tema del grafo.

ItemContent

Nombre	Tipo	Description
content	string
contentType	ItemContentType

ItemContentType

Nombre	Tipo	Description
base64Encoded	string
rawText	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.

ResourceRef

Nombre	Tipo	Description
id	string
url	string

VersionControlChangeType

Tipo de cambio realizado en el elemento.

Nombre	Tipo	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

Especifica si se deben incluir elementos secundarios (OneLevel), todos los descendientes (completo) o Ninguno.

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.

Compartir a través de

Items - Get

Parámetros de identificador URI

Respuestas

Seguridad

oauth2

Scopes

Ejemplos

Download

Sample Request

Sample Response

Get metadata

Sample Request

Sample Response

Definiciones

ChangeCountDictionary

FileContentMetadata

GitChange

GitCommitRef

GitItem

GitObjectType

GitPushRef

GitStatus

GitStatusContext

GitStatusState

GitTemplate

GitUserDate

GitVersionOptions

GitVersionType

IdentityRef

ItemContent

ItemContentType

ReferenceLinks

ResourceRef

VersionControlChangeType

VersionControlRecursionType

Recursos adicionales