Tipo de recurso driveItem
Espacio de nombres: microsoft.graph
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. Los elementos de las bibliotecas de documentos de SharePoint se pueden representar como recursos listItem o driveItem.
Hay dos maneras principales de abordar un recurso driveItem:
- Con el identificador único driveItem utilizando
drive/items/{item-id} - Con la ruta de acceso del sistema de archivos mediante
/drive/root:/path/to/file
Para más información, vea direccionamiento de driveItems.
Los recursos driveItem tienen facetas modeladas como propiedades que proporcionan datos sobre las identidades y las capacidades de driveItem. Por ejemplo:
- Las carpetas tienen una faceta de carpeta
- Los archivos tienen una faceta de archivo.
- Las imágenes tienen una faceta image además de la faceta file.
- Las imágenes tomadas con una cámara (fotos) tienen una faceta photo que identifica el elemento como una foto. Asimismo, facilita las propiedades que indican cuándo se tomó la foto y con qué dispositivo.
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.
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.
Métodos
| Método | Tipo de valor devuelto | Descripción |
|---|---|---|
| Obtener elemento | driveItem | Recupera los metadatos de un DriveItem en un Drive. |
| Obtener análisis | itemAnalytics | Obtener análisis para este recurso. |
| Obtener actividades por intervalo | itemActivityStat | Obtener una colección de itemActivityStats dentro del intervalo de tiempo especificado. |
| Enumerar elementos secundarios | colección de driveItem | Devuelve una colección de objetos DriveItem en la relación de elementos secundarios de un objeto DriveItem. |
| Enumerar versiones | colección de DriveItemVersion | Recupera las versiones de un archivo en la unidad del usuario actual. |
| Crear elemento | driveItem | Crea un driveItem en la unidad especificada. |
| Actualizar elemento | driveItem | Actualiza un driveItem en la unidad. |
| Cargar contenido | driveItem | Carga el contenido al driveItem. |
| Descargar contenido | Descargar dirección Url | Descargar contenido de un objeto DriveItem |
| Descargar el formato de archivo específico | Descargar dirección Url | Descargar contenido de un driveItem con un formato específico. |
| Eliminar elemento | Sin contenido | Elimina un DriveItem |
| Elemento PermanentDelete | POST /drives/{driveId}/items/{itemId}/permanentDelete |
|
| Mover elemento | driveItem | Mover un DriveItem a un nuevo elemento primario. |
| Copiar elemento | detalles sobre cómo supervisar el progreso de la copia | Crea una copia de un objeto driveItem (incluidos los elementos secundarios). |
| Buscar elementos | colección de driveItem | Buscar elementos que coincidan con una consulta en la jerarquía de elementos. |
| Enumerar cambios en una unidad | vínculo delta | Enumerar los cambios de la unidad |
| Seguir elemento | driveItem | Siga un driveItem. |
| Dejar de seguir elemento | Sin contenido | Dejar de seguir un driveItem. |
| Listar miniaturas | colección de driveItem | Enumerar DriveItem con sus miniaturas. |
| Crear vínculo para compartir | compartir vínculo | Crear un vínculo para compartir el driveItem. |
| Agregar permisos | colección de permisos | Envía una invitación para compartir a un usuario. |
| Enumerar permisos | colección de permisos | Recuperar la colección de permisos en un driveItem. |
| Eliminar permiso | Sin contenido | Quitar los permisos del driveItem. |
| Obtener el canal WebSocket | subscription | Recibir notificaciones de cambios casi en tiempo real para una unidad con socket.io. |
| Vista previa del elemento | objeto json | Obtener direcciones URL de corta vida insertables de un elemento para obtener una vista previa temporal. |
| Insertar en el repositorio | POST /drives/{driveId}/items/{itemId}/checkin |
|
| Extraer del repositorio | POST /drives/{driveId}/items/{itemId}/checkout |
|
| Extracción de etiquetas de confidencialidad | POST /drive/items/{item-id}/extractSensitivityLabels |
Extraiga una o varias etiquetas de confidencialidad asignadas a un elemento de unidad y actualice los metadatos de un elemento de unidad con los detalles más recientes de la etiqueta asignada. |
| Asignar etiqueta de confidencialidad | POST /drive/items/{item-id}/assignSensitivityLabel |
Asigne de forma asincrónica una etiqueta de confidencialidad a un driveItem. |
Propiedades
| Propiedad | Tipo | Descripción |
|---|---|---|
| audio | audio | Metadatos de audio, si el elemento es un archivo de audio. Solo lectura. Solo lectura. Solo en OneDrive Personal. |
| bundle | bundle | Metadatos de agrupación, si el elemento es una agrupación. Solo lectura. |
| contenido | Secuencia | La secuencia de contenido, si el elemento representa un archivo. |
| createdBy | identitySet | Identidad del usuario, el dispositivo y la aplicación que creó el elemento. Solo lectura. |
| createdDateTime | DateTimeOffset | Fecha y hora de creación del elemento. Solo lectura. |
| cTag | String | 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. |
| deleted | deleted | Información sobre el estado del elemento eliminado. Solo lectura. |
| description | String | Proporciona una descripción del elemento visible para el usuario. Lectura y escritura. Solo en OneDrive Personal. |
| eTag | String | ETag de todo el elemento (metadatos + contenido). Solo lectura. |
| archivo | file | Metadatos de archivo, si el elemento es un archivo. Solo lectura. |
| fileSystemInfo | fileSystemInfo | Información del sistema de archivos del cliente. Lectura y escritura. |
| folder | folder | Metadatos de carpeta, si el elemento es una carpeta. Solo lectura. |
| id | String | El identificador único del elemento dentro del Drive. Solo lectura. |
| imagen | image | Metadatos de imagen, si el elemento es una imagen. Solo lectura. |
| lastModifiedBy | identitySet | Identidad del usuario, el dispositivo y la aplicación que modificó por última vez el elemento. Solo lectura. |
| lastModifiedDateTime | DateTimeOffset | Fecha y hora de la última modificación del elemento. Solo lectura. |
| location | geoCoordinates | Metadatos de ubicación, si el elemento tiene datos de ubicación. Solo lectura. |
| malware | malware | Metadatos de malware, si se detectó que el elemento contenía malware. Solo lectura. |
| name | String | El nombre del elemento (nombre de archivo y extensión). Lectura y escritura. |
| paquete | package | 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. |
| parentReference | itemReference | Información primaria, si el elemento tiene un elemento primario. Lectura y escritura. |
| pendingOperations | pendingOperations | Si está presente, indica que hay una o más operaciones que podrían afectar al estado del driveItem y que están pendientes de finalización. Solo lectura. |
| photo | photo | Metadatos de foto, si el elemento es una foto. Solo lectura. |
| publication | publicationFacet | Proporciona información sobre el estado publicado o extraído de un elemento, en ubicaciones que admiten esas acciones. Esta propiedad no se devuelve de forma predeterminada. Solo lectura. |
| remoteItem | remoteItem | Datos de elemento remoto, si el elemento se comparte desde una unidad distinta a la de acceso. Solo lectura. |
| root | root | Si esta propiedad no es NULL, indica que el driveItem es el driveItem de nivel superior de la unidad. |
| searchResult | searchResult | Metadatos de búsqueda, si el elemento es un resultado de búsqueda. Solo lectura. |
| shared | shared | Indica que el elemento se ha compartido con otros usuarios y proporciona información sobre el estado del elemento compartido. Solo lectura. |
| sharepointIds | sharepointIds | Devuelve los identificadores útiles para la compatibilidad con REST de SharePoint. Solo lectura. |
| size | Int64 | Tamaño del elemento en bytes. Solo lectura. |
| specialFolder | specialFolder | Si el elemento actual también está disponible como una carpeta especial, se devuelve esta faceta. Solo lectura. |
| video | video | Metadatos de vídeo, si el elemento es un vídeo. Solo lectura. |
| webDavUrl | Cadena | Dirección URL compatible con WebDAV del elemento. |
| webUrl | String | Dirección URL que muestra el recurso en el explorador. Solo lectura. |
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).
Relaciones
| Relación | Tipo | Descripción |
|---|---|---|
| activities | Colección itemActivity | Lista de actividades recientes que tuvieron lugar en este elemento. |
| analytics | Recurso itemAnalytics | Análisis de las actividades de la vista que sucedieron en este elemento. |
| secundario | colección driveItem | Colección que contiene objetos Item de los elementos secundarios inmediatos del elemento. Solo los elementos que representan carpetas tienen elementos secundarios. Solo lectura. Admite valores NULL. |
| createdByUser | user | Identidad del usuario que ha creado el elemento. Solo lectura. |
| lastModifiedByUser | user | Identidad del usuario que ha modificado por última vez el elemento. Solo lectura. |
| listItem | listItem | Para unidades en SharePoint, el elemento de la lista de la biblioteca de documentos asociados. Solo lectura. Admite valores NULL. |
| permissions | Colección permission | El conjunto de permisos del elemento. Solo lectura. Admite valores NULL. |
| suscripciones | colección subscription | El conjunto de suscripciones en el elemento. Solo se admite en la raíz de una unidad. |
| miniaturas | Colección thumbnailSet | Colección que contiene objetos ThumbnailSet asociados al elemento. Para obtener más información, vea Obtener miniaturas. Solo lectura. Admite valores NULL. |
| versiones | colección driveItemVersion | La lista de versiones anteriores del elemento. Para más información, vea obtener versiones anteriores. Solo lectura. Admite un valor NULL. |
| libro de trabajo | workbook | 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. Admite un valor NULL. |
Atributos de instancia
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.
| Nombre de propiedad | Tipo | Descripción |
|---|---|---|
| @microsoft.graph.conflictBehavior | string | 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 devolverá un elemento con esta anotación. Solo escritura. |
| @microsoft.graph.downloadUrl | string | 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. |
| @microsoft.graph.sourceUrl | string | 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. |
Notas: el parámetro
@microsoft.graph.conflictBehaviordebe agregarse a la dirección URL en lugar del cuerpo de la solicitud.El valor
@microsoft.graph.downloadUrles una dirección URL de corta duración y no puede almacenarse en caché. La dirección URL solo estará disponible durante un breve período de tiempo (1 hora) antes de ser invalidada. Es posible que al quitar permisos de archivo de un usuario no se invalide inmediatamente la dirección URL.El uso de la propiedad para la carga de archivos
@microsoft.graph.sourceUrlno es admitido en OneDrive para la Empresa, SharePoint Online y SharePoint Server 2016.
Representación JSON
A continuación se incluye una representación JSON del recurso driveItem.
El recurso driveItem deriva de baseItem y hereda las propiedades de ese recurso.
{
"audio": { "@odata.type": "microsoft.graph.audio" },
"bundle": { "@odata.type": "microsoft.graph.bundle" },
"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" },
"malware": { "@odata.type": "microsoft.graph.malware" },
"package": { "@odata.type": "microsoft.graph.package" },
"pendingOperations": { "@odata.type": "microsoft.graph.pendingOperations" },
"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 */
"createdBy": {"@odata.type": "microsoft.graph.identitySet"},
"createdDateTime": "String (timestamp)",
"eTag": "string",
"id": "string (identifier)",
"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"
}