OneDrive
Visão geral
Seção intitulada “Visão geral”O OneDrive é a solução de armazenamento em nuvem da Microsoft que permite armazenar, sincronizar e compartilhar arquivos entre dispositivos, com acesso offline, colaboração em tempo real e segurança de nível empresarial. Com a integração no SquadOS, seus agentes podem gerenciar arquivos e pastas, ler e gravar planilhas Excel, controlar permissões de compartilhamento e reagir automaticamente a eventos de criação, atualização ou exclusão de itens no OneDrive.
- Site oficial: https://onedrive.live.com/
- Documentação na Composio: docs.composio.dev/toolkits/one_drive
Autenticação
Seção intitulada “Autenticação”Esta ferramenta utiliza OAuth 2.0 (OAUTH2) para conectar.
Você vai precisar autorizar o acesso à sua conta Microsoft. Nenhuma credencial manual é necessária — o fluxo OAuth redireciona para a página de login da Microsoft e solicita as permissões necessárias.
| Campo | Obrigatório | Descrição |
|---|---|---|
| Conta Microsoft | Sim | Conta pessoal, corporativa ou escolar associada ao OneDrive que será conectada. |
Como conectar no SquadOS
Seção intitulada “Como conectar no SquadOS”- Acesse Ferramentas no menu lateral (
/admin/tools). - Abra a aba Disponíveis e procure por
OneDrive. - Clique no card para abrir o modal de detalhes e em Conectar.
- Você é levado para a página de conexão segura hospedada pela Composio, onde autoriza o acesso com sua conta Microsoft.
- Ao concluir, você volta para o SquadOS com a conta conectada e a ferramenta disponível para os agentes. (Detalhes do fluxo em Ferramentas da Organização.)
Perguntas frequentes
Seção intitulada “Perguntas frequentes”Por que recebo erro 404 em ONE_DRIVE_DOWNLOAD_FILE para um arquivo compartilhado?
Seção intitulada “Por que recebo erro 404 em ONE_DRIVE_DOWNLOAD_FILE para um arquivo compartilhado?”Itens em “Compartilhados” podem ser referências a arquivos armazenados no SharePoint, não arquivos reais no OneDrive do usuário. Essas referências não podem ser baixadas pelos endpoints do OneDrive.
Para resolver, abra a localização do arquivo no OneDrive ou no SharePoint, escolha “Copiar para” e depois “Meus arquivos” para criar uma cópia no OneDrive do usuário e baixe a cópia. Se precisar de acesso programático a arquivos do SharePoint, use as APIs do SharePoint.
Ações disponíveis
Seção intitulada “Ações disponíveis”Adicionar planilha ao Excel
Seção intitulada “Adicionar planilha ao Excel”ONE_DRIVE_ADD_WORKBOOK_WORKSHEET
Adiciona uma nova planilha a uma pasta de trabalho Excel existente no OneDrive ou SharePoint. A planilha é criada com o nome especificado e anexada ao final da coleção de planilhas da pasta de trabalho. Use esta ação quando precisar criar uma nova aba em um arquivo Excel para organizar dados, adicionar relatórios ou separar informações em seções lógicas.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Não | Nome opcional para a nova planilha. Se omitido, o Excel determina o nome da planilha. Se já existir uma planilha com este nome, a API retornará um erro. |
item_id | string | Sim | Identificador único do item da pasta de trabalho (arquivo Excel) onde a planilha será adicionada. Deve ser um ID de driveItem válido para uma pasta de trabalho Excel. Obtenha via ONE_DRIVE_LIST_FOLDER_CHILDREN, ONE_DRIVE_SEARCH_ITEMS ou operações similares. |
drive_id | string | Sim | Identificador único do drive que contém a pasta de trabalho. Obtenha via ONE_DRIVE_LIST_DRIVES ou operações similares. |
session_id | string | Não | ID de sessão opcional da pasta de trabalho. Use para adicionar a planilha em uma sessão Excel existente. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Fazer check-in de item
Seção intitulada “Fazer check-in de item”ONE_DRIVE_CHECKIN_ITEM
Faz check-in de um driveItem que estava com check-out, tornando a versão do documento disponível para outros. Use quando precisar fazer check-in de um arquivo que estava com check-out no OneDrive ou SharePoint.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
comment | string | Não | Comentário de check-in associado à versão. |
drive_id | string | Sim | Identificador único do drive que contém o item para check-in. |
check_in_as | string | Não | Opcional. Status do documento após a operação de check-in. Pode ser ‘published’ ou não especificado. |
drive_item_id | string | Sim | Identificador único do driveItem para check-in. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Fazer check-out de item
Seção intitulada “Fazer check-out de item”ONE_DRIVE_CHECKOUT_ITEM
Faz check-out de um driveItem para impedir que outros o editem e tornar suas alterações invisíveis até o check-in. Use quando precisar bloquear um arquivo para edição exclusiva no SharePoint ou OneDrive.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
drive_id | string | Sim | Identificador único do drive que contém o item para check-out. |
drive_item_id | string | Sim | Identificador único do driveItem (arquivo ou pasta) para check-out. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Copiar item
Seção intitulada “Copiar item”ONE_DRIVE_COPY_ITEM
Copia um DriveItem (arquivo ou pasta) para um novo local de forma assíncrona. Use quando precisar duplicar um item, opcionalmente renomeando-o ou especificando uma pasta de destino diferente. A operação é assíncrona; a resposta fornece uma URL para monitorar o progresso da cópia. Não assuma que a cópia está completa imediatamente; verifique via ONE_DRIVE_GET_ITEM ou listando o destino, especialmente para grandes árvores de pastas.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Não | Novo nome para o item copiado. Se não fornecido, usa o mesmo nome do original. Recomendado fornecer name ou parent_reference para operação confiável. |
item_id | string | Sim | ID do DriveItem a ser copiado. |
site_id | string | Não | ID do site se o item estiver em um site do SharePoint. |
user_id | string | Não | ID do usuário se acessando o drive de outro usuário. |
drive_id | string | Não | ID do drive onde o item está localizado. Se não fornecido, assume ‘me’ (drive padrão do usuário). |
group_id | string | Não | ID do grupo se o item estiver em um drive de grupo. |
children_only | boolean | Não | Se verdadeiro, apenas os filhos do driveItem de origem (se for pasta) são copiados, não o driveItem em si. Padrão: false. Não pode ser usado com o parâmetro name. |
parent_reference | object | Não | Referência ao item pai (pasta) onde a cópia será criada. Se não fornecido, o item é copiado para o mesmo local. Recomendado fornecer name ou parent_reference. Deve usar IDs estáveis de itens do OneDrive (não caminhos ou nomes). Chaves esperadas: driveId e id. |
conflict_behavior | string | Não | Especifica como lidar com conflito de nomes. Valores: fail (padrão), replace ou rename. |
include_all_version_history | boolean | Não | Se verdadeiro, o histórico de versões do arquivo de origem é copiado para o destino. Padrão: false. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar permissão em item do drive
Seção intitulada “Criar permissão em item do drive”ONE_DRIVE_CREATE_ITEM_PERMISSION
Cria uma nova permissão em um item do drive OneDrive. Use quando precisar conceder permissões de aplicativo ou de grupo do SharePoint a um arquivo ou pasta. Este endpoint suporta apenas a criação de permissões de aplicativo e de grupo de site do SharePoint.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
roles | array | Sim | Array de strings de função do Microsoft Graph a atribuir à permissão. Valores comuns: read, write, owner para recursos de permissão do SharePoint/OneDrive for Business. |
drive_id | string | Sim | Identificador único do drive. |
drive_item_id | string | Sim | Identificador único do item do drive. |
granted_to_v2 | object | Sim | Identidade à qual conceder permissão. Deve conter a propriedade application ou siteGroup. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar link de compartilhamento
Seção intitulada “Criar link de compartilhamento”ONE_DRIVE_CREATE_LINK
Cria um link de compartilhamento para um DriveItem (arquivo ou pasta) pelo seu ID exclusivo. Use quando precisar gerar um link compartilhável para um item no OneDrive ou SharePoint.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
type | string | Sim | Tipo do link de compartilhamento. Valores válidos: view, edit, embed. |
scope | string | Não | Escopo do link. Se não especificado, usa o tipo de link padrão da organização. Valores válidos: view, edit, organization, anonymous. Use organization para restringir a usuários internos; anonymous expõe o conteúdo a qualquer pessoa com o link. Políticas do tenant podem bloquear ou restringir determinados escopos. |
item_id | string | Sim | Identificador único do item do drive (arquivo ou pasta) para o qual criar o link. Alguns tipos de item não podem ser compartilhados; se a criação do link falhar com ‘notSupported’, verifique se o tipo de item suporta compartilhamento. |
site_id | string | Não | Identificador único do site. Use se o item estiver no drive de um site do SharePoint. |
user_id | string | Não | Identificador único do usuário. Use se o item estiver no drive de outro usuário. |
drive_id | string | Não | Identificador único do drive. Se não fornecido, o link será criado no drive do usuário atual (me/drive). |
group_id | string | Não | Identificador único do grupo. Use se o item estiver no drive de um grupo. |
password | string | Não | Senha para o link de compartilhamento. Opcional e exclusivo do OneDrive Personal. |
recipients | array | Não | Lista de destinatários para o link de compartilhamento. Obrigatório quando o escopo for ‘users’. Cada destinatário deve ser um dicionário com chave ‘email’. |
expiration_date_time | string | Não | Data e hora de expiração da permissão, no formato yyyy-MM-ddTHH:mm:ssZ. Deve ser um timestamp UTC futuro. |
retain_inherited_permissions | boolean | Não | Se verdadeiro (padrão), as permissões herdadas existentes são mantidas. Se falso, todas as permissões existentes são removidas no primeiro compartilhamento. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir item
Seção intitulada “Excluir item”ONE_DRIVE_DELETE_ITEM
Exclui um DriveItem (arquivo ou pasta) pelo seu ID exclusivo do OneDrive do usuário autenticado. Esta ação move o item para a lixeira, não o exclui permanentemente; o espaço em disco não é liberado até que a lixeira seja esvaziada. Exclusões em massa podem disparar respostas 429 (limite de taxa) ou 5xx — limite a concorrência e use backoff exponencial.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
item_id | string | Sim | Identificador único do DriveItem (arquivo ou pasta) a ser excluído. |
user_id | string | Não | ID, e-mail ou ‘me’ do usuário. Padrão: ‘me’ (usuário autenticado). Obrigatório para autenticação S2S (somente app). |
drive_id | string | Não | Identificador único do Drive onde o item está localizado. Se não fornecido, a ação terá como alvo o OneDrive pessoal do usuário (me/drive). Sempre especifique o drive_id para drives de grupo, drives de site do SharePoint ou bibliotecas compartilhadas. |
if_match | string | Não | Se incluído e o eTag (ou cTag) fornecido não coincidir com o tag atual do item, uma resposta 412 Precondition Failed é retornada e o item não será excluído. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir item permanentemente
Seção intitulada “Excluir item permanentemente”ONE_DRIVE_DELETE_ITEM_PERMANENTLY
Exclui permanentemente um driveItem pelo seu ID sem movê-lo para a lixeira. Use quando precisar remover irreversivelmente um arquivo ou pasta do OneDrive ou SharePoint. Esta ação não pode ser desfeita.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
item_id | string | Sim | Identificador único do item do drive (arquivo ou pasta) a ser excluído permanentemente. Esta ação exclui o item sem movê-lo para a lixeira e não pode ser desfeita. |
drive_id | string | Sim | Identificador único do drive que contém o item a ser excluído permanentemente. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir permissão de item do drive
Seção intitulada “Excluir permissão de item do drive”ONE_DRIVE_DELETE_ITEM_PERMISSION
Exclui uma permissão de um item do drive. Use quando precisar revogar o acesso de compartilhamento a um arquivo ou pasta. Apenas permissões de compartilhamento não herdadas podem ser excluídas.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
item_id | string | Sim | Identificador único do item do drive (arquivo ou pasta). |
perm_id | string | Sim | Identificador único da permissão a ser excluída. Apenas permissões de compartilhamento não herdadas podem ser excluídas. |
site_id | string | Não | Identificador único de um site do SharePoint. Use se o item estiver no drive de um site do SharePoint. |
user_id | string | Não | Identificador único de um usuário. Use se o item estiver no drive de um usuário específico (diferente de ‘me’). |
drive_id | string | Não | Identificador único do drive. Se não fornecido, a ação terá como alvo o OneDrive pessoal do usuário (me/drive). |
group_id | string | Não | Identificador único do grupo. Use se o item estiver no drive de um grupo. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir permissão de compartilhamento
Seção intitulada “Excluir permissão de compartilhamento”ONE_DRIVE_DELETE_SHARE_PERMISSION
Exclui a propriedade de navegação de permissão de um item do drive compartilhado. Use quando precisar remover a permissão de um link de compartilhamento. Isso efetivamente revoga o acesso via link de compartilhamento específico.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
shared_drive_item_id | string | Sim | ID de compartilhamento ou URL de compartilhamento codificada em base64. É o shareId retornado pela resposta da API createLink. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir intervalo de planilha Excel
Seção intitulada “Excluir intervalo de planilha Excel”ONE_DRIVE_DELETE_WORKBOOK_RANGE
Exclui um intervalo de células de uma planilha em uma pasta de trabalho Excel armazenada no OneDrive. Use quando precisar remover um intervalo específico de células e deslocar as células restantes para preencher o espaço. Esta ação é irreversível. A operação requer o escopo Files.ReadWrite e a pasta de trabalho não deve estar bloqueada por outro usuário ou processo.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
range | string | Sim | Endereço do intervalo a excluir em notação A1. Pode ser uma única célula (ex.: ‘A1’) ou um intervalo de células (ex.: ‘A1:D4’). O intervalo deve ser válido para a planilha. |
shift | string | Sim | Direção para deslocar as células restantes após a exclusão. ‘Up’ desloca as células para cima para preencher o espaço; ‘Left’ desloca as células para a esquerda. |
item_id | string | Sim | Identificador único do item da pasta de trabalho Excel. É o ID do driveItem do arquivo .xlsx que contém a planilha. |
drive_id | string | Sim | Identificador único do drive que contém a pasta de trabalho. |
worksheet | string | Sim | Nome ou ID da planilha que contém o intervalo a excluir. Pode ser o nome (ex.: ‘Sheet1’) ou o ID da planilha. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir planilha do Excel
Seção intitulada “Excluir planilha do Excel”ONE_DRIVE_DELETE_WORKBOOK_WORKSHEET
Exclui uma planilha de uma pasta de trabalho no OneDrive pelo seu ID ou nome. Use quando precisar remover uma planilha específica de uma pasta de trabalho Excel armazenada no OneDrive ou SharePoint. Esta ação é irreversível. Excluir a última planilha visível de uma pasta de trabalho pode resultar em erro.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
item_id | string | Sim | ID do item da pasta de trabalho (arquivo Excel). |
drive_id | string | Sim | ID do drive que contém a pasta de trabalho. |
session_id | string | Não | ID de sessão opcional da pasta de trabalho. Se fornecido, será enviado no cabeçalho ‘workbook-session-id’ para manter o contexto de sessão. |
worksheet_id_or_name | string | Sim | ID ou nome da planilha a excluir da pasta de trabalho. Pode ser o identificador único ou o nome de exibição (ex.: ‘Sheet1’). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Descartar check-out
Seção intitulada “Descartar check-out”ONE_DRIVE_DISCARD_CHECKOUT
Descarta o check-out de um driveItem, liberando-o e descartando quaisquer alterações feitas durante o check-out. Use quando precisar cancelar um check-out e reverter alterações em um arquivo no SharePoint ou OneDrive.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
drive_id | string | Sim | Identificador único do drive que contém o item para descartar o check-out. |
drive_item_id | string | Sim | Identificador único do driveItem (arquivo ou pasta) para descartar o check-out. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Baixar arquivo
Seção intitulada “Baixar arquivo”ONE_DRIVE_DOWNLOAD_FILE
Baixa um arquivo do OneDrive de um usuário usando seu ID de item, que deve se referir a um arquivo, não a uma pasta. A resposta contém um objeto content com os campos: s3url (URL para buscar os bytes brutos do arquivo), mimetype e name; os dados brutos do arquivo não são retornados diretamente. A análise de conteúdo de Excel, Word, PDF ou outros formatos requer ferramentas adicionais. A resposta também inclui attachment.s3key, necessário ao passar este arquivo para ferramentas downstream como OUTLOOK_SEND_EMAIL ou OUTLOOK_CREATE_DRAFT.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
format | string | Não | Formato opcional para conversão de arquivo durante o download. ‘pdf’ converte arquivos suportados para PDF. ‘html’ converte arquivos Loop/Fluid para HTML. Deixe vazio para baixar no formato original. Não use este parâmetro se o arquivo já estiver no formato alvo. |
item_id | string | Sim | ID bruto do item apenas (ex.: ‘1234567890ABC’). Não inclua fragmentos de URL ou parâmetros de consulta de links de compartilhamento. |
user_id | string | Não | ID do usuário ou Nome Principal do Usuário (UPN), ou ‘me’ para o OneDrive do usuário autenticado. Ignorado quando drive_id é fornecido. |
drive_id | string | Não | ID do drive que contém o arquivo. Obrigatório para drives do SharePoint ou OneDrive for Business. Quando fornecido, user_id é ignorado. |
file_name | string | Sim | Nome de arquivo desejado (incluindo extensão) para o conteúdo baixado. |
if_none_match | string | Não | Valor opcional de ETag ou cTag para download condicional. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Baixar arquivo por caminho
Seção intitulada “Baixar arquivo por caminho”ONE_DRIVE_DOWNLOAD_FILE_BY_PATH
Baixa o conteúdo de um arquivo do OneDrive pelo seu caminho. A API retorna um redirecionamento 302 para uma URL de download pré-autenticada. Use quando souber o caminho do arquivo, mas não o ID do item.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
user_id | string | Não | ID, e-mail ou ‘me’ do usuário. Padrão: ‘me’ (usuário autenticado). Obrigatório para autenticação S2S. |
file_name | string | Sim | Nome de arquivo desejado (incluindo extensão) para o conteúdo baixado. |
item_path | string | Sim | Caminho para o arquivo no OneDrive, relativo à raiz do drive (ex.: ‘document.txt’ ou ‘folder/subfolder/file.pdf’). Não inclua barra inicial. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Baixar item em formato específico
Seção intitulada “Baixar item em formato específico”ONE_DRIVE_DOWNLOAD_ITEM_AS_FORMAT
Baixa o conteúdo de um driveItem convertido para um formato específico (ex.: PDF ou HTML). Use quando precisar converter documentos Office para PDF ou arquivos Loop/Fluid para HTML antes de baixar. Suporta acesso a itens por item_id ou por caminho, e pode ter como alvo drives específicos via drive_id.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
format | string | Sim | Formato para converter o item. Use ‘pdf’ para documentos Office ou ‘html’ para arquivos Loop/Fluid. |
item_id | string | Não | Identificador único do driveItem a converter. Se fornecido, tem precedência sobre path_and_filename. |
user_id | string | Não | ID do usuário ou UPN, ou ‘me’ para o OneDrive do usuário autenticado. Ignorado quando drive_id é fornecido. |
drive_id | string | Não | Identificador único do drive. Opcional — use para bibliotecas de documentos do SharePoint. |
file_name | string | Sim | Nome de arquivo desejado (incluindo extensão) para o conteúdo convertido baixado. |
path_and_filename | string | Não | Caminho e nome do arquivo do driveItem abaixo da raiz (ex.: ‘Documents/report.docx’). Não inclua barra inicial. É necessário item_id ou path_and_filename. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Baixar versão anterior de item
Seção intitulada “Baixar versão anterior de item”ONE_DRIVE_DOWNLOAD_ITEM_VERSION
Baixa o conteúdo de uma versão anterior específica de um item do drive (arquivo). Retorna o conteúdo real do arquivo. Nota: não é possível baixar a versão atual usando este endpoint — ele funciona apenas para versões anteriores.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
item_id | string | Sim | Identificador único do item do drive (arquivo). Não pode ser um ID de pasta. |
drive_id | string | Não | Identificador único do drive que contém o arquivo. Se não fornecido, usa o OneDrive pessoal do usuário (me/drive). |
file_name | string | Sim | Nome de arquivo desejado (incluindo extensão) para o conteúdo da versão baixada. |
version_id | string | Sim | ID da versão específica a baixar (ex.: ‘1.0’, ‘2.0’). Não pode ser a versão atual — apenas versões anteriores podem ser baixadas por este endpoint. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Seguir item do drive
Seção intitulada “Seguir item do drive”ONE_DRIVE_FOLLOW_ITEM
Segue um driveItem (arquivo ou pasta) no OneDrive ou SharePoint. Use quando precisar adicionar um item à lista de itens seguidos do usuário para rastrear atualizações.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
drive_id | string | Sim | Identificador único do drive que contém o item a seguir. Pode ser o ID de um OneDrive pessoal, de uma biblioteca de documentos de grupo ou de um drive de site do SharePoint. |
driveItem_id | string | Sim | Identificador único do driveItem (arquivo ou pasta) a seguir. IDs de DriveItem são sensíveis a maiúsculas e minúsculas e devem ser usados exatamente como retornados pela API do Microsoft Graph. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter drive
Seção intitulada “Obter drive”ONE_DRIVE_GET_DRIVE
Recupera as propriedades e relacionamentos de um recurso Drive pelo seu ID exclusivo. Use quando precisar obter detalhes sobre um OneDrive específico, o OneDrive de um usuário, a biblioteca de documentos de um grupo ou a biblioteca de documentos de um site. Apenas os drives acessíveis ao usuário autenticado são retornados.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
drive_id | string | Sim | Identificador único do drive. Use ONE_DRIVE_LIST_DRIVES para obter IDs de drive válidos. |
expand_fields | array | Não | Lista separada por vírgulas de relacionamentos a expandir e incluir na resposta. |
select_fields | array | Não | Lista separada por vírgulas de propriedades a incluir na resposta. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter DriveItem por URL de compartilhamento
Seção intitulada “Obter DriveItem por URL de compartilhamento”ONE_DRIVE_GET_DRIVE_ITEM_BY_SHARING_URL
Resolve uma URL de compartilhamento do OneDrive/SharePoint (ou shareId) para um DriveItem com driveId e itemId. Use quando tiver um link de compartilhamento do Teams, chat ou 1drv.ms e precisar dos metadados ou IDs do item para ações downstream como permissões ou download.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
sharing_url | string | Não | URL de compartilhamento do OneDrive ou SharePoint (ex.: link 1drv.ms, link SharePoint ou contentUrl do Teams). Mutuamente exclusivo com share_id_or_encoded_url. |
prefer_redeem | string | Não | Controla o resgate de acesso. ‘redeemSharingLink’ concede acesso durável. ‘redeemSharingLinkIfNecessary’ concede acesso apenas para esta solicitação. |
select_fields | array | Não | Lista de propriedades do DriveItem a retornar. |
expand_children | boolean | Não | Se verdadeiro e o item for uma pasta, expande a coleção de filhos para incluir itens filhos na resposta. |
share_id_or_encoded_url | string | Não | Token de compartilhamento já codificado (prefixado com ‘u!’) ou token shareId de uma chamada de API anterior. Mutuamente exclusivo com sharing_url. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter item seguido do drive
Seção intitulada “Obter item seguido do drive”ONE_DRIVE_GET_FOLLOWED_ITEM
Recupera um driveItem seguido específico de um drive. Use quando precisar obter detalhes sobre um arquivo ou pasta que o usuário marcou para seguir.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
drive_id | string | Sim | Identificador único do drive. |
driveItem_id | string | Sim | Identificador único do driveItem seguido a recuperar. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter drive do grupo
Seção intitulada “Obter drive do grupo”ONE_DRIVE_GET_GROUP_DRIVE
Recupera a biblioteca de documentos (drive) de um grupo Microsoft 365. Use quando precisar acessar a biblioteca de documentos padrão associada a um grupo específico.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
group_id | string | Sim | Identificador único do grupo cuja biblioteca de documentos você deseja recuperar. |
select_fields | array | Não | Lista de propriedades a incluir na resposta. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter metadados de item
Seção intitulada “Obter metadados de item”ONE_DRIVE_GET_ITEM
Recupera os metadados de um DriveItem pelo seu ID exclusivo. Use para obter informações sobre um arquivo ou pasta específico no OneDrive quando tiver o ID. Se drive_id não for fornecido, usa o drive principal do usuário.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
item_id | string | Sim | Identificador único do DriveItem (arquivo ou pasta). IDs são sensíveis a maiúsculas e minúsculas. Obtenha via ONE_DRIVE_LIST_FOLDER_CHILDREN, ONE_DRIVE_SEARCH_ITEMS ou operações similares. Não use URLs web, links de compartilhamento ou IDs construídos manualmente. |
drive_id | string | Não | Identificador único do Drive onde o item está localizado. Se não fornecido, usa o OneDrive pessoal do usuário (me/drive). |
select_fields | array | Não | Lista de propriedades do DriveItem a retornar. |
expand_relations | array | Não | Propriedades de navegação a expandir. Valores válidos: ‘children’, ‘thumbnails’, ‘versions’, ‘permissions’, ‘listItem’, ‘activities’, ‘analytics’, etc. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter permissões de item
Seção intitulada “Obter permissões de item”ONE_DRIVE_GET_ITEM_PERMISSIONS
Recupera as permissões de um DriveItem pelo seu ID exclusivo em um Drive específico. Use quando precisar verificar quem tem acesso a um arquivo ou pasta e qual nível de acesso cada um tem.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
select | string | Não | Lista separada por vírgulas de propriedades a incluir na resposta. Ex.: ‘id,roles,link’. |
item_id | string | Não | Identificador único do item do drive. Obrigatório a menos que item_path seja fornecido. |
site_id | string | Não | Identificador único de um site do SharePoint. |
user_id | string | Não | Identificador único de um usuário. |
drive_id | string | Não | Identificador único do drive. |
group_id | string | Não | Identificador único de um grupo. |
item_path | string | Não | Caminho para o item relativo à raiz do drive. Deve começar com ’:/’ e terminar com ’:/’. |
if_none_match | string | Não | Se este valor de cabeçalho de solicitação (etag) coincidir com o etag atual do item, uma resposta HTTP 304 é retornada. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter miniaturas de item
Seção intitulada “Obter miniaturas de item”ONE_DRIVE_GET_ITEM_THUMBNAILS
Recupera as miniaturas associadas a um DriveItem. Use quando precisar exibir pré-visualizações visuais de arquivos. Miniaturas podem não estar disponíveis para todos os tipos de arquivo ou itens recém-enviados.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
select | string | Não | Lista separada por vírgulas de tamanhos de miniatura a recuperar (ex.: “small,medium,large”). |
item_id | string | Sim | Identificador único do DriveItem. |
site_id | string | Não | Identificador único de um Site. |
user_id | string | Não | Identificador único de um Usuário. |
drive_id | string | Não | Identificador único do Drive. Se não fornecido, usa o drive do usuário atual. |
group_id | string | Não | Identificador único de um Grupo. |
original_orientation | boolean | Não | Se verdadeiro, recupera a miniatura com orientação EXIF original. Suportado apenas no OneDrive Personal. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter versões de item
Seção intitulada “Obter versões de item”ONE_DRIVE_GET_ITEM_VERSIONS
Recupera o histórico de versões de um DriveItem pelo seu ID exclusivo. Use quando precisar acessar ou listar versões anteriores de um arquivo.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
item_id | string | Sim | Identificador único do item (arquivo ou pasta). |
site_id | string | Não | Identificador único do site. Mutuamente exclusivo com drive_id, group_id e user_id. |
user_id | string | Não | Identificador único do usuário. Mutuamente exclusivo com drive_id, group_id e site_id. |
drive_id | string | Não | Identificador único do drive. Mutuamente exclusivo com group_id, site_id e user_id. |
group_id | string | Não | Identificador único do grupo. Mutuamente exclusivo com drive_id, site_id e user_id. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter itens recentes
Seção intitulada “Obter itens recentes”ONE_DRIVE_GET_RECENT_ITEMS
Obtém arquivos e pastas acessados recentemente pelo usuário. Retorna itens baseados no histórico de atividades (abertos, editados, visualizados), ordenados pelo mais recente primeiro. Use quando precisar ver com o que o usuário trabalhou recentemente.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
top | integer | Não | Número máximo de itens recentes a retornar (1–200). |
select | string | Não | Lista separada por vírgulas de propriedades a incluir na resposta. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter pasta raiz do drive
Seção intitulada “Obter pasta raiz do drive”ONE_DRIVE_GET_ROOT
Recupera metadados para a pasta raiz do OneDrive do usuário autenticado. Use quando precisar de informações sobre o diretório raiz do OneDrive do usuário, como tamanho, contagem de filhos ou URL web.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
user_id | string | Não | ID, e-mail ou ‘me’ do usuário. Padrão: ‘me’. Obrigatório para autenticação S2S. |
select_fields | array | Não | Lista de propriedades a incluir na resposta. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter item compartilhado por ShareId
Seção intitulada “Obter item compartilhado por ShareId”ONE_DRIVE_GET_SHARE
Acessa um DriveItem compartilhado ou coleção de itens compartilhados usando um shareId ou URL de compartilhamento codificada. Retorna o recurso sharedDriveItem com metadados sobre o item compartilhado e seu proprietário.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
prefer_redeem | string | Não | Controla o resgate de acesso. ‘redeemSharingLink’ concede acesso permanente. ‘redeemSharingLinkIfNecessary’ concede acesso temporário. |
expand_children | boolean | Não | Se verdadeiro e o item compartilhado for uma pasta, expande a coleção de filhos. |
share_id_or_encoded_sharing_url | string | Sim | Token de compartilhamento (shareId) ou URL de compartilhamento codificada corretamente. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter itens compartilhados comigo
Seção intitulada “Obter itens compartilhados comigo”ONE_DRIVE_GET_SHARED_ITEMS
Recupera itens compartilhados com o usuário autenticado (não itens que o usuário compartilhou com outros). Retorna arquivos e pastas compartilhados com o usuário atual.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
allow_external | boolean | Não | Defina como verdadeiro para incluir itens compartilhados de tenants externos. Padrão: false, retorna apenas itens compartilhados dentro do tenant do usuário. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter itens de lista do SharePoint
Seção intitulada “Obter itens de lista do SharePoint”ONE_DRIVE_GET_SHAREPOINT_LIST_ITEMS
Obtém os itens (itens de lista) dentro de uma lista específica do SharePoint em um site. Use quando precisar recuperar dados de uma lista do SharePoint.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
top | integer | Não | Número máximo de itens a retornar em uma única resposta. |
skip | integer | Não | Número de itens a pular no conjunto de resultados. |
count | boolean | Não | Se verdadeiro, retorna a contagem total de itens na propriedade @odata.count. |
expand | string | Não | Lista separada por vírgulas de relacionamentos a expandir. Use ‘fields($select=columnName1,columnName2)’ para recuperar campos específicos. |
filter | string | Não | Consulta de filtro OData para restringir os resultados. Ex.: ‘fields/Quantity lt 600’. |
select | string | Não | Lista separada por vírgulas de propriedades a incluir na resposta. |
list_id | string | Sim | Identificador único da lista dentro do site do SharePoint. |
orderby | string | Não | Expressão de ordenação OData. |
site_id | string | Sim | Identificador único do site do SharePoint. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter detalhes de site
Seção intitulada “Obter detalhes de site”ONE_DRIVE_GET_SITE
Recupera metadados para um site específico do SharePoint pelo seu ID. Use quando precisar obter detalhes como nome de exibição, URL web e datas de criação/modificação para um site do SharePoint conhecido.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
expand | string | Não | Lista separada por vírgulas de relacionamentos a expandir. Ex.: columns,lists,drives |
select | string | Não | Lista separada por vírgulas de propriedades a incluir. Ex.: id,displayName,webUrl |
site_id | string | Sim | Identificador único do site do SharePoint. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter conteúdo de página de site do SharePoint
Seção intitulada “Obter conteúdo de página de site do SharePoint”ONE_DRIVE_GET_SITE_PAGE_CONTENT
Obtém o conteúdo de uma página moderna de site do SharePoint. Use quando precisar recuperar os detalhes e o conteúdo de uma página específica dentro de um site do SharePoint.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
expand | string | Não | Expande entidades relacionadas. Ex.: use ‘canvasLayout’ para incluir o layout e o conteúdo da web part da página. |
select | string | Não | Lista separada por vírgulas de propriedades a incluir. Ex.: id,name,title |
page_id | string | Sim | Identificador único da página do site. |
site_id | string | Sim | Identificador único do site do SharePoint. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter pasta especial do drive
Seção intitulada “Obter pasta especial do drive”ONE_DRIVE_GET_SPECIAL_FOLDER
Recupera uma pasta especial no OneDrive pelo nome. Use quando precisar acessar pastas conhecidas (documents, photos, approot, etc.) sem precisar procurar por caminho ou ID.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
user_id | string | Não | ID, e-mail ou ‘me’ do usuário. Padrão: ‘me’. Obrigatório para autenticação S2S. |
select_fields | array | Não | Lista de propriedades a incluir na resposta. |
expand_relations | array | Não | Propriedades de navegação a expandir. |
special_folder_name | string | Sim | Nome da pasta especial a recuperar. Valores válidos: ‘documents’, ‘photos’, ‘cameraroll’, ‘approot’, ‘music’, ‘recordings’. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter perfil de usuário
Seção intitulada “Obter perfil de usuário”ONE_DRIVE_GET_USER
Recupera as propriedades e informações de perfil de um usuário específico da Microsoft pelo seu ID ou nome principal do usuário. Esta ação requer o escopo OAuth User.Read ou User.ReadBasic.All.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
select | array | Não | Propriedades específicas a retornar na resposta. |
user_id | string | Sim | Nome principal do usuário (UPN) ou ID do usuário a recuperar. Exemplos: ‘user@contoso.com’ ou ‘87d349ed-44d7-43e1-9a83-5f2406dee5bd’. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter planilha Excel
Seção intitulada “Obter planilha Excel”ONE_DRIVE_GET_WORKBOOK_WORKSHEET
Recupera uma planilha específica de uma pasta de trabalho Excel armazenada no OneDrive ou SharePoint. Use quando precisar obter detalhes sobre uma planilha específica, incluindo ID, nome, posição e visibilidade.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
select | string | Não | Lista separada por vírgulas de propriedades a selecionar (ex.: ‘id,name,position’). |
item_id | string | Sim | ID do item da pasta de trabalho (arquivo Excel). |
drive_id | string | Sim | ID do drive que contém a pasta de trabalho. |
session_id | string | Não | ID de sessão opcional da pasta de trabalho. |
worksheet_id_or_name | string | Sim | ID ou nome da planilha a recuperar. Será codificado automaticamente. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Conceder permissão de compartilhamento
Seção intitulada “Conceder permissão de compartilhamento”ONE_DRIVE_GRANT_SHARE_PERMISSION
Concede acesso de usuários a um link representado por uma permissão usando uma URL de compartilhamento codificada. Use quando precisar dar a usuários específicos acesso a um recurso compartilhado do OneDrive ou SharePoint.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
roles | array | Sim | Array de strings de função do Microsoft Graph especificando o nível de acesso a conceder. Valores comuns: ‘read’ e ‘write’. |
recipients | array | Sim | Array de objetos de destinatário com endereços de e-mail que receberão acesso ao link compartilhado. |
encoded_sharing_url | string | Sim | URL de compartilhamento codificada em base64url (deve ser prefixada com u!). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Convidar usuário para item do drive
Seção intitulada “Convidar usuário para item do drive”ONE_DRIVE_INVITE_USER_TO_ITEM
Convida usuários ou concede permissões a um item específico em um drive do OneDrive. Use quando precisar compartilhar um arquivo ou pasta com outros usuários e definir o nível de acesso deles (ex.: leitura ou escrita).
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
roles | array | Sim | Funções a conceder aos destinatários. Valores comuns: ‘read’ e ‘write’. |
item_id | string | Sim | Identificador único do item do drive (arquivo ou pasta). |
message | string | Não | Mensagem em texto simples incluída no convite de compartilhamento. Máximo: 2.000 caracteres. |
site_id | string | Não | Identificador único de um site do SharePoint. |
user_id | string | Não | Identificador único de um usuário. |
drive_id | string | Não | Identificador único do drive. |
group_id | string | Não | Identificador único de um grupo Microsoft 365. |
password | string | Não | Senha do convite definida pelo criador. Opcional e exclusivo do OneDrive Personal. |
recipients | array | Sim | Coleção de destinatários que receberão acesso e o convite de compartilhamento. |
require_sign_in | boolean | Não | Especifica se o destinatário é obrigado a fazer login para visualizar o item compartilhado. |
send_invitation | boolean | Não | Se verdadeiro, um link de compartilhamento é enviado ao destinatário. |
expiration_date_time | string | Não | Especifica a data e hora após as quais a permissão expira. Formato ISO 8601. |
retain_inherited_permissions | boolean | Não | Se verdadeiro (padrão), as permissões herdadas são mantidas. Se falso, todas as permissões existentes são removidas no primeiro compartilhamento. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar atividades do drive
Seção intitulada “Listar atividades do drive”ONE_DRIVE_LIST_ACTIVITIES
Recupera atividades recentes no OneDrive do usuário autenticado. Use quando precisar rastrear mudanças ou ações recentes realizadas em todo o drive.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
top | integer | Não | Número máximo de atividades a retornar. Deve ser entre 1 e 999. |
drive_id | string | Não | ID do drive para listar atividades. Se não fornecido, usa o drive padrão do usuário autenticado. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar todos os itens do drive recursivamente
Seção intitulada “Listar todos os itens do drive recursivamente”ONE_DRIVE_LIST_ALL_DRIVE_ITEMS
Lista recursivamente todos os arquivos e pastas em um drive do OneDrive percorrendo toda a hierarquia de pastas. Para drives grandes com milhares de itens, esta operação pode demorar bastante.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
expand | string | Não | Entidades relacionadas a expandir (ex.: ‘children’, ‘thumbnails’). |
select | array | Não | Propriedades específicas a retornar para cada item. |
drive_id | string | Sim | ID do drive a listar itens. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar bundles do drive
Seção intitulada “Listar bundles do drive”ONE_DRIVE_LIST_BUNDLES
Recupera uma lista de recursos bundle de um drive especificado. Bundles são coleções de arquivos (ex.: álbuns de fotos). Use quando precisar listar bundles em um drive.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
top | integer | Não | Número máximo de itens a retornar em uma única página. Deve ser entre 1 e 999. |
expand | string | Não | Lista separada por vírgulas de relacionamentos a expandir. |
filter | string | Não | Consulta de filtro OData. Ex.: ‘bundle/album ne null’ para listar apenas álbuns de fotos. |
select | string | Não | Lista separada por vírgulas de propriedades a incluir. |
orderby | string | Não | Lista separada por vírgulas de propriedades para ordenar os resultados. |
drive_id | string | Sim | Identificador único do drive para listar bundles. |
skip_token | string | Não | Token para recuperar a próxima página de resultados. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar drives
Seção intitulada “Listar drives”ONE_DRIVE_LIST_DRIVES
Recupera uma lista de recursos Drive disponíveis para o usuário autenticado, ou para um usuário, grupo ou site específico. Use quando precisar descobrir quais drives estão acessíveis.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
top | integer | Não | Número máximo de itens a retornar em uma única página. Deve ser entre 1 e 999. |
expand | string | Não | Lista separada por vírgulas de relacionamentos a expandir. |
select | string | Não | Lista separada por vírgulas de propriedades a incluir. |
orderby | string | Não | Lista de propriedades para ordenar os resultados. |
site_id | string | Não | ID do site para listar drives. |
user_id | string | Não | ID do usuário para listar drives. Se nenhum dos três (group_id, site_id, user_id) for fornecido, lista os drives do usuário autenticado atual. |
group_id | string | Não | ID do grupo para listar drives. |
skip_token | string | Não | Token para recuperar a próxima página de resultados. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar filhos de pasta
Seção intitulada “Listar filhos de pasta”ONE_DRIVE_LIST_FOLDER_CHILDREN
Lista os filhos diretos (arquivos/pastas) de uma pasta do OneDrive/SharePoint pelo ID do DriveItem ou por caminho. Retorna tokens de paginação confiáveis para pastas grandes.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
top | integer | Não | Número máximo de itens a retornar por página. Padrão: 200. |
expand | array | Não | Lista de relacionamentos a expandir (ex.: [‘thumbnails’, ‘permissions’]). |
select | array | Não | Lista de propriedades a incluir na resposta. |
orderby | string | Não | Ordenar resultados por propriedades especificadas. |
site_id | string | Não | Se fornecido, usa a rota /sites/{site-id}/drive/… para sites do SharePoint. |
drive_id | string | Não | ID do drive. Obrigatório a menos que use_me_drive ou site_id seja fornecido. |
next_link | string | Não | URL @odata.nextLink completa de uma resposta anterior para continuação de paginação. |
skip_token | string | Não | Valor $skipToken de uma resposta anterior para continuação de paginação. |
folder_path | string | Não | Caminho relativo à raiz do drive (ex.: ’/’, ‘/Recordings’, ‘/Documents/Project’). |
use_me_drive | boolean | Não | Se verdadeiro, usa a rota /me/drive/… para o OneDrive pessoal do usuário autenticado. |
folder_item_id | string | Não | ID da pasta (DriveItem) para listar filhos. Obrigatório a menos que folder_path seja fornecido. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar atividades de item do drive
Seção intitulada “Listar atividades de item do drive”ONE_DRIVE_LIST_ITEM_ACTIVITIES
Lista atividades recentes para um item específico em um drive do OneDrive. Use quando precisar rastrear alterações ou ações realizadas em um arquivo ou pasta.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
top | integer | Não | Mostrar apenas os primeiros n itens. |
skip | integer | Não | Pular os primeiros n itens para paginação. |
expand | array | Não | Lista de relacionamentos a expandir. |
filter | string | Não | Expressão de filtro OData para filtrar atividades. |
select | array | Não | Lista de propriedades a incluir na resposta. |
item_id | string | Sim | Identificador único do driveItem. |
orderby | string | Não | Ordenar resultados por propriedades especificadas. |
drive_id | string | Sim | Identificador único do drive. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar alterações na raiz do drive
Seção intitulada “Listar alterações na raiz do drive”ONE_DRIVE_LIST_ROOT_DRIVE_CHANGES
Lista alterações na raiz do drive principal do usuário usando um token delta. Use quando precisar rastrear modificações, adições ou exclusões de arquivos e pastas no diretório principal do OneDrive. A primeira chamada sem token retorna todos os itens atuais mais um @odata.deltaLink; armazene esse token e passe-o em chamadas subsequentes para recuperar apenas alterações incrementais.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
top | integer | Não | Número máximo de itens a retornar em uma única resposta. |
token | string | Não | String de token bruto, URL completa de @odata.nextLink/@odata.deltaLink, ou ‘latest’ para obter um token para chamadas futuras. Omita para obter todos os itens atuais. |
expand | string | Não | Lista separada por vírgulas de relacionamentos a expandir. |
select | string | Não | Lista separada por vírgulas de propriedades do DriveItem a incluir. |
drive_id | string | Não | ID do drive para rastrear alterações. Obrigatório para autenticação de aplicativo. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar permissões de compartilhamento
Seção intitulada “Listar permissões de compartilhamento”ONE_DRIVE_LIST_SHARE_PERMISSIONS
Recupera detalhes de permissão para um item compartilhado do OneDrive ou SharePoint usando um ID de compartilhamento. Use quando tiver uma URL de compartilhamento codificada e precisar verificar o nível de permissão e os detalhes de acesso.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
shared_drive_item_id | string | Sim | ID de compartilhamento (URL de compartilhamento codificada no formato u!<base64url> ou token de compartilhamento) para recuperar a permissão. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar alterações delta de itens de lista do SharePoint
Seção intitulada “Listar alterações delta de itens de lista do SharePoint”ONE_DRIVE_LIST_SHAREPOINT_LIST_ITEMS_DELTA
Rastreia alterações nos itens de uma lista do SharePoint usando uma consulta delta. Use quando precisar obter itens de lista recém-criados, atualizados ou excluídos sem realizar uma leitura completa de toda a coleção de itens.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
top | integer | Não | Número máximo de itens a retornar em uma única resposta. |
token | string | Não | Se não especificado, enumera o estado atual. Se ‘latest’, retorna uma resposta vazia com o último token delta. |
expand | string | Não | Lista separada por vírgulas de relacionamentos a expandir. |
select | string | Não | Lista separada por vírgulas de propriedades do listItem a retornar. |
list_id | string | Sim | Identificador único da lista dentro do site. |
site_id | string | Sim | ID do site do SharePoint no formato composto: hostname,guid-da-coleção-de-sites,guid-do-site. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar colunas do site
Seção intitulada “Listar colunas do site”ONE_DRIVE_LIST_SITE_COLUMNS
Lista todas as definições de coluna de um site do SharePoint. Use quando precisar recuperar o esquema ou a estrutura de colunas dentro de um site específico do SharePoint.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
top | integer | Não | Número máximo de itens a retornar. |
skip | integer | Não | Número de itens a pular no conjunto de resultados. |
count | boolean | Não | Se verdadeiro, retorna a contagem total de itens. |
expand | string | Não | Lista separada por vírgulas de recursos relacionados a expandir. |
filter | string | Não | Expressão de filtro OData a aplicar. |
select | string | Não | Lista separada por vírgulas de propriedades a incluir. |
orderby | string | Não | Lista separada por vírgulas de propriedades para ordenar. |
site_id | string | Sim | Identificador único do site do SharePoint. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar alterações delta de itens do site
Seção intitulada “Listar alterações delta de itens do site”ONE_DRIVE_LIST_SITE_ITEMS_DELTA
Rastreia alterações nos DriveItems da biblioteca de documentos padrão de um site do SharePoint. Use quando precisar obter itens adicionados, modificados ou excluídos desde um estado anterior.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
top | integer | Não | Número máximo de itens a retornar em uma única resposta. |
token | string | Não | Token para recuperar uma página específica de resultados ou obter alterações desde um estado anterior. Pode ser ‘latest’, uma URL deltaLink ou um timestamp (YYYY-MM-DDTHH:MM:SSZ). |
expand | string | Não | Lista separada por vírgulas de relacionamentos a expandir. |
select | string | Não | Lista separada por vírgulas de propriedades do DriveItem a incluir. |
site_id | string | Sim | Identificador único do site do SharePoint. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar listas do site
Seção intitulada “Listar listas do site”ONE_DRIVE_LIST_SITE_LISTS
Lista todas as listas em um site específico do SharePoint. Retorna apenas listas suportadas pelo Microsoft Graph — listas internas/de sistema são excluídas. Funciona apenas com contas organizacionais Microsoft 365 (Azure AD/Entra ID). Não é suportado para contas pessoais da Microsoft.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
top | integer | Não | Número máximo de itens a retornar. |
expand | string | Não | Lista separada por vírgulas de relacionamentos a expandir. Ex.: columns,items |
filter | string | Não | Expressão de filtro OData. Ex.: startswith(name,‘Doc’) |
select | string | Não | Lista separada por vírgulas de propriedades a incluir. Ex.: id,name,list |
orderby | string | Não | Expressão de ordenação OData. Ex.: name asc |
site_id | string | Sim | ID do site do SharePoint no formato composto obrigatório: ‘hostname,id-da-coleção-de-sites,id-da-web’. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar subsites do site
Seção intitulada “Listar subsites do site”ONE_DRIVE_LIST_SITE_SUBSITES
Lista todos os subsites de um site do SharePoint. Funciona apenas com contas organizacionais Microsoft 365 (Azure AD/Entra ID). Um array value vazio na resposta significa que o site não tem subsites, não uma falha.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
top | integer | Não | Número máximo de itens a retornar. |
expand | string | Não | Lista separada por vírgulas de relacionamentos a expandir. |
filter | string | Não | Expressão de filtro OData. Ex.: startswith(name,‘Project’) |
select | string | Não | Lista separada por vírgulas de propriedades a incluir. Ex.: id,name,webUrl |
orderby | string | Não | Expressão de ordenação OData. |
site_id | string | Sim | Identificador único do site do SharePoint pai. Deve estar no formato composto completo do Graph: hostname,siteCollectionId,siteId. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar assinaturas
Seção intitulada “Listar assinaturas”ONE_DRIVE_LIST_SUBSCRIPTIONS
Lista as assinaturas atuais para o usuário ou app autenticado. Use para recuperar detalhes de assinaturas de webhook existentes.
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar planilhas da pasta de trabalho Excel
Seção intitulada “Listar planilhas da pasta de trabalho Excel”ONE_DRIVE_LIST_WORKBOOK_WORKSHEETS
Recupera uma lista de todas as planilhas de uma pasta de trabalho Excel armazenada no OneDrive ou SharePoint. Retorna metadados da planilha incluindo IDs, nomes, posições e estados de visibilidade.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
top | integer | Não | Número máximo opcional de planilhas a retornar. |
skip | integer | Não | Número de planilhas a pular antes de retornar os resultados. |
select | string | Não | Lista separada por vírgulas de campos específicos a retornar. |
item_id | string | Sim | Identificador único do item da pasta de trabalho (arquivo Excel). |
drive_id | string | Sim | Identificador único do drive do OneDrive ou SharePoint que contém a pasta de trabalho. |
session_id | string | Não | ID de sessão opcional da pasta de trabalho. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Mover item
Seção intitulada “Mover item”ONE_DRIVE_MOVE_ITEM
Move um arquivo ou pasta para uma nova pasta pai no OneDrive. Use quando precisar reorganizar arquivos ou pastas alterando sua localização. Você pode opcionalmente renomear o item durante a movimentação. Se já existir um arquivo com o mesmo nome no destino, a API retorna nameAlreadyExists.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Não | Novo nome para o DriveItem. Se não fornecido, o item mantém o nome original. |
itemId | string | Sim | Identificador único do arquivo ou pasta (DriveItem) a ser movido. |
siteId | string | Não | Identificador único do site se o item estiver em um site do SharePoint. |
userId | string | Não | Identificador único do usuário se acessando o drive de outro usuário. |
driveId | string | Não | Identificador único do Drive que contém o item. Se não especificado, usa o drive pessoal do usuário (/me/drive). |
groupId | string | Não | Identificador único do grupo se o item estiver em um drive de grupo. |
description | string | Não | Nova descrição para o item do drive. |
parentReference | object | Sim | Objeto especificando a pasta de destino. Deve ter um campo ‘id’ com o identificador único da pasta. Formato: {"id": "<folder-id>", "driveId": "<drive-id>"} (driveId é opcional). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar pasta
Seção intitulada “Criar pasta”ONE_DRIVE_ONEDRIVE_CREATE_FOLDER
Cria uma nova pasta no OneDrive do usuário com comportamento de conflito configurável, opcionalmente dentro de uma pasta pai especificada (por ID ou caminho completo a partir da raiz) que, se não for a raiz, deve existir e ser acessível.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome desejado para a nova pasta. Se já existir uma pasta com este nome, a nova pasta será renomeada automaticamente. |
user_id | string | Não | ID, e-mail ou ‘me’ do usuário. Padrão: ‘me’. Obrigatório para autenticação S2S. |
description | string | Não | Descrição opcional para a pasta. |
parent_folder | string | Não | ID ou caminho completo da pasta pai para a nova pasta. Os caminhos devem começar a partir da raiz (ex.: ‘/Documents/Reports’). |
conflict_behavior | string | Não | Como o Microsoft Graph deve lidar com conflito de nome de pasta. Use ‘fail’ para retornar um erro, ‘rename’ para criar uma pasta com nome único, ou ‘replace’ para substituir o item existente. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar arquivo de texto
Seção intitulada “Criar arquivo de texto”ONE_DRIVE_ONEDRIVE_CREATE_TEXT_FILE
Cria um novo arquivo de texto simples com conteúdo especificado no OneDrive pessoal do usuário autenticado. Todos os arquivos são escritos como texto simples independentemente da extensão — especificar .docx ou .xlsx não produz um documento Office real. Esta ação funciona apenas com o OneDrive pessoal do usuário (/me/drive) e não suporta bibliotecas de documentos do SharePoint.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome desejado para o novo arquivo de texto, incluindo a extensão (ex.: ‘report.txt’, ‘notes.log’). |
folder | string | Não | Pasta no OneDrive pessoal do usuário onde o arquivo será criado. Use ’/’ para a raiz, um caminho como ‘/Documents/Projects’, ou um ID de pasta válido. |
content | string | Sim | Conteúdo de texto simples a ser gravado no novo arquivo. |
user_id | string | Não | ID do usuário ou o literal ‘me’ para representar o usuário autenticado. |
conflict_behavior | string | Não | Como lidar com conflitos quando já existe um arquivo com o mesmo nome. ‘fail’ (padrão) retorna um erro, ‘replace’ substitui, ‘rename’ cria com nome incrementado. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Encontrar item
Seção intitulada “Encontrar item”ONE_DRIVE_ONEDRIVE_FIND_FILE
Encontra um item (arquivo ou pasta) de forma não recursiva em uma pasta especificada do OneDrive. Para buscas onde a subpasta é desconhecida, use ONE_DRIVE_SEARCH_ITEMS.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome exato do arquivo ou pasta a encontrar dentro da pasta especificada. |
folder | string | Não | Identificador único (ID) ou caminho absoluto da pasta do OneDrive para a busca. Para a pasta raiz, use ’/’. |
user_id | string | Não | Identificador único do usuário ou o alias ‘me’ para representar o usuário autenticado. |
response_detail | string | Não | Nível de detalhe na resposta. ‘minimal’ (padrão) retorna apenas propriedades essenciais. ‘full’ retorna metadados completos. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Encontrar pasta
Seção intitulada “Encontrar pasta”ONE_DRIVE_ONEDRIVE_FIND_FOLDER
Encontra pastas pelo nome dentro de uma pasta pai acessível no OneDrive, ou lista todas as subpastas diretas se nenhum nome for especificado. A busca é não recursiva: apenas os filhos imediatos da pasta são verificados.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
top | integer | Não | Número máximo de itens a retornar em uma única solicitação. |
name | string | Não | Nome exato da pasta a encontrar. Se omitido, todas as subpastas diretas da pasta pai são retornadas. |
expand | string | Não | Lista separada por vírgulas de relacionamentos a expandir. |
folder | string | Não | Caminho (ex.: ‘/My Files/Work’, ’/’ para raiz) ou ID único da pasta pai onde as subpastas são pesquisadas. |
select | array | Não | Lista de propriedades a incluir na resposta. |
orderby | string | Não | Ordenar resultados por propriedades especificadas. |
user_id | string | Não | Identificador único do usuário ou ‘me’ para o usuário autenticado. |
skip_token | string | Não | Valor $skipToken de uma resposta anterior para continuação de paginação. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar itens do OneDrive
Seção intitulada “Listar itens do OneDrive”ONE_DRIVE_ONEDRIVE_LIST_ITEMS
Recupera todos os arquivos e pastas como recursos driveItem da raiz do OneDrive de um usuário especificado, tratando a paginação automaticamente. Não recursivo: retorna apenas itens de nível raiz; conteúdo de subpastas requer chamadas separadas.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
top | integer | Não | Número máximo de itens por solicitação de API. A ação trata a paginação automaticamente. |
select | array | Não | Propriedades driveItem a retornar. |
user_id | string | Não | Identificador único do usuário ou ‘me’ para o OneDrive do usuário autenticado. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Enviar arquivo
Seção intitulada “Enviar arquivo”ONE_DRIVE_ONEDRIVE_UPLOAD_FILE
Envia um arquivo para uma pasta especificada do OneDrive, criando automaticamente a pasta de destino se ela não existir, renomeando em caso de conflito e suportando arquivos grandes via chunking.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
file | object | Sim | O arquivo a ser enviado, incluindo seu nome e acesso ao conteúdo binário. |
folder | string | Não | Caminho da pasta de destino a partir da raiz (ex.: ‘/Documents/Reports’) ou ID único de pasta. Se o caminho não existir, será criado automaticamente. |
site_id | string | Não | Identificador único do site do SharePoint para onde enviar. Mutuamente exclusivo com drive_id. |
user_id | string | Não | ID do usuário ou ‘me’ para o usuário autenticado, determinando o OneDrive de destino. |
drive_id | string | Não | Identificador único do drive para enviar. Mutuamente exclusivo com site_id. |
description | string | Não | Descrição visível ao usuário do arquivo. Suportado apenas no OneDrive Personal. |
defer_commit | boolean | Não | Se verdadeiro, a criação final do arquivo é adiada até que uma solicitação de conclusão explícita seja feita. |
if_match_etag | string | Não | Valor de ETag para evitar atualizações perdidas. |
file_system_info | object | Não | Informações do sistema de arquivos no cliente. |
conflict_behavior | string | Não | Como lidar com conflitos de nome de arquivo. ‘rename’ (padrão) renomeia automaticamente, ‘fail’ retorna um erro, ‘replace’ substitui o arquivo existente. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Pré-visualizar item do drive
Seção intitulada “Pré-visualizar item do drive”ONE_DRIVE_PREVIEW_DRIVE_ITEM
Gera ou recupera uma URL incorporável de curta duração vinculada a permissões para pré-visualização de um item específico. As URLs expiram e devem ser regeneradas por sessão — não armazene em cache. Use quando precisar exibir uma pré-visualização temporária de um arquivo.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
page | string | Não | Número de página do documento para iniciar, se aplicável. |
zoom | number | Não | Nível de zoom para iniciar, se aplicável. |
item_id | string | Sim | Identificador único do DriveItem. |
site_id | string | Não | Identificador único do Site. Use se o item estiver em um site do SharePoint. |
user_id | string | Não | Identificador único do Usuário. Use se o item estiver no drive de outro usuário. |
drive_id | string | Não | Identificador único do Drive. Se não fornecido, usa o drive do usuário atual. |
group_id | string | Não | Identificador único do Grupo. Use se o item estiver no drive de um grupo. |
share_id | string | Não | Identificador único do item compartilhado. Use se o item for acessado via link de compartilhamento. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Ler intervalo da planilha Excel
Seção intitulada “Ler intervalo da planilha Excel”ONE_DRIVE_READ_WORKBOOK_RANGE
Lê um intervalo de células de uma planilha de pasta de trabalho Excel armazenada no OneDrive ou SharePoint. Retorna valores, fórmulas, formatação e metadados das células para o intervalo especificado. Use quando precisar extrair dados de células específicas em um arquivo Excel.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
address | string | Sim | Endereço do intervalo em notação A1. Suporta células únicas (ex.: ‘A1’), intervalos de células (ex.: ‘A1:B5’), colunas inteiras (ex.: ‘A:A’) ou linhas inteiras (ex.: ‘1:1’). |
item_id | string | Sim | Identificador único do item da pasta de trabalho (arquivo Excel). |
drive_id | string | Sim | Identificador único do drive que contém a pasta de trabalho. |
session_id | string | Não | ID de sessão opcional da pasta de trabalho. |
select_fields | array | Não | Lista opcional de campos específicos a retornar. |
worksheet_id_or_name | string | Sim | ID ou nome da planilha. Nomes não ASCII são codificados automaticamente. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Restaurar item excluído
Seção intitulada “Restaurar item excluído”ONE_DRIVE_RESTORE_DRIVE_ITEM
Restaura um driveItem excluído do OneDrive (arquivo ou pasta) da lixeira. Permite recuperar um item para sua localização original ou para uma pasta pai especificada, com renomeação opcional durante a restauração. IMPORTANTE: Esta API está disponível APENAS para contas OneDrive Personal. NÃO funciona com OneDrive for Business ou SharePoint.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Não | Novo nome para o item restaurado. Se não fornecido, o item é restaurado com o nome original. |
item_id | string | Sim | Identificador único do DriveItem excluído (arquivo ou pasta) a restaurar. Este item deve estar atualmente na lixeira do OneDrive. |
drive_id | string | Não | Identificador único do Drive que contém o item excluído. Obrigatório ao usar autenticação de aplicativo. |
parent_reference_id | string | Não | Identificador único da pasta pai onde o item deve ser restaurado. Se não fornecido, o item é restaurado para o local pai original. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Pesquisar itens
Seção intitulada “Pesquisar itens”ONE_DRIVE_SEARCH_ITEMS
Pesquisa arquivos e pastas no OneDrive por palavra-chave. Pesquisa nomes de arquivo, metadados e conteúdo de arquivo para encontrar itens correspondentes. Suporta filtragem, classificação e paginação. Arquivos recém-criados ou movidos podem não aparecer devido a atrasos de indexação.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
q | string | Sim | Texto de consulta para pesquisar itens. Os valores são combinados com nomes de arquivo, metadados e conteúdo do arquivo. Apenas busca simples por palavra-chave — operadores KQL NÃO são suportados por este endpoint. Caracteres curinga (* e ?) NÃO são suportados. |
top | integer | Não | Número máximo de itens a retornar em uma única página. Padrão: 200. |
expand | string | Não | Lista separada por vírgulas de nomes de relacionamento a expandir. |
select | string | Não | Lista separada por vírgulas de propriedades do driveItem a incluir na resposta. |
orderby | string | Não | Lista separada por vírgulas de propriedades para ordenar os resultados. |
drive_id | string | Não | ID do drive no qual pesquisar. Se não fornecido, pesquisa o drive pessoal do usuário (me/drive). |
skip_token | string | Não | Token para recuperar a próxima página de resultados. |
search_scope | string | Não | Escopo da pesquisa. ‘root’ pesquisa dentro da hierarquia de pastas a partir da raiz. ‘drive’ amplia a pesquisa para incluir itens compartilhados com o usuário. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Deixar de seguir item do drive
Seção intitulada “Deixar de seguir item do drive”ONE_DRIVE_UNFOLLOW_ITEM
Deixa de seguir um driveItem removendo-o da coleção de itens seguidos do usuário. Use quando precisar parar de acompanhar um arquivo ou pasta que foi marcado anteriormente para seguir.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | Identificador único do driveItem para deixar de seguir. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar metadados de item do drive
Seção intitulada “Atualizar metadados de item do drive”ONE_DRIVE_UPDATE_DRIVE_ITEM_METADATA
Atualiza os metadados de um item específico (arquivo ou pasta) no OneDrive. Use para renomear itens, alterar descrições ou mover itens para uma nova pasta pai.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Não | Novo nome para o item do drive. Não deve conter caracteres ilegais. |
item_id | string | Sim | Identificador único do item do drive (arquivo ou pasta) a atualizar. |
site_id | string | Não | Identificador único do site. Usado ao atualizar um item dentro do drive de um site. |
user_id | string | Não | Identificador único do usuário. Usado ao atualizar um item dentro do drive de um usuário específico. |
drive_id | string | Não | Identificador único do drive. |
group_id | string | Não | Identificador único do grupo. Usado ao atualizar um item dentro do drive de um grupo. |
if_match | string | Não | Valor de eTag ou cTag para atualização condicional. |
description | string | Não | Nova descrição para o item do drive. |
file_system_info | object | Não | Informações do sistema de arquivos no cliente. |
parent_reference_id | string | Não | ID do novo item pai. Use para mover o item. |
parent_reference_drive_id | string | Não | ID do drive do novo item pai, se movendo para um drive diferente. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar permissões de item do drive
Seção intitulada “Atualizar permissões de item do drive”ONE_DRIVE_UPDATE_DRIVE_ITEMS_PERMISSIONS
Atualiza as funções de uma permissão existente em um item do drive OneDrive. Use quando precisar alterar o nível de acesso (read, write, owner) para uma permissão específica em um arquivo ou pasta.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
roles | array | Sim | Array de strings de função do Microsoft Graph a atribuir à permissão. Valores comuns: read, write, owner. |
item_id | string | Sim | Identificador único do item do drive. |
site_id | string | Não | Identificador único de um site do SharePoint. |
user_id | string | Não | Identificador único de um usuário. |
drive_id | string | Não | Identificador único do drive. |
group_id | string | Não | Identificador único de um grupo. |
permission_id | string | Sim | Identificador único da permissão a atualizar. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar conteúdo de arquivo
Seção intitulada “Atualizar conteúdo de arquivo”ONE_DRIVE_UPDATE_FILE_CONTENT
Atualiza o conteúdo de um arquivo existente no OneDrive. Quando chamado sem o parâmetro file, cria uma sessão de upload e retorna sua uploadUrl. Quando chamado com um file, transmite os bytes do arquivo em chunks e retorna o DriveItem atualizado. O ID do item é preservado (links de compartilhamento existentes permanecem válidos), a menos que conflict_behavior=rename faça o servidor criar um novo item.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
file | object | Não | Conteúdo do arquivo opcional para upload. Quando fornecido, cria uma sessão de upload e transmite os bytes. Quando omitido, cria apenas a sessão de upload e retorna sua uploadUrl. |
item_id | string | Sim | Identificador único do DriveItem (arquivo) a atualizar. |
site_id | string | Não | Identificador único do site do SharePoint. Mutuamente exclusivo com drive_id, group_id e user_id. |
user_id | string | Não | Identificador único do usuário. Mutuamente exclusivo com drive_id, site_id e group_id. |
drive_id | string | Não | Identificador único do drive. Se não fornecido, usa /me/drive. |
group_id | string | Não | Identificador único do grupo. Mutuamente exclusivo com drive_id, site_id e user_id. |
defer_commit | boolean | Não | Se verdadeiro, a criação final do arquivo é adiada. |
media_source | object | Não | Informações da fonte de mídia. Apenas no OneDrive for Business e SharePoint. |
if_match_etag | string | Não | Valor de ETag para evitar atualizações perdidas. |
file_system_info | object | Não | Informações do sistema de arquivos no cliente. |
conflict_behavior | string | Não | Como lidar com conflitos. ‘replace’ (padrão), ‘fail’ ou ‘rename’. |
drive_item_source | object | Não | Informações sobre a fonte do item do drive. |
if_none_match_etag | string | Não | Valor de ETag para evitar atualizações se o item já existir. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar intervalo da planilha Excel
Seção intitulada “Atualizar intervalo da planilha Excel”ONE_DRIVE_UPDATE_WORKBOOK_RANGE
Atualiza um intervalo em uma planilha de pasta de trabalho usando a Microsoft Graph API. Use quando precisar gravar dados, fórmulas ou formatos de número em células específicas de uma pasta de trabalho Excel armazenada no OneDrive ou SharePoint.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
values | array | Não | Array 2D opcional contendo valores a gravar no intervalo. Pelo menos um dos três (values, formulas ou number_format) deve ser fornecido. |
address | string | Sim | Endereço do intervalo em notação A1. |
item_id | string | Sim | ID do item da pasta de trabalho. |
drive_id | string | Sim | ID do drive que contém a pasta de trabalho. |
formulas | array | Não | Array 2D opcional contendo fórmulas a definir. Se fornecido, tem precedência sobre values. |
session_id | string | Não | ID de sessão opcional da pasta de trabalho. |
number_format | array | Não | Array 2D opcional contendo strings de formato de número. |
worksheet_id_or_name | string | Sim | ID ou nome da planilha. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar planilha Excel
Seção intitulada “Atualizar planilha Excel”ONE_DRIVE_UPDATE_WORKBOOK_WORKSHEET
Atualiza propriedades de uma planilha em uma pasta de trabalho Excel armazenada no OneDrive. Use quando precisar renomear uma planilha, alterar sua posição (ordem das abas) ou modificar seu estado de visibilidade. Pelo menos um dos três (name, position ou visibility) deve ser fornecido.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Não | Novo nome de exibição para a planilha. |
item_id | string | Sim | ID do item da pasta de trabalho (arquivo Excel) que contém a planilha. |
drive_id | string | Sim | ID do drive que contém a pasta de trabalho. |
position | integer | Não | Nova posição de base zero da planilha na pasta de trabalho. |
session_id | string | Não | ID de sessão opcional da pasta de trabalho. |
visibility | string | Não | Estado de visibilidade da planilha. Valores: Visible, Hidden, VeryHidden. |
worksheet_id_or_name | string | Sim | ID ou nome da planilha a atualizar. Será codificado automaticamente. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Escrever célula da planilha Excel
Seção intitulada “Escrever célula da planilha Excel”ONE_DRIVE_WRITE_WORKBOOK_CELL
Atualiza o valor, fórmula ou formato de uma célula específica em uma pasta de trabalho Excel armazenada no OneDrive. Os parâmetros de linha e coluna são indexados a partir de zero (linha 0 é a primeira linha, coluna 0 é a coluna A).
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
row | integer | Sim | Número da linha da célula (indexado a partir de zero). A linha 0 é a primeira linha da planilha. |
column | integer | Sim | Número da coluna da célula (indexado a partir de zero). A coluna 0 é a primeira coluna (A). |
values | array | Não | Array 2D opcional contendo o valor a gravar na célula. Deve ser um array de célula única como [['novo valor']]. |
item_id | string | Sim | ID do item da pasta de trabalho (arquivo Excel) no OneDrive. |
drive_id | string | Sim | ID do drive que contém a pasta de trabalho. |
formulas | array | Não | Array 2D opcional contendo uma fórmula a definir na célula. Se fornecido, tem precedência sobre values. |
session_id | string | Não | ID de sessão opcional da pasta de trabalho. |
number_format | array | Não | Array 2D opcional contendo a string de formato de número para a célula. |
worksheet_id_or_name | string | Sim | ID ou nome da planilha onde a célula está localizada. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |