Listar colunas no SharePoint, por uma API
Lista as colunas de uma lista com name, displayName, required, readOnly e a faceta do seu tipo, como text, number, dateTime, boolean ou choice com as opções permitidas. O name, não o displayName, é a chave de uma coluna em fields.
- Identificador
- sharepoint_list_columns
A chamada
POST https://connect.reportei.com/api/tools/sharepoint_list_columns/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"site_id": "<site_id>",
"list_id": "<list_id>"
}
}Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.
Parâmetros
As descrições dos parâmetros seguem a documentação oficial do app, em inglês.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| site_id | string | Sim | Site id from Search sites, in the form hostname,guid,guid, or root for the root site of the organization. |
| list_id | string | Sim | List id from List lists. |
Conexões possíveis
O seu cliente conecta a conta do SharePoint uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
OAuth com o app do seu produto
Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/sharepoint, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.
A resposta
Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.
Pronta para agentes de IA
O input desta tool é um JSON Schema, disponível em GET /api/tools/sharepoint_list_columns. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do SharePoint
- Buscar sitesGETBusca os sites do SharePoint da organização por palavra-chave e retorna id, displayName, name, webUrl e descrição. Use o id como site_id. Só a primeira página é retornada.
- Obter siteGETRetorna um site com id, displayName, name, descrição, webUrl e createdDateTime.
- Listar listasGETLista as listas e bibliotecas de documentos de um site, com id, name, displayName, webUrl e list.template, que é genericList para uma lista e documentLibrary para uma biblioteca. Listas ocultas do sistema ficam de fora. Só a primeira página é retornada.
- Listar itensGETLista os itens de uma lista com id, webUrl, createdBy e lastModifiedDateTime, além dos valores das colunas em fields quando expand é fields. Em uma biblioteca de documentos, cada item é um arquivo ou pasta. Só a primeira página é retornada.
- Obter itemGETRetorna um item de uma lista com id, webUrl, createdBy e lastModifiedDateTime, além dos valores das colunas em fields quando expand é fields.
- Criar itemPOSTCria um item em uma lista e o retorna com seu id e os valores salvos. Toda coluna obrigatória de Listar colunas deve estar em fields.
- Excluir itemDELETEExclui um item de uma lista.
Toolkits da mesma categoria
Ver os 100 toolkitsVeja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
