Salesforce
O Salesforce Connector fornece uma API para trabalhar com objetos Salesforce.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Metadados do conector | |
|---|---|
| Publicador | Microsoft |
Para usar essa integração, você precisará de acesso a uma conta do Salesforce com acesso à API habilitado. Para ver quais edições do Salesforce têm acesso à API, verifique o artigo do Salesforce. Para fazer uma conexão, selecione Entrar. Você será solicitado a fornecer seu logon do Salesforce, siga o restante das telas para criar uma conexão. A versão padrão da API atualmente utilizada pelo conector é v58.0.
Agora você está pronto para começar a usar essa integração.
Observação
O conector salesforce agora está disponível no Microsoft CoPilot Studio.
Problemas e limitações conhecidos
- Há um limite no número de campos que uma consulta ao Salesforce pode conter. O limite varia dependendo do tipo das colunas, do número de colunas computadas etc. Quando você recebe um erro "A consulta está selecionando muitos campos ou as condições de filtro são muito complicadas", isso significa que sua consulta excede o limite. Para evitar isso, use a opção avançada "Selecionar Consulta" e especifique os campos de que você realmente precisa.
- As configurações de sessão do Salesforce podem bloquear essa integração. Verifique se a configuração "Bloquear sessões para o endereço IP do qual elas se originaram" está desabilitada .
- O acesso à API do Salesforce deve ser habilitado. Para verificar as configurações de acesso, acesse as configurações de perfil do usuário atual e pesquise a caixa de seleção "API Habilitada".
- As contas de avaliação do Salesforce não têm acesso à API e, portanto, não podem ser usadas.
- Não há suporte para campos personalizados do tipo "Lista de seleção (várias seleções)" por ações criar registro e atualizar registro (V3) (incluindo suas respectivas versões preteridas).
- Não há suporte para a criação de uma nova conexão usando a entrada "Domínio Personalizado" do Salesforce.
- O uso de campos anuláveis no
Order Byparâmetro deve ser evitado, pois isso pode causar um erro de runtime nas seguintes operações: Obter registros, quando um registro é criado, quando um registro é criado ou modificado. - Quando um registro é modificado , o gatilho só pode detectar a alteração de registro do objeto padrão, mas não pode detectar a alteração do anexo do objeto padrão.
- Os seguintes gatilhos e ações não puderam funcionar corretamente em tabelas personalizadas sem a coluna "Id": quando um registro é criado, quando um registro é criado ou modificado, Obter registro, Criar registro, Atualizar registro (V3), Excluir registro.
- Quando um registro for criado ou modificado , o gatilho retornará itens novos e modificados. Para verificar se um item retornado é novo ou modificado, compare seus valores de campo "CreatedDate" e "LastModifiedDate". Em novos itens, espera-se que esses valores sejam iguais. Nesse sentido, ambos os campos são obrigatórios para os itens para os quais esse gatilho é aplicado.
- Objetos complexos (objetos com objetos aninhados, veja o exemplo abaixo) não têm suporte para Criar registro e registro de atualização (V3) ( incluindo suas respectivas versões preteridas). Para solucionar essa limitação, estruturas de objeto simples devem ser usadas.
- Executar uma consulta SOQL e obter ações de registros são baseadas na API 'Consulta'. Portanto, nem todos os registros podem ser retornados devido a limitações de API (por exemplo, itens excluídos).
- Se estiver enfrentando qualquer problema com a definição de dados como valor padrão usando o registro de atualização (V3), isso ocorre devido ao cabeçalho "sforce-auto-assign" definido como true. Para solucionar isso, é sugerido usar Enviar uma ação de solicitação HTTP e definir o valor do cabeçalho personalizado como "sforce-auto-assign: false"
- O conector salesforce tem tratamento especial para autenticação, no entanto, devido a uma limitação no back-end do Salesforce, os tokens expirarão se não forem usados por um longo período de tempo e os usuários poderão enfrentar um erro "Bad_OAuth_Token/Sessão expirado ou inválido". Faça logon novamente com suas credenciais.
- Essa limitação agora é resolvida, no entanto, uma nova conexão deve ser criada para uso. A conexão pré-existente ainda funcionará, mas o problema acima pode ser enfrentado.
Exemplo de um objeto complexo que não tem suporte porque tem um objeto aninhado com MerchandiseExtID__c campo:
{
"Name" : "LineItemCreatedViaExtID",
"Merchandise__r" :
{
"MerchandiseExtID__c" : 123
}
}
Exemplo do objeto complexo acima reescrito como um objeto simples com suporte do IS:
{
"Name" : "LineItemCreatedViaExtID",
"MerchandiseExtID__c" : 123
}
Carregando anexos
A API do Salesforce dá suporte ao carregamento de anexos para os seguintes objetos: 'Account', 'Asset', 'Campaign', 'Case', 'Contact', 'Contract', 'Custom objects', 'EmailMessage', 'EmailTemplate', 'Event', 'Lead', 'Opportunity', 'Product2', 'Solution', 'Task'. Para carregar o arquivo de anexo, use a ação Criar registro e consulte a página de documentação do Salesforce sobre o significado dos campos e parâmetros necessários.
Funções e operações delegadas do Power Apps para Salesforce
Essas operações do Power Apps, para um determinado tipo de dados, podem ser delegadas ao Salesforce para processamento (em vez de processar localmente no Power Apps).
Funções de nível superior
| Delegavel | |
|---|---|
| Mediana | Não |
| Filter | Yes |
| LookUp | Yes |
| Máximo | Não |
| Minuto | Não |
| Pesquisa | Yes |
| Classificar | Yes |
| SortByColumns | Yes |
| Soma | Não |
Predicados de filtragem e pesquisa
| Salesforce | |
|---|---|
| Não | Yes |
| IsBlank | Não |
| TrimEnds | Não |
| Len | Não |
| +, - | Não |
| <, <=, =, <>, , >>= | Yes |
| E (&&), ou (||), não (!) | Yes |
| mergulhar | Yes |
| StartsWith | Não |
Conector aprofundado
Para obter mais informações sobre o conector, consulte a seção detalhada.
Limites Gerais
| Nome | Value |
|---|---|
| Número máximo de solicitações sendo processadas pelo conector simultaneamente | 50 |
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Fazer logon com o URI de Logon do Salesforce Personalizado | Fazer logon com o URI de Logon do Salesforce Personalizado | Somente governo dos EUA (GCC) | Compartilhável |
| Fazer logon com a conta do Salesforce | Forneça credenciais do Salesforce para logon. | Todas as regiões | Compartilhável |
| Padrão [PRETERIDO] | Essa opção é apenas para conexões mais antigas sem um tipo de autenticação explícita e é fornecida apenas para compatibilidade com versões anteriores. | Todas as regiões | Não compartilhável |
Fazer logon com o URI de Logon do Salesforce Personalizado
ID de autenticação: CustomLoginURIAuth
Aplicável: somente governo dos EUA (GCC)
Fazer logon com o URI de Logon do Salesforce Personalizado
Essa é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, a conexão também será compartilhada. Para obter mais informações, consulte a visão geral dos Conectores para aplicativos de tela – Power Apps | Microsoft Docs
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| URI de Logon do Salesforce | cadeia | https://custom-___domain-or-instance.my.salesforce.com | Verdade |
| Versão da API do Salesforce | cadeia | A versão da API do Salesforce. Por padrão, deixe em branco ou use v58.0 |
Fazer logon com a conta do Salesforce
ID de autenticação: BasicAuthentication
Aplicável: todas as regiões
Forneça credenciais do Salesforce para logon.
Essa é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, a conexão também será compartilhada. Para obter mais informações, consulte a visão geral dos Conectores para aplicativos de tela – Power Apps | Microsoft Docs
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| URI de logon (Ambiente) | cadeia | O URI de Logon do Salesforce. Para Produção, deixe em branco ou use https://login.salesforce.com | |
| Versão da API do Salesforce | cadeia | A versão da API do Salesforce. Por padrão, deixe em branco ou use v58.0 |
Padrão [PRETERIDO]
Aplicável: todas as regiões
Essa opção é apenas para conexões mais antigas sem um tipo de autenticação explícita e é fornecida apenas para compatibilidade com versões anteriores.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| URI de logon (Ambiente) | cadeia | O URI de Logon do Salesforce. Para Produção, deixe em branco ou use https://login.salesforce.com | |
| Versão da API do Salesforce | cadeia | A versão da API do Salesforce. Por padrão, deixe em branco ou use v58.0 |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 900 | 60 segundos |
Ações
| Atualizar registro (V3) |
Essa operação atualiza um registro e permite valores nulos. |
| Atualizar registro [PRETERIDO] |
Esta ação foi preterida. Em vez disso, use o registro de atualização (V3 ).
|
| Atualizar registro [PRETERIDO] |
Esta operação atualiza um registro. |
| Carregar dados do trabalho |
Carrega dados de um trabalho usando dados CSV. |
| Criar registro |
Essa operação cria um registro e permite valores nulos. |
| Criar registro [PRETERIDO] |
Essa operação cria um registro. |
| Criar um trabalho (V2) |
Cria um trabalho, que representa uma operação em massa (e dados associados) que é enviada ao Salesforce para processamento assíncrono. Forneça dados de trabalho por meio de uma solicitação carregar dados do trabalho. |
| Criar um trabalho [PRETERIDO] |
Esta ação foi preterida. Em vez disso, use Criar um trabalho (V2 ).
|
| Enviar uma solicitação HTTP |
Construir uma solicitação da API REST do Salesforce para invocar |
| Excluir registro |
Essa operação exclui um registro. |
| Excluir um trabalho |
Exclui um trabalho. Para ser excluído, um trabalho deve ter um estado de UploadComplete, JobComplete, Abortado ou Com Falha. |
| Executar consulta de pesquisa SOSL |
Executar o qyery de pesquisa SOSL especificado |
| Executar uma consulta SOQL |
Execute uma consulta SOQL. |
| Fechar ou anular um trabalho |
Fecha ou anula um trabalho. Use UploadComplete para fechar um trabalho ou Abortado para anular um trabalho. Se você fechar um trabalho, o Salesforce enfileira o trabalho e os dados carregados para processamento e você não pode adicionar nenhum dado de trabalho adicional. Se você anular um trabalho, o trabalho não será enfileirado ou processado. |
| Inserir ou atualizar (Upsert) um registro por ID externa (V2) |
Esta operação insere ou atualiza (upserts) um registro usando uma ID externa. |
| Inserir ou atualizar (Upsert) um registro por ID externa [PRETERIDO] |
Esta ação foi preterida. Em vez disso, use Inserir ou Atualizar (Upsert) um Registro por ID Externa (V2 ).
|
| Obter informações de trabalho |
Recupera informações detalhadas sobre um trabalho. |
| Obter registro |
Esta operação obtém um registro. |
| Obter registro [PRETERIDO] |
Esta ação foi preterida. Em vez disso, use Obter registro .
|
| Obter registros |
Esta operação obtém registros de um determinado tipo de objeto Salesforce, como 'Leads'. |
| Obter registros case do Salesforce |
Esta operação obtém registros case do Salesforce. |
| Obter registros de conta do Salesforce |
Esta operação obtém registros de conta do Salesforce. |
| Obter registros de contato do Salesforce |
Esta operação obtém registros de contato do Salesforce. |
| Obter registros de oportunidade do Salesforce |
Esta operação obtém registros de oportunidade do Salesforce. |
| Obter registros de produto do Salesforce |
Esta operação obtém registros de produto do Salesforce. |
| Obter registros de usuário do Salesforce |
Esta operação obtém registros de usuário do Salesforce. |
| Obter resultados do trabalho |
Recupera uma lista de registros com base no tipo de resultado de um trabalho concluído. |
| Obter tipos de objeto |
Esta operação lista os tipos de objeto salesforce disponíveis. |
| Obter todos os trabalhos |
Obter uma lista de todos os trabalhos |
| Obter um registro por ID externa |
Essa operação recupera um registro usando uma ID externa. |
| Servidor MCP para Salesforce |
Servidor MCP para Salesforce |
Atualizar registro (V3)
Essa operação atualiza um registro e permite valores nulos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de objeto Salesforce
|
table | True | string |
nome da tabela |
|
ID do registro
|
id | True | string |
chave de item |
|
item a ser atualizado
|
item | True | dynamic |
item a ser atualizado |
|
Selecionar Consulta
|
$select | string |
Campos específicos a serem recuperados de entradas (padrão = todos). |
Retornos
Atualizar registro [PRETERIDO]
Esta ação foi preterida. Em vez disso, use o registro de atualização (V3 ).
Essa operação atualiza um registro e permite valores nulos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de objeto Salesforce
|
table | True | string |
nome da tabela |
|
ID do registro
|
id | True | string |
chave de item |
|
item a ser atualizado
|
item | True | dynamic |
item a ser atualizado |
|
Selecionar Consulta
|
$select | string |
Campos específicos a serem recuperados de entradas (padrão = todos). |
Retornos
Atualizar registro [PRETERIDO]
Esta operação atualiza um registro.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de objeto Salesforce
|
table | True | string |
O tipo de objeto Salesforce, como 'Leads'. |
|
ID do registro
|
id | True | string |
O identificador exclusivo do registro a ser atualizado. |
|
Registro
|
item | True | dynamic |
O registro com propriedades alteradas. |
Retornos
Carregar dados do trabalho
Carrega dados de um trabalho usando dados CSV.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do trabalho
|
jobId | True | string |
ID do trabalho |
|
Conteúdo do arquivo CSV
|
body | True | binary |
Dados CSV a serem carregados |
Criar registro
Essa operação cria um registro e permite valores nulos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de objeto Salesforce
|
table | True | string |
nome da tabela |
|
Registro
|
item | True | dynamic |
Registro |
Retornos
Criar registro [PRETERIDO]
Essa operação cria um registro.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de objeto Salesforce
|
table | True | string |
O tipo de objeto Salesforce, como 'Leads'. |
|
Registro
|
item | True | dynamic |
O registro a ser criado. |
Retornos
Criar um trabalho (V2)
Cria um trabalho, que representa uma operação em massa (e dados associados) que é enviada ao Salesforce para processamento assíncrono. Forneça dados de trabalho por meio de uma solicitação carregar dados do trabalho.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Object
|
object | True | string |
O tipo de objeto para os dados que estão sendo processados. |
|
Operation
|
operation | True | string |
A operação de processamento do trabalho. |
|
Delimitador de Colunas
|
columnDelimiter | string |
O delimitador de coluna usado para dados de trabalho CSV. |
|
|
Nome do campo de ID externa
|
externalIdFieldName | string |
O campo ID externa no objeto que está sendo atualizado. Necessário apenas para operações upsert. Os valores de campo também devem existir nos dados do trabalho CSV. |
|
|
Final da linha
|
lineEnding | string |
O final da linha usado para dados de trabalho CSV, marcando o fim de uma linha de dados. |
|
|
Tipo de conteúdo
|
contentType | string |
O tipo de conteúdo do trabalho. |
Retornos
Saída da operação 'CreateJobV2'
- Corpo
- CreateJobResponse
Criar um trabalho [PRETERIDO]
Esta ação foi preterida. Em vez disso, use Criar um trabalho (V2 ).
Cria um trabalho, que representa uma operação em massa (e dados associados) que é enviada ao Salesforce para processamento assíncrono. Forneça dados de trabalho por meio de uma solicitação carregar dados do trabalho.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Delimitador de Colunas
|
columnDelimiter | string |
Delimitador de Colunas |
|
|
Nome do campo de ID externa
|
externalIdFieldName | string |
Nome do campo de ID externa |
|
|
Final da linha
|
lineEnding | string |
Final da linha |
|
|
Object
|
object | True | string |
Object |
|
Operation
|
operation | True | string |
Operation |
Retornos
- Corpo
- JobInfo
Enviar uma solicitação HTTP
Construir uma solicitação da API REST do Salesforce para invocar
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
URI
|
Uri | True | string |
O URI completo ou relativo. Exemplo de URI relativo: /services/data/v41.0/sobjects/account |
|
Método
|
Method | True | string |
O método HTTP (o padrão é GET). |
|
Corpo
|
Body | binary |
O conteúdo do corpo da solicitação. |
|
|
Tipo de conteúdo
|
ContentType | string |
O cabeçalho de tipo de conteúdo para o corpo (o padrão é application/json). |
|
|
CustomHeader1
|
CustomHeader1 | string |
Cabeçalho personalizado 1. Especificar no formato: cabeçalho-nome: cabeçalho-valor |
|
|
CustomHeader2
|
CustomHeader2 | string |
Cabeçalho personalizado 2. Especificar no formato: cabeçalho-nome: cabeçalho-valor |
|
|
CustomHeader3
|
CustomHeader3 | string |
Cabeçalho personalizado 3. Especificar no formato: cabeçalho-nome: cabeçalho-valor |
|
|
CustomHeader4
|
CustomHeader4 | string |
Cabeçalho personalizado 4. Especificar no formato: cabeçalho-nome: cabeçalho-valor |
|
|
CustomHeader5
|
CustomHeader5 | string |
Cabeçalho personalizado 5. Especificar no formato: cabeçalho-nome: cabeçalho-valor |
Retornos
- response
- ObjectWithoutType
Excluir registro
Essa operação exclui um registro.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de objeto Salesforce
|
table | True | string |
O tipo de objeto Salesforce, como 'Leads'. |
|
ID do registro
|
id | True | string |
O identificador exclusivo do registro a ser excluído. |
Excluir um trabalho
Exclui um trabalho. Para ser excluído, um trabalho deve ter um estado de UploadComplete, JobComplete, Abortado ou Com Falha.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do trabalho
|
jobId | True | string |
ID do trabalho |
Executar consulta de pesquisa SOSL
Executar o qyery de pesquisa SOSL especificado
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Cadeia de caracteres de pesquisa SOSL
|
q | True | string |
Cadeia de caracteres de pesquisa SOSL |
Retornos
Resposta da consulta de pesquisa SOSL
- Corpo
- SOSLSearchQueryResponse
Executar uma consulta SOQL
Execute uma consulta SOQL.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Consulta SOQL
|
query | True | string |
Texto da consulta SOQL. Parâmetros dinâmicos podem ser especificados usando a sintaxe '@paramName'. |
|
Parâmetros de consulta
|
parameters | object |
Parâmetros dinâmicos de consulta SOQL. A chave é o nome do parâmetro (sem '@' no sinal), o valor é o valor do parâmetro. |
Retornos
- response
- object
Fechar ou anular um trabalho
Fecha ou anula um trabalho. Use UploadComplete para fechar um trabalho ou Abortado para anular um trabalho. Se você fechar um trabalho, o Salesforce enfileira o trabalho e os dados carregados para processamento e você não pode adicionar nenhum dado de trabalho adicional. Se você anular um trabalho, o trabalho não será enfileirado ou processado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do trabalho
|
jobId | True | string |
ID do trabalho |
|
estado
|
state | True | string |
estado |
Retornos
- Corpo
- JobInfo
Inserir ou atualizar (Upsert) um registro por ID externa (V2)
Esta operação insere ou atualiza (upserts) um registro usando uma ID externa.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de objeto Salesforce
|
table | True | string |
O tipo de objeto Salesforce, como 'Leads'. |
|
Campo ID externa
|
externalIdField | True | string |
Campo marcado como campo ID externa no objeto Salesforce. |
|
ID externa
|
externalId | True | string |
ID externa do registro para upsert. |
|
Registro
|
item | True | dynamic |
O registro com propriedades alteradas. |
Retornos
Inserir ou atualizar (Upsert) um registro por ID externa [PRETERIDO]
Esta ação foi preterida. Em vez disso, use Inserir ou Atualizar (Upsert) um Registro por ID Externa (V2 ).
Esta operação insere ou atualiza (upserts) um registro usando uma ID externa.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de objeto Salesforce
|
table | True | string |
O tipo de objeto Salesforce, como 'Leads'. |
|
Campo ID externa
|
externalIdField | True | string |
Campo marcado como campo ID externa no objeto Salesforce. |
|
ID externa
|
externalId | True | string |
ID externa do registro para upsert. |
|
Registro
|
item | True | dynamic |
O registro com propriedades alteradas. |
Retornos
Obter informações de trabalho
Recupera informações detalhadas sobre um trabalho.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do trabalho
|
jobId | True | string |
ID do trabalho |
Retornos
- Corpo
- CheckJobResponse
Obter registro
Esta operação obtém um registro.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de objeto Salesforce
|
table | True | string |
nome da tabela |
|
ID do registro
|
id | True | string |
chave de item |
|
Selecionar Consulta
|
$select | string |
Campos específicos a serem recuperados de entradas (padrão = todos). |
Retornos
Obter registro [PRETERIDO]
Esta ação foi preterida. Em vez disso, use Obter registro .
Esta operação obtém um registro.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
tabela
|
table | True | string | |
|
id
|
id | True | string |
Retornos
Obter registros
Esta operação obtém registros de um determinado tipo de objeto Salesforce, como 'Leads'.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de objeto Salesforce
|
table | True | string |
O tipo de objeto Salesforce, como 'Leads'. |
|
Filtrar Consulta
|
$filter | string |
Uma consulta de filtro ODATA para restringir as entradas retornadas (por exemplo, stringColumn eq 'string' OR numberColumn lt 123). |
|
|
Ordenar por
|
$orderby | string |
Uma consulta orderBy do ODATA para especificar a ordem das entradas. |
|
|
Contagem superior
|
$top | integer |
Número total de entradas a serem recuperadas (padrão = todas). |
|
|
Ignorar Contagem
|
$skip | integer |
O número de entradas a serem ignoradas (padrão = 0). |
|
|
Selecionar Consulta
|
$select | string |
Campos específicos a serem recuperados de entradas (padrão = todos). |
Retornos
Obter registros case do Salesforce
Esta operação obtém registros case do Salesforce.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Filtrar Consulta
|
$filter | string |
Uma consulta de filtro ODATA para restringir as entradas retornadas (por exemplo, stringColumn eq 'string' OR numberColumn lt 123). |
|
|
Ordenar por
|
$orderby | string |
Uma consulta orderBy do ODATA para especificar a ordem das entradas. |
|
|
Contagem superior
|
$top | integer |
Número total de entradas a serem recuperadas (padrão = todas). |
|
|
Ignorar Contagem
|
$skip | integer |
O número de entradas a serem ignoradas (padrão = 0). |
|
|
Selecionar Consulta
|
$select | string |
Campos específicos a serem recuperados de entradas (padrão = todos). |
Retornos
Obter registros de conta do Salesforce
Esta operação obtém registros de conta do Salesforce.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Filtrar Consulta
|
$filter | string |
Uma consulta de filtro ODATA para restringir as entradas retornadas (por exemplo, stringColumn eq 'string' OR numberColumn lt 123). |
|
|
Ordenar por
|
$orderby | string |
Uma consulta orderBy do ODATA para especificar a ordem das entradas. |
|
|
Contagem superior
|
$top | integer |
Número total de entradas a serem recuperadas (padrão = todas). |
|
|
Ignorar Contagem
|
$skip | integer |
O número de entradas a serem ignoradas (padrão = 0). |
|
|
Selecionar Consulta
|
$select | string |
Campos específicos a serem recuperados de entradas (padrão = todos). |
Retornos
Obter registros de contato do Salesforce
Esta operação obtém registros de contato do Salesforce.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Filtrar Consulta
|
$filter | string |
Uma consulta de filtro ODATA para restringir as entradas retornadas (por exemplo, stringColumn eq 'string' OR numberColumn lt 123). |
|
|
Ordenar por
|
$orderby | string |
Uma consulta orderBy do ODATA para especificar a ordem das entradas. |
|
|
Contagem superior
|
$top | integer |
Número total de entradas a serem recuperadas (padrão = todas). |
|
|
Ignorar Contagem
|
$skip | integer |
O número de entradas a serem ignoradas (padrão = 0). |
|
|
Selecionar Consulta
|
$select | string |
Campos específicos a serem recuperados de entradas (padrão = todos). |
Retornos
Obter registros de oportunidade do Salesforce
Esta operação obtém registros de oportunidade do Salesforce.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Filtrar Consulta
|
$filter | string |
Uma consulta de filtro ODATA para restringir as entradas retornadas (por exemplo, stringColumn eq 'string' OR numberColumn lt 123). |
|
|
Ordenar por
|
$orderby | string |
Uma consulta orderBy do ODATA para especificar a ordem das entradas. |
|
|
Contagem superior
|
$top | integer |
Número total de entradas a serem recuperadas (padrão = todas). |
|
|
Ignorar Contagem
|
$skip | integer |
O número de entradas a serem ignoradas (padrão = 0). |
|
|
Selecionar Consulta
|
$select | string |
Campos específicos a serem recuperados de entradas (padrão = todos). |
Retornos
Obter registros de produto do Salesforce
Esta operação obtém registros de produto do Salesforce.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Filtrar Consulta
|
$filter | string |
Uma consulta de filtro ODATA para restringir as entradas retornadas (por exemplo, stringColumn eq 'string' OR numberColumn lt 123). |
|
|
Ordenar por
|
$orderby | string |
Uma consulta orderBy do ODATA para especificar a ordem das entradas. |
|
|
Contagem superior
|
$top | integer |
Número total de entradas a serem recuperadas (padrão = todas). |
|
|
Ignorar Contagem
|
$skip | integer |
O número de entradas a serem ignoradas (padrão = 0). |
|
|
Selecionar Consulta
|
$select | string |
Campos específicos a serem recuperados de entradas (padrão = todos). |
Retornos
Obter registros de usuário do Salesforce
Esta operação obtém registros de usuário do Salesforce.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Filtrar Consulta
|
$filter | string |
Uma consulta de filtro ODATA para restringir as entradas retornadas (por exemplo, stringColumn eq 'string' OR numberColumn lt 123). |
|
|
Ordenar por
|
$orderby | string |
Uma consulta orderBy do ODATA para especificar a ordem das entradas. |
|
|
Contagem superior
|
$top | integer |
Número total de entradas a serem recuperadas (padrão = todas). |
|
|
Ignorar Contagem
|
$skip | integer |
O número de entradas a serem ignoradas (padrão = 0). |
|
|
Selecionar Consulta
|
$select | string |
Campos específicos a serem recuperados de entradas (padrão = todos). |
Retornos
Obter resultados do trabalho
Recupera uma lista de registros com base no tipo de resultado de um trabalho concluído.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do trabalho
|
jobId | True | string |
ID do trabalho |
|
Tipo de resultado
|
resultType | True | string |
Tipo de resultado |
Retornos
- response
- string
Obter tipos de objeto
Esta operação lista os tipos de objeto salesforce disponíveis.
Retornos
Representa uma lista de tabelas.
- Corpo
- TablesList
Obter todos os trabalhos
Obter uma lista de todos os trabalhos
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Modo de simultaneidade
|
concurrenyMode | string |
Modo de simultaneidade |
|
|
O PK Chunking está habilitado
|
isPkChunkingEnabled | boolean |
O PK Chunking está habilitado |
|
|
Tipo de Trabalho
|
jobType | string |
Tipo de Trabalho |
|
|
Localizador de Consulta
|
queryLocator | string |
Localizador de Consulta |
Retornos
- Corpo
- GetAllJobsResponse
Obter um registro por ID externa
Essa operação recupera um registro usando uma ID externa.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de objeto Salesforce
|
table | True | string |
O tipo de objeto Salesforce, como 'Leads'. |
|
Campo ID externa
|
externalIdField | True | string |
Campo marcado como campo ID externa no objeto Salesforce. |
|
ID externa
|
externalId | True | string |
ID externa do registro a ser recuperado. |
Retornos
Servidor MCP para Salesforce
Servidor MCP para Salesforce
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
jsonrpc
|
jsonrpc | string | ||
|
id
|
id | string | ||
|
método
|
method | string | ||
|
parâmetros
|
params | object | ||
|
resultado
|
result | object | ||
|
erro
|
error | object | ||
|
sessionId
|
sessionId | string |
Retornos
- Corpo
- MCPQueryResponse
Gatilhos
| Quando um registro é criado |
Essa operação é disparada quando há registros recém-criados. |
| Quando um registro é modificado |
Essa operação é disparada quando há registros recém-modificados. |
Quando um registro é criado
Essa operação é disparada quando há registros recém-criados.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de objeto Salesforce
|
table | True | string |
O tipo de objeto Salesforce, como 'Leads'. |
|
Filtrar Consulta
|
$filter | string |
Uma consulta de filtro ODATA para restringir as entradas retornadas (por exemplo, stringColumn eq 'string' OR numberColumn lt 123). |
|
|
Ordenar por
|
$orderby | string |
Uma consulta orderBy do ODATA para especificar a ordem das entradas. |
|
|
Selecionar Consulta
|
$select | string |
Campos específicos a serem recuperados de entradas (padrão = todos). |
Retornos
Quando um registro é modificado
Essa operação é disparada quando há registros recém-modificados.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de objeto Salesforce
|
table | True | string |
O tipo de objeto Salesforce, como 'Leads'. |
|
Filtrar Consulta
|
$filter | string |
Uma consulta de filtro ODATA para restringir as entradas retornadas (por exemplo, stringColumn eq 'string' OR numberColumn lt 123). |
|
|
Ordenar por
|
$orderby | string |
Uma consulta orderBy do ODATA para especificar a ordem das entradas. |
|
|
Selecionar Consulta
|
$select | string |
Campos específicos a serem recuperados de entradas (padrão = todos). |
Retornos
Definições
CreateJobResponse
Saída da operação 'CreateJobV2'
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Object
|
object | string |
O tipo de objeto para os dados que estão sendo processados. |
|
Operation
|
operation | string |
A operação de processamento do trabalho. |
|
Delimitador de Colunas
|
columnDelimiter | string |
O delimitador de coluna usado para dados de trabalho CSV. |
|
Nome do campo de ID externa
|
externalIdFieldName | string |
O campo ID externa no objeto que está sendo atualizado. Necessário apenas para operações upsert. Os valores de campo também devem existir nos dados do trabalho CSV. |
|
Final da linha
|
lineEnding | string |
O final da linha usado para dados de trabalho CSV, marcando o fim de uma linha de dados. |
|
Tipo de conteúdo
|
contentType | string |
O tipo de conteúdo do trabalho. |
|
Versão da API
|
apiVersion | float |
A versão da API na qual o trabalho foi criado. |
|
Modo de simultaneidade
|
concurrencyMode | string |
O modo de simultaneidade para o trabalho. |
|
URL de Conteúdo
|
contentUrl | string |
A URL a ser usada para carregar solicitações de dados de trabalho para este trabalho. Válido somente se o trabalho estiver no estado "Abrir". |
|
Criado por ID
|
createdById | string |
A ID do usuário que criou o trabalho. |
|
Data de criação
|
createdDate | date-time |
A data e a hora no fuso horário UTC quando o trabalho foi criado. |
|
ID
|
id | string |
ID exclusiva para este trabalho. |
|
Tipo de Trabalho
|
jobType | string |
O tipo do trabalho. |
|
Estado
|
state | string |
O estado atual do processamento para o trabalho. |
|
Modstamp do sistema
|
systemModstamp | date-time |
Data e hora no fuso horário UTC quando o trabalho terminou. |
Table
Representa uma tabela.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome
|
Name | string |
O nome da tabela. O nome é usado no runtime. |
|
DisplayName
|
DisplayName | string |
O nome de exibição da tabela. |
|
DynamicProperties
|
DynamicProperties | object |
Propriedades de tabela adicionais fornecidas pelo conector para os clientes. |
TablesList
Representa uma lista de tabelas.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
value
|
value | array of Table |
Lista de tabelas |
GetAllJobsResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído
|
done | boolean |
Concluído |
|
arquivo
|
records | array of JobInfo | |
|
Próxima URL Recorada
|
nextRecordUrl | string |
PRÓXIMA URL de Registro |
JobInfo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Versão da API
|
apiVersion | float |
Versão da API |
|
Delimitador de Colunas
|
columnDelimiter | string |
Delimitador de Colunas |
|
Modo de simultaneidade
|
concurrencyMode | string |
Modo de simultaneidade |
|
Tipo de conteúdo
|
contentType | string |
Tipo de conteúdo |
|
URL de conteúdo
|
contentUrl | string |
URL de conteúdo |
|
Criado por ID
|
createdById | string |
Criado por ID |
|
Data de criação
|
createdDate | date-time |
Data de criação |
|
Nome do campo de ID externa
|
externalIdFieldName | string |
Nome do campo de ID externa |
|
ID
|
id | string |
ID |
|
Tipo de Trabalho
|
jobType | string |
Tipo de Trabalho |
|
Final da linha
|
lineEnding | string |
Final da linha |
|
Object
|
object | string |
Object |
|
Operation
|
operation | string |
Operation |
|
Estado
|
state | string |
Estado |
|
Carimbo de Mod do Sistema
|
systemModstamp | date-time |
Carimbo de Mod do Sistema |
CheckJobResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Tempo de processamento do APEX
|
apexProcessingTime | number |
Tempo de processamento do APEX |
|
Tempo de processamento ativo da API
|
apiActiveProcessingTime | number |
Tempo de processamento ativo da API |
|
Versão da API
|
apiVersion | float |
Versão da API |
|
Delimitador de Colunas
|
columnDelimiter | string |
Delimitador de Colunas |
|
Modo de simultaneidade
|
concurrencyMode | string |
Modo de simultaneidade |
|
Tipo de conteúdo
|
contentType | string |
Tipo de conteúdo |
|
URL de conteúdo
|
contentUrl | string |
URL de conteúdo |
|
Criado por ID
|
createdById | string |
Criado por ID |
|
Data de criação
|
createdDate | date-time |
Data de criação |
|
Nome do campo externo
|
externalFieldName | string |
Nome do campo externo |
|
ID
|
id | string |
ID |
|
Tipo de Trabalho
|
jobType | string |
Tipo de Trabalho |
|
Final da linha
|
lineEnding | string |
Final da linha |
|
Object
|
object | string |
Object |
|
Operation
|
operation | string |
Operation |
|
Repetições
|
retries | number |
Repetições |
|
Estado
|
state | string |
Estado |
|
systemModStamp
|
systemModStamp | date-time | |
|
Tempo total de processamento
|
totalProcessingTime | number |
Tempo total de processamento |
SOSLSearchQueryResponse
Resposta da consulta de pesquisa SOSL
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
searchRecords
|
searchRecords | array of SearchRecordObject |
Uma lista de registros de pesquisa retornados por uma consulta de pesquisa SOSL |
SearchRecordObject
Registro individual retornado pela consulta SOSL
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
attributes.type | string |
Tipo do registro |
|
url
|
attributes.url | string |
Caminho da API que pode ser usado para recuperar o objeto |
|
ID
|
Id | string |
Identificador exclusivo do registro |
ObjectWithoutType
MCPQueryResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
jsonrpc
|
jsonrpc | string | |
|
id
|
id | string | |
|
método
|
method | string | |
|
parâmetros
|
params | object | |
|
resultado
|
result | object | |
|
erro
|
error | object |
cadeia
Esse é o tipo de dados básico 'string'.
objeto
Esse é o tipo 'object'.