Tipo de recurso driveItem
Espacio de nombres: microsoft.graph
Importante
Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.
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 funcionalidades del 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 OneDrive para la Empresa o bibliotecas de documentos de SharePoint, no se devuelve la propiedad cTag, si driveItem tiene una faceta de carpeta.
Métodos
| Método | Ruta de acceso a REST |
|---|---|
| Obtener elemento | GET /drive/items/{item-id} |
| Enumerar actividades | GET /drive/items/{item-id}/activities |
| Obtener análisis | GET /drive/items/{item-id}/analytics |
| Obtener actividades por intervalo | GET /drive/items/{item-id}/getActivitiesByInterval |
| Enumerar elementos secundarios | GET /drive/items/{item-id}/children |
| Enumerar versiones | GET /drive/items/{item-id}/versions |
| Crear elemento | POST /drive/items/{item-id}/children |
| Actualizar elemento | PATCH /drive/items/{item-id} |
| Cargar contenido | PUT /drive/items/{item-id}/content |
| Descargar contenido (en desuso) | GET /drive/items/{item-id}/content |
| Descargar contenido | GET /drive/items/{item-id}/contentStream |
| Descargar el formato de archivo específico | GET /drive/items/{item-id}/content?format={format} |
| Eliminar elemento | DELETE /drive/items/{item-id} |
| Elemento PermanentDelete | POST /drives/{driveId}/items/{itemId}/permanentDelete |
| Restaurar elemento | POST /drive/items/{item-id}/restore |
| Mover elemento | PATCH /drive/items/{item-id} |
| Copiar elemento | POST /drive/items/{item-id}/copy |
| Buscar elementos | GET /drive/items/{item-id}/search(q='text') |
| Enumerar cambios en una unidad | GET /drive/root/delta |
| Seguir elemento | POST /drives/{drive-id}/items/{item-id}/follow |
| No seguir elemento | POST /drives/{drive-id}/items/{item-id}/unfollow |
| Enumerar miniaturas | GET /drive/items/{item-id}/thumbnails |
| Crear vínculo para compartir | POST /drive/items/{item-id}/createLink |
| Agregar permisos | POST /drive/items/{item-id}/invite |
| Enumerar permisos | GET /drive/items/{item-id}/permissions |
| Eliminar permiso | DELETE /drive/items/{item-id}/permissions/{perm-id} |
| Obtener el canal WebSocket | GET /drive/root/subscriptions/socketIo |
| Vista previa del elemento | POST /drive/items/{item-id}/preview |
| Insertar en el repositorio | POST /drives/{driveId}/items/{itemId}/checkin |
| Extraer del repositorio | POST /drives/{driveId}/items/{itemId}/checkout |
| Revocación de concesiones | PATCH /drive/items/{item-id}/permissions/{perm-id}/revokeGrants |
| Extracción de etiquetas de confidencialidad | POST /drive/items/{item-id}/extractSensitivityLabels |
| Asignar etiqueta de confidencialidad | POST /drive/items/{item-id}/assignSensitivityLabel |
| Obtener etiqueta de retención | GET /drives/{drive-id}/items/{id}/retentionLabel |
| Establecimiento de la etiqueta de retención | PATCH /drives/{drive-id}/items/{id}/retentionLabel |
| Quitar la etiqueta de retención | DELETE /drives/{drive-id}/items/{id}/retentionLabel |
| Bloquear o desbloquear un registro | PATCH /drives/{drive-id}/items/{id}/retentionLabel |
Propiedades
| Propiedad | Tipo | Descripción |
|---|---|---|
| audio | audio | Metadatos de audio, si el elemento es un archivo de audio. Solo lectura. Solo en OneDrive Personal. |
| bundle | bundle | Metadatos de agrupación, si el elemento es una agrupación. Solo lectura. |
| contenido (en desuso) | Secuencia | La secuencia de contenido, si el elemento representa un archivo. La propiedad de contenido tendrá un cambio potencialmente importante en el comportamiento en el futuro. Transmitirá contenido directamente en lugar de redirigirlo. Para participar de forma proactiva en el nuevo comportamiento con antelación, use la propiedad contentStream en su lugar. |
| contentStream | Secuencia | La secuencia de contenido, si el elemento representa un archivo. |
| createdBy | identitySet | Identidad del usuario, dispositivo y 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. Esta eTag no se cambia si solo se cambian 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, dispositivo y aplicación, que modificó por última vez el elemento. Solo lectura. |
| lastModifiedDateTime | DateTimeOffset | Fecha y hora en que se modificó por última vez el 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. |
| medios | Elementos multimedia | Información sobre el elemento multimedia (audio o vídeo). Lectura y escritura. Solo en OneDrive para la Empresa y SharePoint. |
| 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 una o varias operaciones que podrían afectar al estado del driveItem 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 compartido del elemento. 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. |
| source | driveItemSource | Información sobre el origen del elemento de unidad. Solo lectura. Solo en OneDrive para la Empresa y SharePoint. |
| 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. |
| retentionLabel | itemRetentionLabel | Información sobre la etiqueta de retención y la configuración aplicadas en driveItem. Lectura y escritura. |
| 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 de objetos thumbnailSet asociados al elemento. Para obtener más información, consulte Obtención de 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 son hojas de cálculo de Excel, acceda a la API del libro para trabajar 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 definen el comportamiento que el servicio debe realizar o proporcionan valores de propiedad a corto plazo, como una dirección URL de descarga para 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 devuelve 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. La autenticación no es necesaria con esta dirección URL. Solo lectura. |
| @microsoft.graph.sourceUrl | string | Esta anotación de instancia se puede usar para indicar al servicio que descargue el contenido de la dirección URL al emitir una solicitud PUT y la almacena como 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 se invalida después de un breve período de tiempo (1 hora). 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
La siguiente representación JSON muestra el tipo de recurso.
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" },
"contentStream": { "@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" },
"media": { "@odata.type": "microsoft.graph.media" },
"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,
"source": { "@odata.type": "microsoft.graph.driveItemSource" },
"specialFolder": { "@odata.type": "microsoft.graph.specialFolder" },
"video": { "@odata.type": "microsoft.graph.video" },
"webDavUrl": "string",
/* relationships */
"activities": [{"@odata.type": "microsoft.graph.itemActivity"}],
"children": [{ "@odata.type": "microsoft.graph.driveItem" }],
"createdByUser": { "@odata.type": "microsoft.graph.user" },
"itemRetentionLabel": [{ "@odata.type": "microsoft.graph.itemRetentionLabel" }],
"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"
}
Comentarios
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea: https://aka.ms/ContentUserFeedback.
Enviar y ver comentarios de