Tipo de recurso driveItemdriveItem resource type

El recurso driveItem representa un archivo, una carpeta u otro elemento almacenado en una unidad. Todos los objetos del sistema de archivos en OneDrive y SharePoint se devuelven como recursos de driveItem.The driveItem resource represents a file, folder, or other item stored in a drive. All file system objects in OneDrive and SharePoint are returned as driveItem resources.

Hay dos maneras principales de abordar un recurso driveItem:There are two primary ways of addressing a driveItem resource:

  • Con el identificador único driveItem utilizando drive/items/{item-id}By the driveItem unique identifier using drive/items/{item-id}
  • Con la ruta de acceso del sistema de archivos mediante /drive/root:/path/to/fileBy file system path using /drive/root:/path/to/file

Los recursos driveItem tienen facetas modeladas como propiedades que proporcionan datos sobre las identidades y las capacidades de driveItem.driveItem resources have facets modeled as properties that provide data about the driveItem's identities and capabilities. Por ejemplo:For example:

  • Las carpetas tienen una faceta folder.Folders have a folder facet
  • Los archivos tienen una faceta file.Files have a file facet.
  • Las imágenes tienen una faceta image, además de su faceta file.Images have an image facet in addition to their file facet.
  • Las imágenes tomadas con una cámara (fotos) tienen una faceta photo que identifica el elemento como una foto. Además, facilita las propiedades que indican cuándo se tomó la foto y con qué dispositivo.Images taken with a camera (photos) have a photo facet that identifies the item as a photo and provides the properties of when the photo was taken and with what device.

Los elementos con una faceta folder actúan como contenedores de elementos y, por lo tanto, tienen una referencia children que indica una colección de driveItems dentro de la carpeta.Items with the folder facet act as containers of items and therefore have a children reference pointing to a collection of driveItems under the folder.

Nota: en las bibliotecas de documentos de OneDrive para la Empresa o SharePoint, no se devuelve la propiedad cTag si driveItem tiene una faceta folder.Note: In OneDrive for Business or SharePoint document libraries, the cTag property is not returned, if the driveItem has a folder facet.

PropiedadesProperties

PropiedadProperty TipoType DescripciónDescription
audioaudio audioaudio Metadatos de audio, si el elemento es un archivo de audio. Solo lectura.Audio metadata, if the item is an audio file. Read-only.
contenidocontent SecuenciaStream La secuencia de contenido, si el elemento representa un archivo.The content stream, if the item represents a file.
createdBycreatedBy identitySetidentitySet Identidad del usuario, el dispositivo y la aplicación que creó el elemento. Solo lectura.Identity of the user, device, and application which created the item. Read-only.
createdDateTimecreatedDateTime DateTimeOffsetDateTimeOffset Fecha y hora de creación del elemento. Solo lectura.Date and time of item creation. Read-only.
cTagcTag StringString Un eTag del contenido del elemento. No se cambia este eTag si solo se modifican los metadatos. Nota Esta propiedad no se devuelve si el elemento es una carpeta. Solo lectura.An eTag for the content of the item. This eTag is not changed if only the metadata is changed. Note This property is not returned if the item is a folder. Read-only.
deleteddeleted deleteddeleted Información sobre el estado del elemento eliminado. Solo lectura.Information about the deleted state of the item. Read-only.
descriptiondescription StringString Proporciona una descripción del elemento visible para el usuario. Lectura y escritura. Solo en OneDrive PersonalProvides a user-visible description of the item. Read-write. Only on OneDrive Personal
eTageTag StringString ETag de todo el elemento (metadatos + contenido). Solo lectura.eTag for the entire item (metadata + content). Read-only.
archivofile filefile Metadatos de archivo, si el elemento es un archivo. Solo lectura.File metadata, if the item is a file. Read-only.
fileSystemInfofileSystemInfo fileSystemInfofileSystemInfo Información del sistema de archivos del cliente. Lectura y escritura.File system information on client. Read-write.
folderfolder folderfolder Metadatos de carpeta, si el elemento es una carpeta. Solo lectura.Folder metadata, if the item is a folder. Read-only.
idid StringString El identificador único del elemento dentro del Drive. Solo lectura.The unique identifier of the item within the Drive. Read-only.
imagenimage imageimage Metadatos de imagen, si el elemento es una imagen. Solo lectura.Image metadata, if the item is an image. Read-only.
lastModifiedBylastModifiedBy identitySetidentitySet Identidad del usuario, el dispositivo y la aplicación que modificó por última vez el elemento. Solo lectura.Identity of the user, device, and application which last modified the item. Read-only.
lastModifiedDateTimelastModifiedDateTime DateTimeOffsetDateTimeOffset Fecha y hora de la última modificación del elemento. Solo lectura.Date and time the item was last modified. Read-only.
locationlocation geoCoordinatesgeoCoordinates Metadatos de ubicación, si el elemento tiene datos de ubicación. Solo lectura.Location metadata, if the item has location data. Read-only.
namename StringString El nombre del elemento (nombre de archivo y extensión). Lectura y escritura.The name of the item (filename and extension). Read-write.
paquetepackage packagepackage Si está presente, indica que este elemento es un paquete en lugar de una carpeta o archivo. Los paquetes se tratan como archivos en algunos contextos y como carpetas en otros. Solo lectura.If present, indicates that this item is a package instead of a folder or file. Packages are treated like files in some contexts and folders in others. Read-only.
parentReferenceparentReference itemReferenceitemReference Información primaria, si el elemento tiene un elemento primario. Lectura y escritura.Parent information, if the item has a parent. Read-write.
Fotophoto photophoto Metadatos de foto, si el elemento es una foto. Solo lectura.Photo metadata, if the item is a photo. Read-only.
publicationpublication publicationFacetpublicationFacet Proporciona información sobre el estado publicado o extraído de un elemento, en ubicaciones que admiten esas acciones.Provides information about the published or checked-out state of an item, in locations that support such actions. Esta propiedad no se devuelve de forma predeterminada.This property is not returned by default. Solo lectura.Read-only.
remoteItemremoteItem remoteItemremoteItem Datos de elemento remoto, si el elemento se comparte desde una unidad distinta a la de acceso. Solo lectura.Remote item data, if the item is shared from a drive other than the one being accessed. Read-only.
rootroot rootroot Si esta propiedad no es NULL, indica que el driveItem es el driveItem de nivel superior de la unidad.If this property is non-null, it indicates that the driveItem is the top-most driveItem in the drive.
searchResultsearchResult searchResultsearchResult Metadatos de búsqueda, si el elemento es un resultado de búsqueda. Solo lectura.Search metadata, if the item is from a search result. Read-only.
compartidoshared sharedshared Indica que el elemento se ha compartido con otros usuarios y proporciona información sobre el estado del elemento compartido. Solo lectura.Indicates that the item has been shared with others and provides information about the shared state of the item. Read-only.
sharepointIdssharepointIds sharepointIdssharepointIds Devuelve los identificadores útiles para la compatibilidad con REST de SharePoint. Solo lectura.Returns identifiers useful for SharePoint REST compatibility. Read-only.
sizesize Int64Int64 Tamaño del elemento en bytes. Solo lectura.Size of the item in bytes. Read-only.
specialFolderspecialFolder specialFolderspecialFolder Si el elemento actual también está disponible como una carpeta especial, se devuelve esta faceta. Solo lectura.If the current item is also available as a special folder, this facet is returned. Read-only.
videovideo videovideo Metadatos de vídeo, si el elemento es un vídeo. Solo lectura.Video metadata, if the item is a video. Read-only.
webDavUrlwebDavUrl CadenaString Dirección URL compatible con WebDAV del elemento.WebDAV compatible URL for the item.
webUrlwebUrl StringString Dirección URL que muestra el recurso en el explorador. Solo lectura.URL that displays the resource in the browser. Read-only.

Nota: Las propiedades eTag y cTag funcionan de forma diferente en los contenedores (carpetas). El valor de cTag se modifica cuando se cambia el contenido o los metadatos de cualquier descendiente de la carpeta. El valor de eTag solo se modifica cuando se cambian las propiedades de la carpeta, excepto las propiedades que derivan de descendientes (como childCount o lastModifiedDateTime).Note: The eTag and cTag properties work differently on containers (folders). The cTag value is modified when content or metadata of any descendant of the folder is changed. The eTag value is only modified when the folder's properties are changed, except for properties that are derived from descendants (like childCount or lastModifiedDateTime).

RelacionesRelationships

RelaciónRelationship TipoType DescripciónDescription
activitiesactivities Colección itemActivityitemActivity collection Lista de actividades recientes que tuvieron lugar en este elemento.The list of recent activities that took place on this item.
analyticsanalytics recurso itemAnalyticsitemAnalytics resource Análisis de las actividades de la vista que sucedieron en este elemento.Analytics about the view activities that took place on this item.
secundariochildren colección driveItemdriveItem collection Colección que contiene objetos de elementos de los elementos secundarios inmediatos. Solo los elementos que representan carpetas tienen elementos secundarios. Solo lectura. Admite un valor NULL.Collection containing Item objects for the immediate children of Item. Only items representing folders have children. Read-only. Nullable.
createdByUsercreatedByUser useruser Identidad del usuario que ha creado el elemento.Identity of the user who created the item. Solo lectura.Read-only.
lastModifiedByUserlastModifiedByUser useruser Identidad del usuario que ha modificado por última vez el elemento.Identity of the user who last modified the item. Solo lectura.Read-only.
listItemlistItem listItemlistItem Para unidades en SharePoint, el elemento de la lista de la biblioteca de documentos asociados.For drives in SharePoint, the associated document library list item. Solo lectura.Read-only. Admite valores NULL.Nullable.
permissionspermissions Colección permissionpermission collection El conjunto de permisos del elemento. Solo lectura. Admite valores NULL.The set of permissions for the item. Read-only. Nullable.
suscripcionessubscriptions colección subscriptionsubscription collection El conjunto de suscripciones en el elemento.The set of subscriptions on the item. Solo se admite en la raíz de una unidad.Only supported on the root of a drive.
miniaturasthumbnails Colección thumbnailSetthumbnailSet collection Colección que contiene objetos ThumbnailSet asociados al elemento. Para obtener más información, consulte obtener miniaturas. Solo lectura. Admite un valor NULL.Collection containing ThumbnailSet objects associated with the item. For more info, see getting thumbnails. Read-only. Nullable.
versionesversions colección driveItemVersiondriveItemVersion collection La lista de versiones anteriores del elemento.The list of previous versions of the item. Para más información, vea obtener versiones anteriores.For more info, see getting previous versions. Solo lectura.Read-only. Admite un valor NULL.Nullable.
libro de trabajoworkbook workbookworkbook Para los archivos que sean hojas de cálculo de Excel, accede a la API del libro de trabajo y trabaja con el contenido de la hoja de cálculo.For files that are Excel spreadsheets, accesses the workbook API to work with the spreadsheet's contents. Admite un valor NULL.Nullable.

Atributos de instanciaInstance Attributes

Los atributos de instancia son propiedades con comportamientos especiales. Estas propiedades son temporales y o bien a) definen el comportamiento que debería tener el servicio o b) proporcionan valores de propiedad a corto plazo, como una dirección URL de descarga de un elemento que expira.Instance attributes are properties with special behaviors. These properties are temporary and either a) define behavior the service should perform or b) provide short-term property values, like a download URL for an item that expires.

Nombre de propiedadProperty name TipoType DescripciónDescription
@microsoft.graph.conflictBehavior@microsoft.graph.conflictBehavior stringstring El comportamiento de resolución de conflictos para las acciones que crean un nuevo elemento. Puede utilizar los valores de fail, replace, o rename. El valor predeterminado de PUT es replace. Nunca se devuelve un elemento con esta anotación. Solo escritura.The conflict resolution behavior for actions that create a new item. You can use the values fail, replace, or rename. The default for PUT is replace. An item will never be returned with this annotation. Write-only.
@microsoft.graph.downloadUrl@microsoft.graph.downloadUrl stringstring Una dirección URL que puede utilizarse para descargar el contenido de este archivo. No es necesaria la autenticación con esta dirección URL. Solo lectura.A URL that can be used to download this file's content. Authentication is not required with this URL. Read-only.
@microsoft.graph.sourceUrl@microsoft.graph.sourceUrl stringstring Al emitir una solicitud PUT, esta anotación de instancia puede utilizarse para indicar al servicio que descargue el contenido de la dirección URL y lo guarde como el archivo. Solo escritura.When issuing a PUT request, this instance annotation can be used to instruct the service to download the contents of the URL, and store it as the file. Write-only.

Nota: El valor @microsoft.graph.downloadUrl es una dirección URL de corta duración y no puede almacenarse en caché.Note: The @microsoft.graph.downloadUrl value is a short-lived URL and can't be cached. La dirección URL solo estará disponible durante un breve período de tiempo (1 hora) antes de ser invalidada.The URL will only be available for a short period of time (1 hour) before it is invalidated. Es posible que al quitar permisos de archivo de un usuario no se invalide inmediatamente la dirección URL.Removing file permissions for a user may not immediately invalidate the URL.

Nota: el parámetro @microsoft.graph.conflictBehavior debe agregarse a la dirección URL en lugar del cuerpo de la solicitud.Note: The parameter @microsoft.graph.conflictBehavior should be included in the URL instead of the body of the request.

Representación JSONJSON representation

A continuación se incluye una representación JSON del recurso driveItem.Here is a JSON representation of a driveItem resource.

El recurso driveItem deriva de baseItem y hereda las propiedades de ese recurso.The driveItem resource is derived from baseItem and inherits properties from that resource.

{
  "audio": { "@odata.type": "microsoft.graph.audio" },
  "content": { "@odata.type": "Edm.Stream" },
  "cTag": "string (etag)",
  "deleted": { "@odata.type": "microsoft.graph.deleted"},
  "description": "string",
  "file": { "@odata.type": "microsoft.graph.file" },
  "fileSystemInfo": { "@odata.type": "microsoft.graph.fileSystemInfo" },
  "folder": { "@odata.type": "microsoft.graph.folder" },
  "image": { "@odata.type": "microsoft.graph.image" },
  "location": { "@odata.type": "microsoft.graph.geoCoordinates" },
  "package": { "@odata.type": "microsoft.graph.package" },
  "photo": { "@odata.type": "microsoft.graph.photo" },
  "publication": {"@odata.type": "microsoft.graph.publicationFacet"},
  "remoteItem": { "@odata.type": "microsoft.graph.remoteItem" },
  "root": { "@odata.type": "microsoft.graph.root" },
  "searchResult": { "@odata.type": "microsoft.graph.searchResult" },
  "shared": { "@odata.type": "microsoft.graph.shared" },
  "sharepointIds": { "@odata.type": "microsoft.graph.sharepointIds" },
  "size": 1024,
  "specialFolder": { "@odata.type": "microsoft.graph.specialFolder" },
  "video": { "@odata.type": "microsoft.graph.video" },
  "webDavUrl": "string",

  /* relationships */
  "activities": [{"@odata.type": "microsoft.graph.itemActivity"}],
  "analytics": {"@odata.type": "microsoft.graph.itemAnalytics"},
  "children": [{ "@odata.type": "microsoft.graph.driveItem" }],
  "createdByUser": { "@odata.type": "microsoft.graph.user" },
  "lastModifiedByUser": { "@odata.type": "microsoft.graph.user" },
  "permissions": [ {"@odata.type": "microsoft.graph.permission"} ],
  "subscriptions": [ {"@odata.type": "microsoft.graph.subscription"} ],
  "thumbnails": [ {"@odata.type": "microsoft.graph.thumbnailSet"}],
  "versions": [ {"@odata.type": "microsoft.graph.driveItemVersion"}],

  /* inherited from baseItem */
  "id": "string (identifier)",
  "createdBy": {"@odata.type": "microsoft.graph.identitySet"},
  "createdDateTime": "String (timestamp)",
  "eTag": "string",
  "lastModifiedBy": {"@odata.type": "microsoft.graph.identitySet"},
  "lastModifiedDateTime": "String (timestamp)",
  "name": "string",
  "parentReference": {"@odata.type": "microsoft.graph.itemReference"},
  "webUrl": "string",

  /* instance annotations */
  "@microsoft.graph.conflictBehavior": "string",
  "@microsoft.graph.downloadUrl": "url",
  "@microsoft.graph.sourceUrl": "url"
}

MétodosMethods

MétodoMethod Tipo de valor devueltoReturn Type DescripciónDescription
Obtener elementoGet item driveItemdriveItem Recupera los metadatos de un DriveItem en un Drive.Retrieve the metadata for a DriveItem in a Drive.
Obtener análisisGet analytics itemAnalyticsitemAnalytics Obtener análisis para este recurso.Get analytics for this resource.
Obtener actividades por intervaloGet activities by interval itemActivityStatitemActivityStat Obtener una colección de itemActivityStats dentro del intervalo de tiempo especificado.Get a collection of itemActivityStats within the specified time interval.
Enumerar elementos secundariosList children colección de driveItemcollection of driveItem Devuelve una colección de objetos DriveItem en la relación de elementos secundarios de un objeto DriveItem.Return a collection of DriveItems in the children relationship of a DriveItem.
Enumerar versionesList versions colección de DriveItemVersioncollection of DriveItemVersion Recupera las versiones de un archivo en la unidad del usuario actual.Retrieves the versions of a file in the current user's drive.
Crear elementoCreate item driveItemdriveItem Crea un driveItem en la unidad especificada.Creates a driveItem in the specified drive.
Actualizar elementoUpdate item driveItemdriveItem Actualiza un driveItem en la unidad.Updates a driveItem in the drive.
Cargar contenidoUpload content driveItemdriveItem Carga el contenido al driveItem.Uploads content to the driveItem.
Descargar contenidoDownload content Descargar dirección Urldownload Url Descargar contenido de un objeto DriveItemDownloads content of a driveItem.
Descargar el formato de archivo específicoDownload specific file format Descargar dirección Urldownload Url Descargar contenido de un driveItem con un formato específico.Downloads content of a driveItem with a specific format.
Eliminar elementoDelete item Sin contenidoNo Content Elimina un DriveItemDeletes a driveItem.
Mover elementoMove item driveItemdriveItem Mover un DriveItem a un nuevo elemento primario.Move a DriveItem to a new parent item.
Copiar elementoCopy item detalles sobre cómo supervisar el progreso de la copiadetails about how to monitor the progress of the copy Crea una copia de un objeto driveItem (incluidos los elementos secundarios).Creates a copy of an driveItem (including any children).
Buscar elementosSearch items colección de driveItemcollection of driveItem Buscar elementos que coincidan con una consulta en la jerarquía de elementos.Search the hierarchy of items for items matching a query.
Enumerar cambios en una unidadList changes in a drive vínculo deltadelta link Enumerar los cambios de la unidadList any changes in the drive.
Enumerar miniaturasList thumbnails colección de driveItemcolletion of driveItem Enumerar DriveItem con sus miniaturas.List driveItems with their thumbnails.
Crear vínculo para compartirCreate sharing link compartir vínculo sharing link Crear un vínculo para compartir el driveItem.Create a link to share the driveItem.
Agregar permisosAdd permissions colección de [permisos][]collection of permission Enviar una invitación para uso compartido a un usuario.Sends a sharing ivite to a user.
Enumerar permisosList permissions colección de [permisos][]collection of permission Recuperar la colección de permisos en un driveItem.Retrieves the collection of permissions on an driveItem.
Eliminar permisoDelete permission Sin contenidoNo Content Quitar los permisos del driveItem.Removes the permission from the driveItem.
Obtener el canal WebSocketGet WebSocket channel subscriptionsubscription Recibir notificaciones de cambios casi en tiempo real para una unidad con socket.io.Receives near-real-time change notifications for a drive using socket.io.
Vista previa del elementoPreview item objeto jsonjson object Obtener direcciones URL de corta vida insertables de un elemento para obtener una vista previa temporal.Obtain short-lived embeddable URLs for an item in order to render a temporary preview.