Referência SharePoint (pré-visualização)

Overview

Ferramentas disponíveis

findSite

Encontra sites do SharePoint a que podes aceder. Devolve sites específicos que correspondem a uma consulta de pesquisa, ou os 20 sites mais relevantes se não fornecer uma consulta.

Parâmetros opcionais:

• searchQuery: Consulta de pesquisa (nome completo ou parcial do site). Omitir o retorno dos 20 sites mais acessíveis.

getSiteByPath

Resolve um site SharePoint usando o seu nome de host exato e o caminho relativo ao servidor. Use este método apenas quando tiver a estrutura completa do URL do site. Usa findSite quando só conheces o nome do site.

Parâmetros necessários:

• Nome do Anfitrião: Nome de anfitrião exato (por exemplo, 'contoso.sharepoint.com')
• serverRelativePath: Caminho relativo ao servidor (por exemplo, 'sites/Marketing'). A barra inicial é opcional.

ListaSubsites

Lista todos os subsites (sites filhos) de um site SharePoint.

Parâmetros necessários:

• siteId: ID do site SharePoint-mãe (formato: 'hostname,siteCollectionId,webId')

listarBibliotecasDeDocumentosNoSite

Lista bibliotecas de documentos (discos) no site SharePoint especificado.

Parâmetros opcionais:

• siteId: ID do site SharePoint (por defeito: 'root')

getDefaultDocumentLibraryInSite

Obtém a biblioteca de documentos predefinida (drive) num site do SharePoint.

Parâmetros opcionais:

• siteId: ID do site SharePoint (por defeito: 'root')

getFolderChildren

Enumera os 20 principais ficheiros e pastas (DriveItems) contidos numa pasta pai especificada numa biblioteca de documentos (drive).

Parâmetros necessários:

• documentLibraryId: ID da biblioteca de documentos (drive)

Parâmetros opcionais:

• parentFolderId: ID da pasta pai (por defeito: 'root').

EncontrarFicheiroOuPasta

Encontra um ficheiro ou pasta (DriveItem) acessível ao utilizador através de uma consulta de pesquisa. Pesquisas em todos os sites e bibliotecas de documentos a que o utilizador tem acesso.

Parâmetros necessários:

• searchQuery: Termo de pesquisa (nome de ficheiro completo ou parcial)

getFileOrFolderMetadata

Obtém metadados de um ficheiro ou pasta (DriveItem) de uma biblioteca de documentos especificada (drive) no SharePoint.

Parâmetros necessários:

• fileOrFolderId: ID do ficheiro ou pasta (DriveItem)
• documentLibraryId: ID da biblioteca de documentos (drive)

getFileOrFolderMetadataByUrl (obter metadados de arquivo ou pasta pelo URL)

Obtém metadados de um ficheiro ou pasta (DriveItem) a partir de uma URL de partilha. Apenas utilizadores com permissões explícitas existentes para aceder ao ficheiro podem obter os metadados.

Parâmetros necessários:

• fileOrFolderUrl: URL do ficheiro ou pasta. O URL não é utilizado para o partilhar com o utilizador; este já deve ter acesso explícito.

readSmallTextFile

Lê (descarrega) um ficheiro de texto com menos de 5 MB de uma biblioteca de documentos específica (drive).

Parâmetros necessários:

• fileId: ID do ficheiro (DriveItem) para ler ou descarregar
• documentLibraryId: ID da biblioteca de documentos (drive)

readSmallBinaryFile

Lê um ficheiro binário menor que 5 MB de uma biblioteca de documentos específica (drive). O conteúdo do arquivo é retornado como uma cadeia de caracteres codificada em base64.

Parâmetros necessários:

• fileId: ID do ficheiro (DriveItem) para ler ou descarregar
• documentLibraryId: ID da biblioteca de documentos (drive)

createSmallTextFile

Cria ou carrega um ficheiro de texto com menos de 5 MB para uma biblioteca de documentos específica (drive).

Parâmetros necessários:

• nome do ficheiro: Nome do ficheiro incluindo extensão.
• TextoConteúdo: Conteúdo textual do ficheiro.
• documentLibraryId: ID da biblioteca de documentos (drive)

Parâmetros opcionais:

• parentFolderId: ID da pasta pai (por defeito: 'root').

createSmallBinaryFile

Cria um ficheiro binário menor que 5 MB ao codificar o seu conteúdo em base64 para uma biblioteca de documentos específica (drive).

Parâmetros necessários:

• nome do ficheiro: Nome do ficheiro incluindo extensão.
• base64Conteúdo: Conteúdo binário codificado como uma string base64.
• documentLibraryId: ID da biblioteca de documentos (drive)

Parâmetros opcionais:

• parentFolderId: ID da pasta pai (por defeito: 'root').

createFolder

Cria uma nova pasta (DriveItem) dentro de uma biblioteca de documentos especificada (drive). Se existir uma pasta com o mesmo nome, o sistema adiciona um sufixo numérico (por exemplo, NewFolder (1)).

Parâmetros necessários:

• folderName: Nome da pasta
• documentLibraryId: ID da biblioteca de documentos (drive)

Parâmetros opcionais:

• parentFolderId: ID da pasta pai (por defeito: 'root').

renomearFicheiroOuPasta

Renomeia um ficheiro ou pasta (DriveItem) dentro de uma biblioteca de documentos especificada (drive). O novo nome deve cumprir as convenções de nomeação.

Parâmetros necessários:

• documentLibraryId: ID da biblioteca de documentos (drive)
• fileOrFolderId: ID do ficheiro ou pasta a renomear
• NewFileOrFolderName: O novo nome

Parâmetros opcionais:

• Etag: ETag para controlo de concorrência

eliminarFicheiroOuPasta (deleteFileOrFolder)

Apaga um ficheiro ou pasta (DriveItem) de uma biblioteca de documentos especificada (drive).

Parâmetros necessários:

• documentLibraryId: ID da biblioteca de documentos (drive)
• fileOrFolderId: ID do ficheiro ou pasta a eliminar

Parâmetros opcionais:

• Etag: ETag para controlo de concorrência

moveFileOrFolder

Move um ficheiro ou pasta (DriveItem) para uma pasta de destino. Suporta a movimentação entre diferentes bibliotecas de documentos (drives) dentro do SharePoint. Esta operação é assíncrona. Usa checkOperationStatus para monitorizar o progresso.

Parâmetros necessários:

• sourcedoclibid: ID da biblioteca de documentos de origem (drive)
• sourcefileid: ID do ficheiro ou pasta de origem a mover
• Destdoclibid: ID da biblioteca de documentos de destino (disco)
• destfolderid: ID da pasta de destino (deve existir)

Parâmetros opcionais:

• NewFilename: Novo nome para o objeto mudado

copiarFicheiroOuPasta

Copia um ficheiro ou pasta (DriveItem) para uma pasta de destino. Suporta a cópia entre diferentes bibliotecas de documentos dentro do SharePoint. Esta operação é assíncrona. Usa checkOperationStatus para monitorizar o progresso.

Parâmetros necessários:

• sourcedoclibid: ID da biblioteca de documentos de origem (drive)
• sourcefileid: ID do ficheiro ou pasta de origem para copiar
• Destdoclibid: ID da biblioteca de documentos de destino (disco)
• destfolderid: ID da pasta de destino (deve existir)

Parâmetros opcionais:

• NewFilename: Novo nome para o item copiado

verificarEstadoDaOperação

Verifica o estado de uma operação assíncrona, como uma cópia ou movimento, usando o token de operação devolvido da operação original.

Parâmetros necessários:

• operationToken: O token de operação devolvido de uma operação assíncrona como copyFileOrFolder ou moveFileOrFolder

uploadFileFromUrl

Carrega um ficheiro de um URL do SharePoint ou OneDrive para uma pasta de destino numa biblioteca de documentos (drive). O ficheiro é copiado do URL de origem, por isso o ficheiro original não é alterado.

Parâmetros necessários:

• sourceUrl: URL de origem (deve ser um URL válido de SharePoint ou OneDrive)
• destinationDocumentLibraryId: ID da biblioteca de documentos de destino. Utilize me para o OneDrive do utilizador

Parâmetros opcionais:

• destinationFolderId: ID da pasta de destino (por defeito: root)
• nome do ficheiro: Novo nome do ficheiro; por predefinição, é o nome original do ficheiro

compartilharArquivoOuPasta

Envia um convite de partilha para conceder permissões de leitura ou escrita num ficheiro ou pasta (DriveItem) dentro de uma biblioteca de documentos especificada (drive).

Parâmetros necessários:

• documentLibraryId: ID da biblioteca de documentos (drive)
• fileOrFolderId: ID do ficheiro ou pasta a partilhar
• E-mails do destinatário: Conjunto de endereços de email dos destinatários
• funções: Lista de funções: 'read', 'write' ('write' concede permissões de leitura e escrita)

Parâmetros opcionais:

• Mensagem: Mensagem personalizada para o email de convite (padrão: Aqui está o ficheiro em que estamos a colaborar.)
• enviarConvite: Indica se deve enviar um convite para partilha (por defeito: true)

definirEtiquetaDeSensibilidadeNoArquivo

Define o rótulo de sensibilidade de um ficheiro a partir da biblioteca de documentos (drive) especificada.

Parâmetros necessários:

• documentLibraryId: ID da biblioteca de documentos (drive)
• fileId: ID do ficheiro (DriveItem)
• sensitivityLabelId: ID da etiqueta de sensibilidade, ou string vazia para a remover

Parâmetros opcionais:

• assignmentMethod: Método de atribuição: 'standard', 'privileged', 'auto' ou 'unknownFutureValue' (por defeito: 'privileged')
• justificationText: Texto de justificação para efeitos de auditoria; necessário ao reduzir ou remover uma etiqueta (por defeito: 'Modificado por MCPServer')

listaListas

Disponibiliza todas as listas do SharePoint num site específico. Use para descobrir que listas existem num site.

Parâmetros necessários:

• siteId: ID do site SharePoint (formato: 'hostname,siteCollectionId,webId')

createList

Cria uma nova lista do SharePoint num site.

Parâmetros necessários:

• siteId: ID do site do SharePoint
• displayName: Nome de exibição da nova lista

Parâmetros opcionais:

• colunas: Coleção de colunas sob a forma de pares chave-valor: [{ Key: 'JobTitle', Value: 'text' }]. Tipos válidos: texto, texto multilinha, número, booleano, data e hora, escolha, pesquisa, pessoa ou grupo, hiperligações, moeda, calculado
• Template: Tipo de modelo de lista (por defeito: 'genericList'). Opções: genericList, documentLibrary, eventos, tarefas, anúncios, contactos, links, inquérito, issueTracking, fórum de discussão

eliminarLista

Apaga uma lista do SharePoint list de um site. Apaga todo o contentor da lista e todos os itens dentro dele. Esta ação não pode ser desfeita.

Parâmetros necessários:

• siteId: ID do site do SharePoint
• listId: ID da lista a eliminar

Parâmetros opcionais:

• Etag: ETag para controlo de concorrência

enviarConviteParaLista

Envia um convite de partilha para conceder permissões numa lista do SharePoint.

Parâmetros necessários:

• listId: ID do SharePoint list a partilhar
• E-mails do destinatário: Conjunto de endereços de email dos destinatários
• Função: Função: 'ler' (apenas visualizar), 'contribuir' (ver, adicionar, atualizar, eliminar itens), 'editar' (edição completa incluindo estrutura da lista)

Parâmetros opcionais:

• siteUrl: URL do site SharePoint que contém a lista
• enviarEmail: Se deve enviar uma notificação por email (predefinido: verdadeiro)

listaListaItens

Obtém itens (linhas/registos) de uma lista específica do SharePoint.

Parâmetros necessários:

• siteId: ID do site do SharePoint
• listId: ID da lista do SharePoint

getListItem

Obtém um único item (linha ou registo) de uma lista do SharePoint pelo respetivo ID.

Parâmetros necessários:

• siteId: ID do site do SharePoint
• listId: ID da lista do SharePoint
• itemId: ID do item específico da lista

createListItem

Cria um novo item (linha ou registo) numa lista do SharePoint.

Parâmetros necessários:

• siteId: ID do site do SharePoint
• listId: ID da lista do SharePoint
• Campos: Pares-chave-valor para valores de campo, como [{ Key: 'Title', Value: 'Software Engineer' }, { Key: 'Department', Value: 'Engineering' }]. O campo 'Título' é normalmente obrigatório.

atualizarItemLista

Atualiza um item existente (linha ou registo) numa lista do SharePoint. Apenas campos especificados são atualizados; os campos omitidos mantêm os seus valores.

Parâmetros necessários:

• siteId: ID do site do SharePoint
• listId: ID da lista do SharePoint
• itemId: ID do item a atualizar
• Campos: Pares chave-valor de campos a atualizar

Parâmetros opcionais:

• Etag: ETag para controlo de concorrência

eliminarItemDaLista

Elimina um item (linha ou registo) de uma lista do SharePoint.

Parâmetros necessários:

• siteId: ID do site do SharePoint
• listId: ID da lista do SharePoint
• itemId: ID do item a eliminar

Parâmetros opcionais:

• Etag: ETag para controlo de concorrência

listarColunas

Obtém todas as colunas de uma lista do SharePoint.

Parâmetros necessários:

• siteId: ID do site do SharePoint
• listId: ID da lista do SharePoint

criarColuna

Cria uma nova coluna numa lista do SharePoint. Suporta vários tipos de colunas, incluindo texto, número, opção, data e hora, booleano, utilizador, procura, calculadas, entre outros.

Parâmetros necessários:

• siteId: ID do site do SharePoint
• listId: ID da lista do SharePoint
• Nome: Nome da coluna interna (identificador programático)
• columnType: Tipo de coluna: texto, nota, número, inteiro, booleano, data e hora, escolha, escolha múltipla, moeda, referência, utilizador, URL, calculado, termo, vários termos, localização, geolocalização, miniatura, contador, computado, contentTypeId, ficheiro, anexo, guid, escolha de resultado, estado de aprovação

Parâmetros opcionais:

• colunaPropriedades: Definições específicas do tipo (por exemplo, { "maxLength": 255 } para texto, { "choices": ["A","B","C"] } para escolha)
• Descrição: Descrição da coluna
• displayName: Nome apresentado na interface (por defeito, é 'name')
• obrigatória: Torna a coluna obrigatória (predefinição: false)
• Escondido: Ocultar coluna das visualizações (por defeito: falso)

Atualizar coluna

Atualiza uma coluna existente numa lista do SharePoint.

Parâmetros necessários:

• siteId: ID do site do SharePoint
• listId: ID da lista do SharePoint
• columnId: ID da coluna a atualizar

Parâmetros opcionais:

• columnType: Tipo de coluna (necessário quando fornecer 'columnProperties')
• colunaPropriedades: Propriedades específicas de tipo a atualizar
• Descrição: Nova descrição
• displayName: Novo nome de exibição
• Oculto: Ocultar ou mostrar coluna
• Obrigatório: Tornar a coluna obrigatória ou opcional

eliminar coluna

Elimina uma coluna de uma lista do SharePoint. Aviso: Esta ação remove todos os dados armazenados nessa coluna para todos os itens.

Parâmetros necessários:

• siteId: ID do site do SharePoint
• listId: ID da lista do SharePoint
• columnId: ID da coluna a eliminar

Principais características

Gestão do local

• Encontre sites pelo nome ou navegue por sites acessíveis.
• Obtenha um site através do caminho exato do URL.
• Liste sites e subsites filhos.
• Navegação completa na hierarquia do site.

Gestão da biblioteca documental

• Liste todas as bibliotecas de documentos num site.
• Obtenha a biblioteca de documentos padrão.
• Navegue pelo conteúdo da pasta (até 20 itens).
• Cria e gere estruturas de pastas.

Operações de ficheiros

• Crie ficheiros de texto e binários (5 MB ou menos).
• Leia texto e ficheiros binários (5 MB ou menos).
• Apagar, renomear e mover ficheiros e pastas.
• Copiar ficheiros e pastas entre bibliotecas de documentos.
• Carregar ficheiros a partir de URLs do SharePoint ou OneDrive.
• Procure ficheiros e pastas em todos os sites acessíveis.
• Obtenha metadados de ficheiros e pastas.

Operações assíncronas

• Copiar e mover ficheiros e pastas de forma assíncrona entre bibliotecas de documentos.
• Verifique o estado das operações assíncronas usando tokens de operação.

Listar operações

• Criar, ler e eliminar listas.
• Suporte para múltiplos modelos de lista, incluindo genéricos, biblioteca de documentos, eventos e tarefas.
• Partilhe listas com permissões baseadas em funções.
• Gerir os itens da lista criando, lendo, atualizando e eliminando-os.

Gestão das colunas

• Crie colunas com uma grande variedade de tipos, como texto, nota, número, booleano, data e hora, escolha, referência, utilizador, URL, calculado, entre outros.
• Atualize as propriedades das colunas e os metadados.
• Configure os requisitos das colunas e a visibilidade.
• Defina propriedades de coluna específicas de cada tipo.

Compartilhamento e permissões

• Partilhe ficheiros, pastas e listas com os utilizadores.
• Utilize o controlo de acesso baseado em funções com funções de leitura, escrita, contribuição e edição.
• Notificações por email para partilhar.
• Mensagens personalizadas nos convites.

Segurança e conformidade

• Aplique e remova etiquetas de sensibilidade.
• Use múltiplos métodos de atribuição, incluindo padrão, privilegiado e automático.
• Apoiem a justificação da auditoria.
• Use o controlo de concorrência com eTags.

Notes

• As operações de ficheiros são limitadas a ficheiros com 5 MB ou menos para upload e download.
• As operações de cópia e transferência são assíncronas. Usa checkOperationStatus para monitorizar o progresso.
• As operações de cópia e transferência suportam operações entre bibliotecas dentro do SharePoint.
• uploadFileFromUrl requer um URL de origem válido do SharePoint ou do OneDrive.
• Os eTags fornecem controlo de concorrência para atualizações e eliminações.
• Sufixo numérico automático para nomes de pastas duplicados.
• A eliminação de listas não pode ser desfeita.
• A eliminação de colunas remove todos os dados armazenados nessa coluna.
• As operações de pesquisa retornam os 20 primeiros resultados por defeito.