tipo de recurso driveItem
Namespace: microsoft.graph
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 de driveItem têm facetas modeladas como propriedades que fornecem dados sobre as identidades e recursos do driveItem. Por exemplo:
- As pastas têm uma faceta de pasta
- Os ficheiros têm uma faceta de ficheiro.
- Imagens têm uma faceta image além das facetas file.
- Imagens obtidas com uma câmera (fotos) se comportam como uma faceta photo que identifica o item como uma foto e fornece as propriedades de quando a foto 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.
Nota: No OneDrive for Business ou nas bibliotecas de documentos do SharePoint, a propriedade cTag não é devolvida se o driveItem tiver uma faceta de pasta.
Métodos
| Método | Tipo de retorno | Descrição |
|---|---|---|
| Obter item | driveItem | Obtenha os metadados de um driveItem numa unidade. |
| Obter análises | itemAnalytics | Obter análises para este recurso. |
| Obter atividades por intervalo | itemActivityStat | Obter uma coleção de itemActivityStats dentro do intervalo de tempo especificado. |
| Listar secundários | Coleção de driveItem | Devolver uma coleção de driveItems na relação subordinada de um driveItem. |
| Listar versões | coleção driveItemVersion | Obtenha as versões de um ficheiro na unidade do utilizador atual. |
| Criar pasta | driveItem | Create um driveItem na unidade especificada. |
| Atualizar item | driveItem | Atualize um driveItem na unidade. |
| Carregar | driveItem | Carregue o conteúdo para o driveItem. |
| Baixar o arquivo | URL de download | Transfira o conteúdo de um driveItem. |
| Baixar o formato de arquivo específico | URL de download | Transfira o conteúdo de um driveItem com um formato específico. |
| Excluir item | Nenhum | Eliminar um driveItem. |
| Excluir permanentemente item | Nenhum | Elimine permanentemente um driveItem com o respetivo ID. |
| Mover item | driveItem | Mover um driveItem para um novo item principal. |
| Copiar item | detalhes sobre como monitorar o progresso da cópia | Create uma cópia de um driveItem (incluindo todas as crianças). |
| Pesquisar itens | Coleção de driveItem | Pesquise a hierarquia de itens para itens que correspondam a uma consulta. |
| Controlar alterações | link delta | Listar quaisquer alterações na unidade. |
| Seguir item | driveItem | Siga um driveItem. |
| Não seguir item | Nenhum | Não seguir um driveItem. |
| Obter miniaturas | Coleção driveItem | Liste driveItems com as miniaturas. |
| Criar link de compartilhamento | link de compartilhamento | Create uma ligação para partilhar o driveItem. |
| Adicionar permissões | Coleção permission | Enviar um convite de partilha a um utilizador. |
| Listar permissões | Coleção permission | Obtenha a coleção de permissões num driveItem. |
| Excluir permissão | Nenhum | Remova a permissão do driveItem. |
| Obter canal WebSocket | assinatura | Receba notificações de alteração quase em tempo real para uma unidade com socket.io. |
| Item de visualização | objeto json | Obtenha URLs incorporáveis de curta duração para um item de modo a renderizar uma visualização temporária. |
| Dar entrada de ficheiros | Nenhum | Dar entrada de um recurso driveItem com saída dada, o que torna a versão do documento disponível para outras pessoas. |
| Dar saída dos ficheiros | Nenhum | Consulte um recurso driveItem para impedir que outras pessoas editem o documento e impeça que as suas alterações fiquem visíveis até que seja dada entrada do documento. |
| Extrair etiquetas de confidencialidade | extractSensitivityLabelsResult | Extraia uma ou mais etiquetas de confidencialidade atribuídas a um item de unidade e atualize os metadados de um item de unidade com os detalhes mais recentes da etiqueta atribuída. |
| Atribuir etiqueta de confidencialidade | Cadeia de caracteres | Atribua de forma assíncrona uma etiqueta de confidencialidade a um driveItem. |
| Obter etiqueta de retenção | itemRetentionLabel | Obtenha informações de metadados para uma etiqueta de retenção aplicada num driveItem. |
| Definir etiqueta de retenção | itemRetentionLabel | Aplicar (definir) uma etiqueta de retenção num driveItem (ficheiros e pastas). |
| Remover etiqueta de retenção | Nenhum | Remova uma etiqueta de retenção de um driveItem. |
| Bloquear ou desbloquear o registo | itemRetentionLabel | Bloquear ou desbloquear uma etiqueta de retenção num driveItem que classifica o conteúdo como registos. |
Propriedades
| Propriedade | Tipo | Descrição |
|---|---|---|
| audio | audio | Metadados de áudio, se o item for um arquivo de áudio. Somente leitura. 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 utilizador, dispositivo e aplicação 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. Esta eTag não é alterada se apenas os metadados forem alterados. Nota Esta propriedade não é devolvida se o item for uma pasta. Somente leitura. |
| deleted | deleted | Informações sobre o estado excluído do item. Somente leitura. |
| description | String | Fornece uma descrição do item visível para o usuário. Leitura e 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 utilizador, dispositivo e aplicação que modificaram 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. |
| name | 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 houver, indica que uma ou mais operações que podem afetar o estado da driveItem estão pendentes. 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 é devolvida por predefiniçã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. |
| shared | compartilhado | Indica que o item foi partilhado com outras pessoas e fornece informações sobre o estado partilhado do 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. |
| 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. |
| retentionLabel | itemRetentionLabel | Informações sobre a etiqueta de retenção e as definições impostas no driveItem. Leitura e gravação. |
| assinaturas | conjunto de assinaturas | O conjunto de assinaturas no item. Compatível somente na raiz de uma unidade. |
| miniaturas | Coleção thumbnailSet | Coleção de objetos thumbnailSet associados ao item. Para obter mais informações, veja Obter 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 ficheiros que são folhas de cálculo do Excel, aceda à API do livro para trabalhar com os conteúdos da folha de cálculo. Anulável. |
Atributos de instância
Atributos de instância são propriedades com comportamentos especiais. Estas propriedades são temporárias e definem o comportamento que o serviço deve executar ou fornecer valores de propriedade de curto prazo, como um URL de transferência para um item que expira.
| 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 é devolvido com esta anotação. Somente gravação. |
| @microsoft.graph.downloadUrl | cadeia de caracteres | Uma URL que pode ser usada para baixar conteúdo desse arquivo. A autenticação não é necessária com este URL. Somente leitura. |
| @microsoft.graph.sourceUrl | cadeia de caracteres | Esta anotação de instância pode ser utilizada para instruir o serviço a transferir o conteúdo do URL ao emitir um pedido PUT e armazená-lo como o ficheiro. Somente gravação. |
Observações: O parâmetro
@microsoft.graph.conflictBehaviordeve ser incluído no URL em vez do corpo da solicitação.O valor
@microsoft.graph.downloadUrlé um URL de curta duração e não pode ser armazenado em cache. O URL é invalidado após um curto período de tempo (1 hora). Remover permissões de arquivo para um usuário pode não invalidar imediatamente o URL.O uso da
@microsoft.graph.sourceUrlpropriedade para carregamento de arquivo não é compatível no OneDrive for Business, SharePoint Online e SharePoint Server 2016.
Representação JSON
A representação JSON seguinte mostra o tipo de recurso.
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" },
"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" },
"retentionLabel": { "@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 */
"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"
}