Referência do Work IQ SharePoint (prévia)

Overview

Ferramentas disponíveis

findSite

Localiza SharePoint sites que você pode acessar. Retorna sites específicos que correspondem a uma consulta de pesquisa ou aos 20 principais sites relevantes se você não fornecer uma consulta.

Parâmetros opcionais:

• Searchquery: Consulta de pesquisa (nome inteiro ou parcial do site). Deixe em branco para retornar os 20 melhores sites acessíveis.

getSiteByPath

Resolve um site SharePoint usando seu nome de host exato e o caminho relativo ao servidor. Use esse método somente quando você tiver a estrutura de URL do site completa. Use findSite quando você souber apenas o nome de um site.

Parâmetros requeridos:

• Hostname: Nome exato do host (por exemplo, 'contoso.sharepoint.com')
• serverRelativePath: Caminho relativo ao servidor (por exemplo, 'sites/Marketing'). A barra à esquerda é opcional.

listSubsites

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

Parâmetros requeridos:

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

listDocumentLibrariesInSite

Lista bibliotecas de documentos (unidades) no site do SharePoint especificado.

Parâmetros opcionais:

• Siteid: ID do site do SharePoint (padrão: 'raiz')

getDefaultDocumentLibraryInSite

Obtém a biblioteca de documentos padrão (drive) de um site do SharePoint.

Parâmetros opcionais:

• Siteid: ID do site do SharePoint (padrão: 'raiz')

getFolderChildren

Enumera os 20 principais arquivos e pastas (DriveItems) dentro de uma pasta pai especificada em uma biblioteca de documentos (unidade).

Parâmetros requeridos:

• documentLibraryId: ID da biblioteca de documentos (drive)

Parâmetros opcionais:

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

findFileOrFolder

Localiza um arquivo ou pasta (DriveItem) acessível ao usuário por consulta de pesquisa. Pesquisa em todos os sites e bibliotecas de documentos às quais o usuário tem acesso.

Parâmetros requeridos:

• Searchquery: Consulta de pesquisa (nome de arquivo inteiro ou parcial)

getFileOrFolderMetadata

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

Parâmetros requeridos:

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

getFileOrFolderMetadataByUrl

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

Parâmetros requeridos:

• fileOrFolderUrl: URL do arquivo ou pasta. A URL não é resgatada para compartilhamento com o usuário; o usuário já deve ter acesso explícito.

readSmallTextFile

Lê (download) um arquivo de texto menor que 5 MB de uma biblioteca de documentos (drive) específica.

Parâmetros requeridos:

• Idarquivo: ID do arquivo (DriveItem) para ler ou baixar
• documentLibraryId: ID da biblioteca de documentos (drive)

readSmallBinaryFile

Lê um arquivo binário com menos de 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 requeridos:

• Idarquivo: ID do arquivo (DriveItem) para ler ou baixar
• documentLibraryId: ID da biblioteca de documentos (drive)

createSmallTextFile

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

Parâmetros requeridos:

• Filename: Nome do arquivo, incluindo extensão
• Contenttext: Conteúdo de texto do arquivo
• documentLibraryId: ID da biblioteca de documentos (drive)

Parâmetros opcionais:

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

createSmallBinaryFile

Cria um arquivo binário menor que 5 MB por meio da codificação de seu conteúdo em base64 em uma biblioteca de documentos (unidade) específica.

Parâmetros requeridos:

• Filename: Nome do arquivo, incluindo extensão
• base64Content: Conteúdo do arquivo binário codificado como uma cadeia de caracteres base64.
• documentLibraryId: ID da biblioteca de documentos (drive)

Parâmetros opcionais:

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

createFolder

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

Parâmetros requeridos:

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

Parâmetros opcionais:

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

renameFileOrFolder

Renomeia um arquivo ou pasta (DriveItem) em uma biblioteca de documentos (drive) especificada. O novo nome deve estar em conformidade com as convenções de nomenclatura.

Parâmetros requeridos:

• documentLibraryId: ID da biblioteca de documentos (drive)
• fileOrFolderId: ID do arquivo ou pasta a ser renomeada
• newFileOrFolderName: O novo nome

Parâmetros opcionais:

• Etag: ETag para controle de simultaneidade

deleteFileOrFolder

Exclui um arquivo ou pasta (DriveItem) de uma biblioteca de documentos especificada.

Parâmetros requeridos:

• documentLibraryId: ID da biblioteca de documentos (drive)
• fileOrFolderId: ID do arquivo ou pasta a ser excluída

Parâmetros opcionais:

• Etag: ETag para controle de simultaneidade

moveFileOrFolder

Move um arquivo ou pasta (DriveItem) para uma pasta de destino. Dá suporte à movimentação entre diferentes bibliotecas de documentos (unidades) em SharePoint. Esta operação é assíncrona. Use checkOperationStatus para monitorar o progresso.

Parâmetros requeridos:

• sourcedoclibid: ID da biblioteca de documentos de origem (disco)
• sourcefileid: ID do arquivo de origem ou pasta a ser movida
• destdoclibid: ID da biblioteca de documentos de destino (drive)
• destfolderid: ID da pasta de destino (deve existir)

Parâmetros opcionais:

• newfilename: Novo nome para o item movido

copyFileOrFolder

Copia um arquivo ou pasta (DriveItem) para uma pasta de destino. Dá suporte à cópia em diferentes bibliotecas de documentos no SharePoint. Esta operação é assíncrona. Use checkOperationStatus para monitorar o progresso.

Parâmetros requeridos:

• sourcedoclibid: ID da biblioteca de documentos de origem (disco)
• sourcefileid: ID do arquivo de origem ou pasta a ser copiada
• destdoclibid: ID da biblioteca de documentos de destino (drive)
• destfolderid: ID da pasta de destino (deve existir)

Parâmetros opcionais:

• newfilename: Novo nome para o item copiado

checkOperationStatus (verificarStatusDaOperação)

Verifica o status de uma operação assíncrona, como uma cópia ou movimentação, usando o token de operação retornado da operação original.

Parâmetros requeridos:

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

uploadFileFromUrl

Faz upload de um arquivo de uma URL do SharePoint ou do OneDrive para uma pasta de destino em uma biblioteca de documentos (drive). O arquivo é copiado da URL de origem, portanto, o arquivo original não é alterado.

Parâmetros requeridos:

• sourceUrl: URL de origem (deve ser uma URL válida do SharePoint ou do OneDrive)
• destinationDocumentLibraryId: ID da biblioteca de documentos de destino. Use me para o OneDrive do usuário

Parâmetros opcionais:

• destinationFolderId: ID da pasta de destino (padrão: root)
• Nome do arquivo: Novo nome de arquivo; padrão é o nome de arquivo original

shareFileOrFolder

Envia um convite de compartilhamento para conceder permissões de leitura ou gravação em um arquivo ou pasta (DriveItem) em uma biblioteca de documentos (unidade) especificada.

Parâmetros requeridos:

• documentLibraryId: ID da biblioteca de documentos (drive)
• fileOrFolderId: ID do arquivo ou pasta a ser compartilhada
• recipientEmails: Matriz de endereços de email de destinatários
• roles: array de funções: "leitura", "gravação" (gravação concede leitura e gravação)

Parâmetros opcionais:

• Mensagem: Mensagem personalizada para o email de convite (padrão: aqui está o arquivo no qual estamos colaborando.)
• sendInvitation: Se é necessário enviar um convite de compartilhamento (padrão: true)

definirEtiquetaDeSensibilidadeNoArquivo

Define o rótulo de confidencialidade de um arquivo na biblioteca de documentos (drive) especificada.

Parâmetros requeridos:

• documentLibraryId: ID da biblioteca de documentos (drive)
• ID do arquivo: ID do arquivo (DriveItem)
• sensitivityLabelId: a ID do rótulo de confidencialidade ou cadeia de caracteres vazia para removê-la

Parâmetros opcionais:

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

listLists

Obtém todas as listas de SharePoint disponíveis em um site específico. Use para descobrir quais listas existem em um site.

Parâmetros requeridos:

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

createList

Cria um novo SharePoint list em um site.

Parâmetros requeridos:

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

Parâmetros opcionais:

• Colunas: Conjunto de colunas como pares chave-valor: [{ Key: 'JobTitle', Value: 'text' }]. Tipos válidos: texto, multilineText, número, booliano, dateTime, escolha, pesquisa, personOrGroup, hiperlink, moeda, calculado
• Modelo: Tipo de modelo de lista (padrão: 'genericList'). Opções: listaGenérica, bibliotecaDeDocumentos, eventos, tarefas, comunicados, contatos, links, questionário, rastreamentoDeProblemas, quadroDeDiscussão

excluirLista

Exclui uma lista do SharePoint de um site. Exclui todo o contêiner de lista e todos os itens dentro dele. Não pode ser desfeito.

Parâmetros requeridos:

• siteId: a ID do site do SharePoint
• Listid: ID da lista a ser excluída

Parâmetros opcionais:

• Etag: ETag para controle de simultaneidade

sendInviteForList

Envia um convite de compartilhamento para conceder permissões em uma lista do SharePoint.

Parâmetros requeridos:

• Listid: ID da lista do SharePoint a ser compartilhada
• recipientEmails: Matriz de endereços de email de destinatários
• role: função: 'leitura' (somente exibição), 'contribuir' (exibir, adicionar, atualizar, excluir itens), 'editar' (edição completa incluindo estrutura de lista)

Parâmetros opcionais:

• Siteurl: URL do site do SharePoint que contém a lista
• Sendemail: Se deve enviar uma notificação por email (padrão: true)

listListItems

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

Parâmetros requeridos:

• siteId: a ID do site do SharePoint
• Listid: ID da lista do SharePoint

getListItem

Obtém um único item (linha/registro) de uma lista do SharePoint pelo seu ID.

Parâmetros requeridos:

• siteId: a ID do site do SharePoint
• Listid: ID da lista do SharePoint
• Itemid: ID do item de lista específico

createListItem

Cria um novo item (linha ou registro) em uma lista do SharePoint.

Parâmetros requeridos:

• siteId: a ID do site do SharePoint
• Listid: ID da lista do SharePoint
• Campos: Pares chave-valor para os valores dos campos: [{ Key: 'Title', Value: 'Software Engineer' }, { Key: 'Department', Value: 'Engineering' }]. O campo 'Título' normalmente é necessário

atualizarItemDaLista

Atualiza um item existente (linha ou registro) em uma lista do SharePoint. Somente os campos especificados são atualizados; os campos omitidos mantêm seus valores.

Parâmetros requeridos:

• siteId: a ID do site do SharePoint
• Listid: ID da lista do SharePoint
• Itemid: ID do item a ser atualizado
• Campos: Pares chave-valor de campos a serem atualizados

Parâmetros opcionais:

• Etag: ETag para controle de simultaneidade

deleteListItem

Exclui um item (linha ou registro) de uma lista do SharePoint.

Parâmetros requeridos:

• siteId: a ID do site do SharePoint
• Listid: ID da lista do SharePoint
• Itemid: ID do item a ser excluído

Parâmetros opcionais:

• Etag: ETag para controle de simultaneidade

listColumns

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

Parâmetros requeridos:

• siteId: a ID do site do SharePoint
• Listid: ID da lista do SharePoint

criarColuna

Cria uma nova coluna em um SharePoint list. Dá suporte a muitos tipos de coluna, incluindo texto, número, escolha, data e hora, booleano, usuário, consulta, calculado e muito mais.

Parâmetros requeridos:

• siteId: a ID do site do SharePoint
• Listid: ID da lista do SharePoint
• Nome: Nome da coluna interna (identificador programático)
• columnType: Tipo de coluna: texto, observação, número, inteiro, booliano, dateTime, escolha, múltipla escolha, moeda, pesquisa, usuário, url, calculado, termo, vários termos, local, localização geográfica, miniatura, contador, computado, contentTypeId, arquivo, anexo, guid, outcomeChoice, approvalStatus

Parâmetros opcionais:

• columnProperties: Configurações específicas de tipo (por exemplo, { "maxLength": 255 } para texto, { "choices": ["A","B","C"] } para escolha)
• Descrição: Descrição da coluna
• displayName: Nome de exibição mostrado na UI (o padrão é 'name')
• Obrigatório: Tornar a coluna obrigatória (padrão: falso)
• Escondido: Ocultar coluna nas visualizações (padrão: false)

atualizarColuna

Atualiza uma coluna existente em um SharePoint list.

Parâmetros requeridos:

• siteId: a ID do site do SharePoint
• Listid: ID da lista do SharePoint
• Columnid: ID da coluna a ser atualizada

Parâmetros opcionais:

• Columntype: Tipo de coluna (necessário ao fornecer 'columnProperties')
• columnProperties: Propriedades específicas do tipo a serem atualizadas
• Descrição: Nova descrição
• Displayname: Novo nome de exibição
• Ocultar: Ocultar ou mostrar a coluna
• Obrigatório: Defina a coluna como obrigatória ou opcional.

deleteColumn

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

Parâmetros requeridos:

• siteId: a ID do site do SharePoint
• Listid: ID da lista do SharePoint
• Columnid: ID da coluna a ser excluída

Características principais

Gerenciamento de site

• Localize sites por nome ou navegue por sites acessíveis.
• Obtenha um site pelo caminho exato da URL.
• Listar sites filhos e subsites.
• Navegação abrangente da hierarquia de sites.

Gerenciamento da biblioteca de documentos

• Listar todas as bibliotecas de documentos em um site.
• Obtenha a biblioteca de documentos padrão.
• Procurar conteúdo de pasta (até 20 itens)
• Criar e gerenciar estruturas de pastas.

Operações de arquivo

• Crie arquivos binários e de texto (≤5 MB).
• Ler texto e arquivos binários (≤5 MB).
• Excluir, renomear e mover arquivos e pastas.
• Copie arquivos e pastas entre bibliotecas de documentos.
• Carregue arquivos de urls de SharePoint ou OneDrive.
• Pesquise arquivos e pastas em todos os sites acessíveis.
• Obter metadados de arquivo e pasta.

Operações assíncronas

• Copie e mova arquivos e pastas de forma assíncrona entre bibliotecas de documentos.
• Verifique o status das operações assíncronas usando tokens de operação.

Listar operações

• Criar, ler e excluir listas.
• Suporte para vários modelos de lista, incluindo genéricos, biblioteca de documentos, eventos e tarefas.
• Compartilhe listas com permissões baseadas em função.
• Gerencie itens de lista criando, lendo, atualizando e excluindo-os.

Gerenciamento de colunas

• Crie colunas com uma ampla variedade de tipos, como texto, nota, número, booleano, data e hora, escolha, referência, usuário, URL, calculado e muito mais.
• Atualize as propriedades e os metadados da coluna.
• Configure os requisitos de coluna e a visibilidade.
• Defina propriedades de coluna específicas do tipo.

Compartilhamento e permissões

• Compartilhe arquivos, pastas e listas com usuários.
• Use o controle de acesso baseado em função com funções de leitura, gravação, contribuição e edição.
• Notificações por email para compartilhamento
• Mensagens personalizadas em convites

Segurança e conformidade

• Aplicar e remover etiquetas de sensibilidade.
• Use vários métodos de atribuição, incluindo padrão, privilegiado e automático.
• Justificativa para auditoria de suporte.
• Use o controle de simultaneidade com eTags.

Notes

• As operações de arquivo são limitadas a arquivos com 5 MB ou menos para upload e download.
• As operações de cópia e movimentação são assíncronas. Use checkOperationStatus para monitorar o progresso.
• As operações de cópia e movimentação dão suporte a operações entre bibliotecas em SharePoint.
• uploadFileFromUrl requer uma URL de origem de SharePoint ou OneDrive válida.
• As eTags fornecem controle de simultaneidade para atualizações e exclusões.
• Sufixo numérico automático para nomes de pasta duplicados
• A exclusão de lista não pode ser desfeita.
• A exclusão de coluna remove todos os dados armazenados nessa coluna.
• As operações de pesquisa retornam os 20 principais resultados por padrão.