Referência do OneDrive Work IQ (versão prévia)

Visão Geral

Ferramentas disponíveis

getOnedrive

Obtenha informações sobre o OneDrive do usuário, incluindo metadados de unidade, cota e informações de proprietário.

Nenhum parâmetro é necessário.

getFolderChildrenInMyOnedrive

Enumera os 20 principais arquivos e pastas, conhecidos como DriveItems, contidos em uma pasta pai especificada no OneDrive do usuário.

Parâmetros opcionais:

• Parentfolderid: ID da pasta pai cujos arquivos e pastas serão listados (padrão: 'raiz')

encontrarArquivoOuPastaNoMeuOnedrive

Localiza um arquivo ou pasta (DriveItem) no OneDrive do usuário por consulta de pesquisa. Mais eficiente do que pesquisar todos os arquivos acessíveis se você souber que o item está no OneDrive do usuário.

Parâmetros requeridos:

• Searchquery: Consulta de pesquisa; pode ser o nome inteiro ou parcial do arquivo

obterMetadadosDeArquivoOuPastaNoMeuOnedrive

Obtenha metadados de um arquivo ou pasta (DriveItem) do OneDrive do usuário.

Parâmetros requeridos:

• fileOrFolderId: ID do arquivo ou pasta no OneDrive do usuário

getFileOrFolderMetadataByUrl

Obtenha metadados de um arquivo ou pasta (DriveItem) de uma URL de compartilhamento. Somente usuários com permissões explícitas existentes para acessar o arquivo terão permissão para obter os metadados.

Parâmetros requeridos:

• fileOrFolderUrl: URL do arquivo ou pasta. A URL não será resgatada para compartilhá-la com o usuário; eles já devem ter acesso explícito

LeituraDeArquivoTextoPequenoDoMeuOnedrive

Leia (baixe) um arquivo de texto do OneDrive do usuário.

Parâmetros requeridos:

• Idarquivo: ID do arquivo (DriveItem) para leitura/download

criarArquivoPequenoDeTextoNoMeuOnedrive

Crie ou carregue um arquivo de texto de tamanho inferior a 5 MB no OneDrive do usuário.

Parâmetros requeridos:

• Filename: Nome do arquivo a ser criado
• Contenttext: Conteúdo de texto do arquivo

Parâmetros opcionais:

• Parentfolderid: ID da pasta pai (padrão: 'raiz')

createFolderInMyOnedrive

Crie uma nova pasta (DriveItem) no OneDrive do usuário como filho da pasta pai especificada. Se já existir uma pasta com o mesmo nome, um sufixo numérico será adicionado (por exemplo, NewFolder (1)).

Parâmetros requeridos:

• Foldername: Nome da pasta a ser criada

Parâmetros opcionais:

• Parentfolderid: ID da pasta pai (padrão: 'raiz')

renomearArquivoOuPastaNoMeuOnedrive

Renomeie um arquivo ou pasta (DriveItem) no OneDrive do usuário. O novo nome deve estar em conformidade com as convenções de nomenclatura.

Parâmetros requeridos:

• fileOrFolderId: ID do arquivo ou pasta a ser renomeada
• newFileOrFolderName: O novo nome para o arquivo ou pasta

Parâmetros opcionais:

• Etag: Valor de ETag para controle de simultaneidade. A operação só terá êxito se a ETag atual do DriveItem for correspondente

excluirArquivoOuPastaNoMeuOnedrive

Exclua um arquivo ou pasta (DriveItem) do OneDrive do usuário.

Parâmetros requeridos:

• fileOrFolderId: ID do arquivo ou pasta a ser excluída

Parâmetros opcionais:

• Etag: Valor de ETag para controle de simultaneidade

compartilharArquivoOuPastaNoMeuOnedrive

Envia um convite de compartilhamento para conceder permissões de leitura/gravação em um arquivo ou pasta (DriveItem) no OneDrive do usuário.

Parâmetros requeridos:

• fileOrFolderId: ID do arquivo ou pasta a ser compartilhada
• recipientEmails: Matriz de endereços de email de destinatários a serem convidados
• roles: matriz de funções a ser atribuída. Valores aceitos: 'leitura', 'gravação' (gravação concede acesso de leitura e gravação)

Parâmetros opcionais:

• Mensagem: Mensagem personalizada a ser incluída no email de convite (padrão: 'Aqui está o arquivo no qual estamos colaborando.')
• sendInvitation: Se é necessário enviar um convite de compartilhamento (padrão: true)

definirEtiquetaDeSensibilidadeNoArquivoNoMeuOnedrive

Defina o rótulo de confidencialidade de um arquivo no OneDrive do usuário.

Parâmetros requeridos:

• ID do arquivo: ID do arquivo (DriveItem)
• sensitivityLabelId: ID do rótulo de confidencialidade a ser atribuído ou cadeia de caracteres vazia a ser removida

Parâmetros opcionais:

• assignmentMethod: Método de atribuição: 'standard', 'privileged', 'auto' ou 'unknownFutureValue' (padrão: 'privileged')
• justificationText: Texto de justificativa para fins de auditoria; necessário ao fazer downgrade ou remover um rótulo (padrão: 'Alterado por MCPServer')

criarArquivoBinárioPequenoNoMeuOnedrive

Crie um arquivo binário de tamanho inferior a 5 MB codificando seu conteúdo com base64 para o OneDrive do usuário.

Parâmetros requeridos:

• Filename: Nome do arquivo a ser criado, incluindo a extensão de arquivo
• base64Content: O conteúdo do arquivo binário codificado como uma cadeia de caracteres base64

Parâmetros opcionais:

• Parentfolderid: ID da pasta pai (padrão: 'raiz')

readSmallBinaryFileFromMyOnedrive

Leia um arquivo binário de tamanho menor que 5 MB do OneDrive do usuário. O conteúdo do arquivo é retornado como uma cadeia de caracteres codificada em base64.

Parâmetros requeridos:

• Idarquivo: ID do arquivo (DriveItem) para ler ou baixar

copiarArquivoOuPastaNoMeuOnedrive

Copie um arquivo ou pasta (DriveItem) para uma pasta de destino no OneDrive do usuário. Esta operação é assíncrona; use checkOperationStatusInMyOnedrive para monitorar o progresso.

Parâmetros requeridos:

• sourcefileid: ID do arquivo ou pasta de origem (DriveItem) para copiar
• destfolderid: ID da pasta de destino (deve existir no OneDrive do usuário)

Parâmetros opcionais:

• newfilename: Novo nome para o item copiado (padrão para o nome original)

moveFileOrFolderInMyOnedrive

Mova um arquivo ou pasta (DriveItem) para uma pasta de destino dentro do OneDrive do usuário. Esta operação é assíncrona; use checkOperationStatusInMyOnedrive para monitorar o progresso.

Parâmetros requeridos:

• sourcefileid: ID do arquivo ou pasta de origem (DriveItem) para mover
• destfolderid: ID da pasta de destino (deve existir no OneDrive do usuário)

Parâmetros opcionais:

• newfilename: Novo nome para o item movido (padrão para o nome original)

checkOperationStatusInMyOnedrive

Verifique o status de uma operação assíncrona (como copiar ou mover) usando o token de operação retornado da operação original. Retorna informações de progresso se ainda estiver em andamento, detalhes de erro se falharam ou os metadados finais de arquivo ou pasta, se concluídos com êxito.

Parâmetros requeridos:

• operationToken: o token de operação retornado de uma operação assíncrona como copyFileOrFolderInMyOnedrive ou moveFileOrFolderInMyOnedrive

Recursos principais

gerenciamento de OneDrive

• Obter informações do OneDrive (cota, proprietário)
• Acessar o OneDrive pessoal do usuário
• Todas as operações têm como destino o OneDrive do usuário autenticado

Pesquisa e descoberta de arquivos

• Pesquisar arquivos e pastas por nome no OneDrive do usuário
• Obter metadados de arquivo ou pasta por ID ou URL de compartilhamento
• Procurar conteúdo de pasta (até 20 itens)

Operações de arquivo

• Criar arquivos binários e de texto (≤5 MB)
• Ler texto e arquivos binários (≤5MB)
• Excluir arquivos com controle de concorrência
• Renomear arquivos com proteção de eTag
• Copiar e mover arquivos e pastas de forma assíncrona

Gerenciamento de pastas

• Criar pastas com caminhos pai opcionais
• Sufixo numérico automático para nomes de pasta duplicados
• Listar o conteúdo da pasta (até 20 itens)
• Obter metadados de pasta
• Excluir pastas com controle de concorrência
• Renomear pastas com proteção de eTag

Compartilhamento e permissões

• Compartilhar arquivos e pastas com usuários
• Controle de acesso baseado em função (leitura, gravação)
• Notificações por email para compartilhamento
• Mensagens personalizadas em convites

Conformidade e segurança

• Aplicar e remover rótulos de confidencialidade
• Vários métodos de atribuição (padrão, privilegiado, automático)
• Suporte para justificativas em auditoria
• Controle de simultaneidade com eTags

Notes

• Todas as operações têm como destino o OneDrive pessoal do usuário autenticado
• As operações de arquivo são limitadas a ≤5MB para upload e download
• Operações de exclusão e renomeação dão suporte a eTags para controle de simultaneidade
• O compartilhamento requer endereços de email válidos e permissões apropriadas
• Rótulos de confidencialidade exigem licenciamento e configuração adequados
• A listagem de pastas retorna no máximo 20 itens por padrão