tipo de recurso driveItem
Namespace: microsoft.graph
Importante
As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor de versão.
O recurso DriveItem representa um arquivo, pasta ou outro item armazenado em uma unidade.
Todos os objetos do sistema de arquivos no OneDrive e no SharePoint são retornados como recursos driveItem. Os itens nas bibliotecas de documentos do Microsoft Office SharePoint Online podem ser representados como recursos listItem ou driveItem.
Há duas maneiras principais de endereçar um recurso driveItem:
- Pelo identificador exclusivo de driveItem usando
drive/items/{item-id} - Usando o caminho do sistema de arquivos
/drive/root:/path/to/file
Para obter mais informações, consulte o endereçamento de ItensDaUnidade.
Os recursos DriveItem têm facetas modeladas como propriedades que fornecem dados sobre as identidades e capacidades de driveItem. Por exemplo:
- As pastas têm uma faceta folder
- Os arquivos têm uma faceta file.
- As imagens têm uma faceta image, além de facetas file.
- Imagens obtidas com uma câmera (fotos) têm uma faceta photo que identifica o item como uma foto e fornece as propriedades de quando foi tirada e com qual dispositivo.
Itens com a faceta folder atuam como contêineres de itens e, portanto, têm uma referência children apontando para um conjunto de driveItems na pasta.
Observação: No OneDrive for Business ou nas bibliotecas de documentos do SharePoint, a propriedade cTag não é retornada se o driveItem tiver uma faceta de [pasta][].
Métodos
| Método | Caminho REST |
|---|---|
| Obter item | GET /drive/items/{item-id} |
| Listar atividades | GET /drive/items/{item-id}/activities |
| Obter análises | GET /drive/items/{item-id}/analytics |
| Obter atividades por intervalo | GET /drive/items/{item-id}/getActivitiesByInterval |
| Listar filhos | GET /drive/items/{item-id}/children |
| Listar versões | GET /drive/items/{item-id}/versions |
| Criar item | POST /drive/items/{item-id}/children |
| Atualizar item | PATCH /drive/items/{item-id} |
| Carregar conteúdo | PUT /drive/items/{item-id}/content |
| Baixar conteúdo | GET /drive/items/{item-id}/content |
| Baixar o formato de arquivo específico | GET /drive/items/{item-id}/content?format={format} |
| Excluir item | DELETE /drive/items/{item-id} |
| Restaurar item | POST /drive/items/{item-id}/restore |
| Mover item | PATCH /drive/items/{item-id} |
| Copiar item | POST /drive/items/{item-id}/copy |
| Pesquisar itens | GET /drive/items/{item-id}/search(q='text') |
| Listar alterações em uma unidade | GET /drive/root/delta |
| Seguir item | POST /drives/{drive-id}/items/{item-id}/follow |
| Não seguir o item | POST /drives/{drive-id}/items/{item-id}/unfollow |
| Listar miniaturas | GET /drive/items/{item-id}/thumbnails |
| Criar link de compartilhamento | POST /drive/items/{item-id}/createLink |
| Adicionar permissões | POST /drive/items/{item-id}/invite |
| Listar permissões | GET /drive/items/{item-id}/permissions |
| Excluir permissão | DELETE /drive/items/{item-id}/permissions/{perm-id} |
| Obter canal WebSocket | GET /drive/root/subscriptions/socketIo |
| Item de visualização | POST /drive/items/{item-id}/preview |
| Fazer ceck-in | POST /drives/{driveId}/items/{itemId}/checkin |
| Fazer check-out | POST /drives/{driveId}/items/{itemId}/checkout |
| Revogar concessões | PATCH /drive/items/{item-id}/permissions/{perm-id}/revokeGrants |
| Extrair rótulos de confidencialidade | POST /drive/items/{item-id}/extractSensitivityLabels |
Propriedades
| Propriedade | Tipo | Descrição |
|---|---|---|
| audio | audio | Metadados de áudio, se o item for um arquivo de áudio. Somente leitura. Somente no OneDrive Personal. |
| pacote | Agrupar | Agrupar os metadados, se o item for um pacote. Somente leitura. |
| conteúdo | Fluxo | O fluxo de conteúdo, se o item representar um arquivo. |
| createdBy | identitySet | Identidade do usuário, dispositivo e aplicativo que criou o item. Somente leitura. |
| createdDateTime | DateTimeOffset | Data e hora de criação do item. Somente leitura. |
| cTag | String | Uma eTag para o conteúdo do item. Essa eTag não será alterada se apenas os metadados forem alterados. Observação Essa propriedade não será retornada se o item for uma pasta. Somente leitura. |
| deleted | deleted | Informações sobre o estado excluído do item. Somente leitura. |
| descrição | String | Fornece uma descrição visível ao usuário do item. Leitura/gravação. Somente no OneDrive Personal. |
| eTag | String | eTag para o item inteiro (metadados + conteúdo). Somente leitura. |
| file | file | Metadados de arquivo, se o item for um arquivo. Somente leitura. |
| fileSystemInfo | fileSystemInfo | Informações do sistema de arquivos no cliente. Leitura e gravação. |
| folder | folder | Metadados de pasta, se o item for uma pasta. Somente leitura. |
| id | String | O identificador exclusivo do item na Unidade. Somente leitura. |
| imagem | image | Metadados de imagem, se o item for uma imagem. Somente leitura. |
| lastModifiedBy | identitySet | Identidade do usuário, dispositivo e aplicativo que modificou o item pela última vez. Somente leitura. |
| lastModifiedDateTime | DateTimeOffset | Data e hora em que o item foi modificado pela última vez. Somente leitura. |
| location | geoCoordinates | Metadados de localização, se o item tiver dados de localização. Somente leitura. |
| malware | malware | Metadados de malware, se o item for detectado como contendo malware. Somente leitura. |
| mídia | mídia | Informações sobre o item de mídia (áudio ou vídeo). Leitura e gravação. Somente no OneDrive for Business e no SharePoint. |
| nome | String | O nome do item (nome do arquivo e extensão). Leitura e gravação. |
| pacote | package | Se presente, indica que esse item é um pacote, e não uma pasta ou um arquivo. Pacotes são tratados como arquivos em alguns contextos e como pastas em outros. Somente leitura. |
| parentReference | itemReference | Informações do pai, se o item tiver um pai. Leitura e gravação. |
| pendingOperations | pendingOperations | Se presente, indica que uma ou mais operações que podem afetar o estado do driveItem estão pendentes de conclusão. Somente leitura. |
| photo | photo | Metadados de foto, se o item for uma foto. Somente leitura. |
| publication | publicationFacet | Fornece informações sobre o estado de publicação ou de check-out de um item, nos locais que oferecem suporte a essas ações. Esta propriedade não retorna por padrão. Somente leitura. |
| remoteItem | remoteItem | Dados do item remoto, se o item for compartilhado de uma unidade diferente daquela que está sendo acessada. Somente leitura. |
| root | root | Se essa propriedade for não nula, indicará que o driveItem é o principal driveItem na unidade. |
| searchResult | searchResult | Metadados de pesquisa, se o item for de um resultado de pesquisa. Somente leitura. |
| compartilhado | compartilhado | Indica que o item foi compartilhado com outras pessoas e fornece informações sobre o estado compartilhado desse item. Somente leitura. |
| sharepointIds | sharepointIds | Retorna os identificadores úteis para fins de compatibilidade do REST do SharePoint. Somente leitura. |
| size | Int64 | O tamanho do item em bytes. Somente leitura. |
| specialFolder | specialFolder | Se o item atual também estiver disponível como uma pasta especial, essa faceta será retornada. Somente leitura. |
| source | driveItemSource | Informações sobre a origem do item de unidade. Somente leitura. Somente no OneDrive for Business e no SharePoint. |
| video | [video][] | Metadados de vídeo, se o item for um vídeo. Somente leitura. |
| webDavUrl | String | URL compatível com WebDAV para o item. |
| webUrl | String | URL que exibe o recurso no navegador. Somente leitura. |
Observação: As propriedades eTag e cTag funcionam de maneira diferente em contêineres (pastas). O valor de cTag é modificado quando o conteúdo ou os metadados de qualquer descendente da pasta são alterados. O valor de eTag é modificado apenas quando as propriedades da pasta são alteradas, exceto para propriedades derivadas de descendentes (como childCount ou lastModifiedDateTime).
Relações
| Relação | Tipo | Descrição |
|---|---|---|
| activities | Conjunto itemActivity | A lista de atividades recentes que ocorreram neste item. |
| análise | recurso itemAnalytics | Análise sobre as atividades de visualização que ocorreram neste item. |
| children | coleção driveItem | Coleção que contêm objetos Item para os filhos imediatos do Item. Somente os itens que representam pastas têm filhos. Somente leitura. Anulável. |
| createdByUser | [user][] | A identidade do usuário que criou o item. Somente leitura. |
| lastModifiedByUser | [user][] | A identidade do usuário que modificou o item pela última vez. Somente leitura. |
| listItem | listItem | Para unidades no SharePoint, o item da lista da biblioteca de documentos associado. Somente leitura. Anulável. |
| permissões | Coleção [permission][] | O conjunto de permissões do item. Somente leitura. Anulável. |
| assinaturas | conjunto de [assinaturas][] | O conjunto de assinaturas no item. Compatível somente na raiz de uma unidade. |
| miniaturas | Coleção thumbnailSet | Coleção contendo objetos ThumbnailSet associados ao item. Para saber mais, confira obtendo miniaturas. Somente leitura. Anulável. |
| versões | coleção driveItemVersion | A lista de todas as versões anteriores do item. Para saber mais, confira as informações sobre a [obtenção de versões anteriores][]. Somente leitura. Anulável. |
| pasta de trabalho | pasta de trabalho | Para arquivos que são planilhas do Excel, acessa a API de pasta da trabalho para trabalhar com o conteúdo da planilha. Anulável. |
Atributos de instância
Atributos de instância são propriedades com comportamentos especiais. Essas propriedades são temporárias e a) definem o comportamento que o serviço deve apresentar ou b) fornecem valores de propriedades de curto prazo, como uma URL de download, para um item com data de expiração.
| Nome da propriedade | Tipo | Descrição |
|---|---|---|
| @microsoft.graph.conflictBehavior | string | O comportamento de resolução de conflitos para ações que criam um novo item. Você pode usar os valores fail, replace ou rename. O padrão para PUT é replace. Um item nunca será retornado com essa anotação. Somente gravação. |
| @microsoft.graph.downloadUrl | string | Uma URL que pode ser usada para baixar conteúdo desse arquivo. Uma autenticação não é obrigatória com essa URL. Somente leitura. |
| @microsoft.graph.sourceUrl | string | Quando uma solicitação PUT é emitida, essa anotação de instância pode ser usada para instruir o serviço a baixar o conteúdo da URL e armazená-lo como o arquivo. Somente gravação. |
Observação: O valor de @microsoft.graph.downloadUrl é uma URL de curta duração e não pode ser armazenado em cache. A URL só estará disponível por um curto período de tempo (1 hora) antes de ser invalidada. A remoção das permissões de arquivo de um usuário pode não invalidar a URL imediatamente.
Observação: o parâmetro @microsoft.graph.conflictBehavior deve ser incluído na URL, em vez do corpo da solicitação.
Representação JSON
Veja a seguir uma representação JSON de um recurso driveItem.
O recurso driveItem é derivado de baseItem e herda propriedades desse 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" },
"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" },
"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"
}
Comentários
Enviar e exibir comentários de