Salesforce
Соединитель Salesforce предоставляет API для работы с объектами Salesforce.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Class | Регионы |
|---|---|---|
| Copilot Studio | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet |
| Логические приложения | Стандарт | Все регионы Logic Apps |
| Power Apps | Премия | Все регионы Power Apps , кроме следующих: - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet |
| Power Automate | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet |
| Метаданные соединителя | |
|---|---|
| Publisher | Microsoft |
Чтобы использовать эту интеграцию, вам потребуется доступ к учетной записи Salesforce с включенным доступом к API. Чтобы узнать, какие выпуски Salesforce имеют доступ к API, ознакомьтесь со статьей Salesforce. Чтобы сделать подключение, нажмите кнопку "Войти". Вам будет предложено указать имя входа Salesforce, следуйте остальным экранам, чтобы создать подключение. Версия API по умолчанию, используемая соединителем, — версии 58.0.
Теперь вы готовы начать использовать эту интеграцию.
Замечание
Соединитель Salesforce теперь доступен в Microsoft CoPilot Studio.
Известные проблемы и ограничения
- Существует ограничение на количество полей, которые может содержать запрос к Salesforce. Ограничение зависит от типа столбцов, количества вычисляемых столбцов и т. д. При получении ошибки "Запрос либо выбирает слишком много полей, либо условия фильтра слишком сложны", это означает, что ваш запрос превышает ограничение. Чтобы избежать этого, используйте расширенный параметр Select Query и укажите нужные поля.
- Параметры сеанса Salesforce могут блокировать эту интеграцию. Убедитесь, что параметр "Блокировать сеансы на IP-адрес, из которого они были созданы", отключен.
- Необходимо включить доступ к API Salesforce. Чтобы проверить параметры доступа, перейдите к параметрам профиля для текущего пользователя и установите флажок "Включено API".
- У учетных записей пробной версии Salesforce нет доступа к API, поэтому их нельзя использовать.
- Пользовательские поля типа Picklist (Multi-Select)" не поддерживаются действиями создания записи и записи обновления (V3) (включая соответствующие устаревшие версии).
- Создание нового подключения с помощью входа Salesforce "Личный домен" не поддерживается.
- Использование полей, допускающих значение NULL в
Order Byпараметре, следует избежать, так как это может привести к ошибке среды выполнения в следующих операциях: получение записей при создании или изменении записи. - Если триггер изменения записи может обнаружить только изменение записи стандартного объекта, но не может обнаружить изменение вложения стандартного объекта.
- Следующие триггеры и действия не смогли правильно работать в пользовательских таблицах без столбца Id: при создании записи при создании или изменениизаписи Get, Create record, Update record (V3), Delete record.
- При создании или изменении триггера записи возвращаются как новые, так и измененные элементы. Чтобы проверить, является ли возвращенный элемент новым или измененным, сравните значения полей CreatedDate и LastModifiedDate. В новых элементах эти значения, как ожидается, будут равны. В этом отношении оба поля являются обязательными для элементов, для которых применяется этот триггер.
- Сложные объекты (объекты с вложенными объектами, см. пример ниже) не поддерживаются записью create и update record (V3) (включая соответствующие устаревшие версии). Чтобы обойти это ограничение, следует использовать неструктурированные структуры объектов.
- Выполнение запроса SOQL и действия получения записей основаны на API запросов. Поэтому не все записи могут быть возвращены из-за ограничений API (например, удаленных элементов).
- Если возникла проблема с получением значения по умолчанию для набора данных с помощью записи обновления (V3), это связано с заголовком "sforce-auto-assign" значение true. Чтобы обойти эту проблему, рекомендуется использовать действие HTTP-запроса и задать настраиваемое значение заголовка как sforce-auto-assign: false.
- Соединитель Salesforce имеет специальную обработку для проверки подлинности, однако из-за ограничения серверной части Salesforce маркеры будут истекать, если они не используются в течение длительного времени, и пользователи могут столкнуться с ошибкой "Bad_OAuth_Token/Сеанс истек или недопустим". Повторно войдите с помощью учетных данных.
- Это ограничение теперь устранено, однако для использования необходимо создать новое подключение. Предварительно существующее подключение по-прежнему будет работать, но может возникнуть следующая проблема.
Пример сложного объекта, который не поддерживается, так как он содержит вложенный объект с полем MerchandiseExtID__c:
{
"Name" : "LineItemCreatedViaExtID",
"Merchandise__r" :
{
"MerchandiseExtID__c" : 123
}
}
Пример приведенного выше сложного объекта, переопределенного как неструктурированный объект, поддерживаемый is:
{
"Name" : "LineItemCreatedViaExtID",
"MerchandiseExtID__c" : 123
}
Отправка вложений
API Salesforce поддерживает отправку вложений для следующих объектов: Account, Asset, "Campaign", "Case", "Contact", "Contract", "Custom objects", "EmailMessage", "EmailTemplate", "Event", "Lead", "Opportunity", "Product2", "Solution", "Task". Чтобы отправить файл вложения, используйте действие "Создать запись " и перейдите на страницу документации Salesforce о обязательных полях и параметрах.
Делегированные функции и операции Power Apps для Salesforce
Эти операции Power Apps для заданного типа данных могут быть делегированы Salesforce для обработки (а не локальной обработки в Power Apps).
Функции верхнего уровня
| Делегируемый | |
|---|---|
| Среднее значение | нет |
| Filter | Да |
| LookUp | Да |
| Max | нет |
| мин | нет |
| Искать | Да |
| Сортировать | Да |
| SortByColumns | Да |
| Сумма | нет |
Фильтрация и предикаты LookUp
| Salesforce | |
|---|---|
| Не | Да |
| IsBlank | нет |
| TrimEnds | нет |
| Len | нет |
| +, - | нет |
| <, <=, =, <>, >>, = | Да |
| И (&> или (||), не (!) | Да |
| в | Да |
| StartsWith | нет |
Подробное описание соединителя
Дополнительные сведения о соединителе см. в подробном разделе.
Общие ограничения
| Имя | Ценность |
|---|---|
| Максимальное количество запросов, обрабатываемых соединителем одновременно | 50 |
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| Вход с помощью пользовательского URI для входа Salesforce | Вход с помощью пользовательского URI для входа Salesforce | Только правительство США (GCC) | Доступный для общего пользования |
| Вход с помощью учетной записи Salesforce | Укажите учетные данные Salesforce для входа. | Все регионы | Доступный для общего пользования |
| По умолчанию [не рекомендуется] | Этот параметр предназначен только для старых подключений без явного типа проверки подлинности и предоставляется только для обратной совместимости. | Все регионы | Недоступен для совместного использования |
Вход с помощью пользовательского URI для входа Salesforce
Идентификатор проверки подлинности: CustomLoginURIAuth
Применимо: только правительство США (GCC)
Вход с помощью пользовательского URI для входа Salesforce
Это совместное подключение. Если приложение power app предоставлено другому пользователю, подключение также предоставляется совместно. Дополнительные сведения см. в обзоре соединителей для приложений на основе холста — Power Apps | Документация Майкрософт
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Универсальный код ресурса (URI) для входа Salesforce | струна | https://custom-domain-or-instance.my.salesforce.com | True |
| Версия API Salesforce | струна | Версия API Salesforce. По умолчанию оставьте пустым или используйте версию 58.0. |
Вход с помощью учетной записи Salesforce
Идентификатор проверки подлинности: BasicAuthentication
Применимо: все регионы
Укажите учетные данные Salesforce для входа.
Это совместное подключение. Если приложение power app предоставлено другому пользователю, подключение также предоставляется совместно. Дополнительные сведения см. в обзоре соединителей для приложений на основе холста — Power Apps | Документация Майкрософт
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| URI входа (среда) | струна | Универсальный код ресурса (URI) для входа Salesforce. Для рабочей среды оставьте пустым или используйте https://login.salesforce.com | |
| Версия API Salesforce | струна | Версия API Salesforce. По умолчанию оставьте пустым или используйте версию 58.0. |
По умолчанию [не рекомендуется]
Применимо: все регионы
Этот параметр предназначен только для старых подключений без явного типа проверки подлинности и предоставляется только для обратной совместимости.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| URI входа (среда) | струна | Универсальный код ресурса (URI) для входа Salesforce. Для рабочей среды оставьте пустым или используйте https://login.salesforce.com | |
| Версия API Salesforce | струна | Версия API Salesforce. По умолчанию оставьте пустым или используйте версию 58.0. |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 900 | 60 секунд |
Действия
| Вставка или обновление (Upsert) записи по внешнему идентификатору (V2) |
Эта операция вставляет или обновляет запись (upserts) с помощью внешнего идентификатора. |
| Вставка или обновление (Upsert) записи по внешнему идентификатору [DEPRECATED] |
Это действие устарело. Вместо этого используйте вставку или обновление (Upsert) запись по внешнему идентификатору (V2).
|
| Выполнение запроса SOQL |
Выполнение запроса SOQL. |
| Выполнение запроса поиска SOSL |
Выполнение указанного запроса поиска SOSL |
| Закрытие или прерывание задания |
Закрывает или прерывает задание. Используйте UploadComplete для закрытия задания или прерывания задания. Если вы закрываете задание, Salesforce помещает задание и отправляет данные для обработки, и вы не можете добавить дополнительные данные задания. Если задание прерывается, задание не получается в очереди или не обрабатывается. |
| Запись обновления (версия 3) |
Эта операция обновляет запись и разрешает значения NULL. |
| Обновление записи [не рекомендуется] |
Это действие устарело. Вместо этого используйте запись обновления (V3 ).
|
| Обновление записи [не рекомендуется] |
Эта операция обновляет запись. |
| Отправка HTTP-запроса |
Создание запроса REST API Salesforce для вызова |
| Отправка данных задания |
Отправляет данные для задания с помощью CSV-данных. |
| Получение всех заданий |
Получение списка всех заданий |
| Получение записей |
Эта операция получает записи определенного типа объекта Salesforce, например "Потенциальные клиенты". |
| Получение записей Возможностей из Salesforce |
Эта операция получает записи Возможности из Salesforce. |
| Получение записей дела из Salesforce |
Эта операция получает записи case из Salesforce. |
| Получение записей контактов из Salesforce |
Эта операция получает записи контактов из Salesforce. |
| Получение записей о продукте из Salesforce |
Эта операция получает записи о продукте из Salesforce. |
| Получение записей пользователей из Salesforce |
Эта операция получает записи пользователей из Salesforce. |
| Получение записей учетной записи из Salesforce |
Эта операция получает записи учетной записи из Salesforce. |
| Получение записи |
Эта операция получает запись. |
| Получение записи [DEPRECATED] |
Это действие устарело. Вместо этого используйте запись Get .
|
| Получение записи по внешнему идентификатору |
Эта операция извлекает запись с помощью внешнего идентификатора. |
| Получение результатов задания |
Извлекает список записей на основе типа результата для завершенного задания. |
| Получение сведений о задании |
Извлекает подробные сведения о задании. |
| Получение типов объектов |
Эта операция содержит список доступных типов объектов Salesforce. |
| Сервер MCP для Salesforce |
Сервер MCP для Salesforce |
| Создание задания (версия 2) |
Создает задание, представляющее массовую операцию (и связанные данные), которая отправляется в Salesforce для асинхронной обработки. Предоставьте данные задания с помощью запроса на отправку данных задания. |
| Создание задания [НЕ РЕКОМЕНДУЕТСЯ] |
Это действие устарело. Вместо этого используйте задание (V2).
|
| Создание записи |
Эта операция создает запись и разрешает значения NULL. |
| Создание записи [DEPRECATED] |
Эта операция создает запись. |
| Удаление записи |
Эта операция удаляет запись. |
| Удалите задание |
Удаляет задание. Чтобы удалить, задание должно иметь состояние UploadComplete, JobComplete, Aborted или Failed. |
Вставка или обновление (Upsert) записи по внешнему идентификатору (V2)
Эта операция вставляет или обновляет запись (upserts) с помощью внешнего идентификатора.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Тип объекта Salesforce
|
table | True | string |
Тип объекта Salesforce, например "Потенциальные клиенты". |
|
Поле внешнего идентификатора
|
externalIdField | True | string |
Поле помечено как внешнее поле идентификатора в объекте Salesforce. |
|
Внешний идентификатор
|
externalId | True | string |
Внешний идентификатор записи для upsert. |
|
Запись
|
item | True | dynamic |
Запись с измененными свойствами. |
Возвращаемое значение
Вставка или обновление (Upsert) записи по внешнему идентификатору [DEPRECATED]
Это действие устарело. Вместо этого используйте вставку или обновление (Upsert) запись по внешнему идентификатору (V2).
Эта операция вставляет или обновляет запись (upserts) с помощью внешнего идентификатора.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Тип объекта Salesforce
|
table | True | string |
Тип объекта Salesforce, например "Потенциальные клиенты". |
|
Поле внешнего идентификатора
|
externalIdField | True | string |
Поле помечено как внешнее поле идентификатора в объекте Salesforce. |
|
Внешний идентификатор
|
externalId | True | string |
Внешний идентификатор записи для upsert. |
|
Запись
|
item | True | dynamic |
Запись с измененными свойствами. |
Возвращаемое значение
Выполнение запроса SOQL
Выполнение запроса SOQL.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Запрос SOQL
|
query | True | string |
Текст запроса SOQL. Динамические параметры можно указать с помощью синтаксиса @paramName. |
|
Параметры запроса
|
parameters | object |
Динамические параметры запроса SOQL. Ключ — это имя параметра (без "@" при знаке), значение — значение параметра. |
Возвращаемое значение
- response
- object
Выполнение запроса поиска SOSL
Выполнение указанного запроса поиска SOSL
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Строка поиска SOSL
|
q | True | string |
Строка поиска SOSL |
Возвращаемое значение
Ответ запроса поиска SOSL
Закрытие или прерывание задания
Закрывает или прерывает задание. Используйте UploadComplete для закрытия задания или прерывания задания. Если вы закрываете задание, Salesforce помещает задание и отправляет данные для обработки, и вы не можете добавить дополнительные данные задания. Если задание прерывается, задание не получается в очереди или не обрабатывается.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор задания
|
jobId | True | string |
Идентификатор задания |
|
государство
|
state | True | string |
государство |
Возвращаемое значение
- Тело
- JobInfo
Запись обновления (версия 3)
Эта операция обновляет запись и разрешает значения NULL.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Тип объекта Salesforce
|
table | True | string |
Имя таблицы |
|
Идентификатор записи
|
id | True | string |
Ключ элемента |
|
Элемент для обновления
|
item | True | dynamic |
Элемент для обновления |
|
Выбор запроса
|
$select | string |
Определенные поля для извлечения из записей (по умолчанию = все). |
Возвращаемое значение
Обновление записи [не рекомендуется]
Это действие устарело. Вместо этого используйте запись обновления (V3 ).
Эта операция обновляет запись и разрешает значения NULL.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Тип объекта Salesforce
|
table | True | string |
Имя таблицы |
|
Идентификатор записи
|
id | True | string |
Ключ элемента |
|
Элемент для обновления
|
item | True | dynamic |
Элемент для обновления |
|
Выбор запроса
|
$select | string |
Определенные поля для извлечения из записей (по умолчанию = все). |
Возвращаемое значение
Обновление записи [не рекомендуется]
Эта операция обновляет запись.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Тип объекта Salesforce
|
table | True | string |
Тип объекта Salesforce, например "Потенциальные клиенты". |
|
Идентификатор записи
|
id | True | string |
Уникальный идентификатор записи для обновления. |
|
Запись
|
item | True | dynamic |
Запись с измененными свойствами. |
Возвращаемое значение
Отправка HTTP-запроса
Создание запроса REST API Salesforce для вызова
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
URI
|
Uri | True | string |
Полный или относительный универсальный код ресурса (URI). Пример относительного URI: /services/data/v41.0/sobjects/account |
|
Метод
|
Method | True | string |
Метод HTTP (по умолчанию — GET). |
|
Тело
|
Body | binary |
Содержимое текста запроса. |
|
|
Тип контента
|
ContentType | string |
Заголовок типа контента для текста (по умолчанию — application/json). |
|
|
CustomHeader1
|
CustomHeader1 | string |
Пользовательский заголовок 1. Укажите в формате: header-name: header-value |
|
|
CustomHeader2
|
CustomHeader2 | string |
Пользовательский заголовок 2. Укажите в формате: header-name: header-value |
|
|
CustomHeader3
|
CustomHeader3 | string |
Пользовательский заголовок 3. Укажите в формате: header-name: header-value |
|
|
CustomHeader4
|
CustomHeader4 | string |
Пользовательский заголовок 4. Укажите в формате: header-name: header-value |
|
|
CustomHeader5
|
CustomHeader5 | string |
Пользовательский заголовок 5. Укажите в формате: header-name: header-value |
Возвращаемое значение
- response
- ObjectWithoutType
Отправка данных задания
Отправляет данные для задания с помощью CSV-данных.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор задания
|
jobId | True | string |
Идентификатор задания |
|
Содержимое CSV-файла
|
body | True | binary |
Данные CSV для отправки |
Получение всех заданий
Получение списка всех заданий
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Режим параллелизма
|
concurrenyMode | string |
Режим параллелизма |
|
|
Включена блокирование PK
|
isPkChunkingEnabled | boolean |
Включена блокирование PK |
|
|
Тип задания
|
jobType | string |
Тип задания |
|
|
Указатель запросов
|
queryLocator | string |
Указатель запросов |
Возвращаемое значение
- Тело
- GetAllJobsResponse
Получение записей
Эта операция получает записи определенного типа объекта Salesforce, например "Потенциальные клиенты".
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Тип объекта Salesforce
|
table | True | string |
Тип объекта Salesforce, например "Потенциальные клиенты". |
|
Запрос фильтра
|
$filter | string |
Запрос фильтра ODATA для ограничения возвращаемых записей (например, stringColumn eq 'string' OR numberColumn lt 123). |
|
|
Заказ по
|
$orderby | string |
Запрос oDATA orderBy для указания порядка записей. |
|
|
Первое число
|
$top | integer |
Общее количество записей для получения (по умолчанию = все). |
|
|
Пропустить число
|
$skip | integer |
Количество пропускаемых записей (по умолчанию = 0). |
|
|
Выбор запроса
|
$select | string |
Определенные поля для извлечения из записей (по умолчанию = все). |
Возвращаемое значение
Получение записей Возможностей из Salesforce
Эта операция получает записи Возможности из Salesforce.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Запрос фильтра
|
$filter | string |
Запрос фильтра ODATA для ограничения возвращаемых записей (например, stringColumn eq 'string' OR numberColumn lt 123). |
|
|
Заказ по
|
$orderby | string |
Запрос oDATA orderBy для указания порядка записей. |
|
|
Первое число
|
$top | integer |
Общее количество записей для получения (по умолчанию = все). |
|
|
Пропустить число
|
$skip | integer |
Количество пропускаемых записей (по умолчанию = 0). |
|
|
Выбор запроса
|
$select | string |
Определенные поля для извлечения из записей (по умолчанию = все). |
Возвращаемое значение
Получение записей дела из Salesforce
Эта операция получает записи case из Salesforce.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Запрос фильтра
|
$filter | string |
Запрос фильтра ODATA для ограничения возвращаемых записей (например, stringColumn eq 'string' OR numberColumn lt 123). |
|
|
Заказ по
|
$orderby | string |
Запрос oDATA orderBy для указания порядка записей. |
|
|
Первое число
|
$top | integer |
Общее количество записей для получения (по умолчанию = все). |
|
|
Пропустить число
|
$skip | integer |
Количество пропускаемых записей (по умолчанию = 0). |
|
|
Выбор запроса
|
$select | string |
Определенные поля для извлечения из записей (по умолчанию = все). |
Возвращаемое значение
Получение записей контактов из Salesforce
Эта операция получает записи контактов из Salesforce.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Запрос фильтра
|
$filter | string |
Запрос фильтра ODATA для ограничения возвращаемых записей (например, stringColumn eq 'string' OR numberColumn lt 123). |
|
|
Заказ по
|
$orderby | string |
Запрос oDATA orderBy для указания порядка записей. |
|
|
Первое число
|
$top | integer |
Общее количество записей для получения (по умолчанию = все). |
|
|
Пропустить число
|
$skip | integer |
Количество пропускаемых записей (по умолчанию = 0). |
|
|
Выбор запроса
|
$select | string |
Определенные поля для извлечения из записей (по умолчанию = все). |
Возвращаемое значение
Получение записей о продукте из Salesforce
Эта операция получает записи о продукте из Salesforce.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Запрос фильтра
|
$filter | string |
Запрос фильтра ODATA для ограничения возвращаемых записей (например, stringColumn eq 'string' OR numberColumn lt 123). |
|
|
Заказ по
|
$orderby | string |
Запрос oDATA orderBy для указания порядка записей. |
|
|
Первое число
|
$top | integer |
Общее количество записей для получения (по умолчанию = все). |
|
|
Пропустить число
|
$skip | integer |
Количество пропускаемых записей (по умолчанию = 0). |
|
|
Выбор запроса
|
$select | string |
Определенные поля для извлечения из записей (по умолчанию = все). |
Возвращаемое значение
Получение записей пользователей из Salesforce
Эта операция получает записи пользователей из Salesforce.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Запрос фильтра
|
$filter | string |
Запрос фильтра ODATA для ограничения возвращаемых записей (например, stringColumn eq 'string' OR numberColumn lt 123). |
|
|
Заказ по
|
$orderby | string |
Запрос oDATA orderBy для указания порядка записей. |
|
|
Первое число
|
$top | integer |
Общее количество записей для получения (по умолчанию = все). |
|
|
Пропустить число
|
$skip | integer |
Количество пропускаемых записей (по умолчанию = 0). |
|
|
Выбор запроса
|
$select | string |
Определенные поля для извлечения из записей (по умолчанию = все). |
Возвращаемое значение
Получение записей учетной записи из Salesforce
Эта операция получает записи учетной записи из Salesforce.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Запрос фильтра
|
$filter | string |
Запрос фильтра ODATA для ограничения возвращаемых записей (например, stringColumn eq 'string' OR numberColumn lt 123). |
|
|
Заказ по
|
$orderby | string |
Запрос oDATA orderBy для указания порядка записей. |
|
|
Первое число
|
$top | integer |
Общее количество записей для получения (по умолчанию = все). |
|
|
Пропустить число
|
$skip | integer |
Количество пропускаемых записей (по умолчанию = 0). |
|
|
Выбор запроса
|
$select | string |
Определенные поля для извлечения из записей (по умолчанию = все). |
Возвращаемое значение
Получение записи
Эта операция получает запись.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Тип объекта Salesforce
|
table | True | string |
Имя таблицы |
|
Идентификатор записи
|
id | True | string |
Ключ элемента |
|
Выбор запроса
|
$select | string |
Определенные поля для извлечения из записей (по умолчанию = все). |
Возвращаемое значение
Получение записи [DEPRECATED]
Это действие устарело. Вместо этого используйте запись Get .
Эта операция получает запись.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
table
|
table | True | string | |
|
id
|
id | True | string |
Возвращаемое значение
Получение записи по внешнему идентификатору
Эта операция извлекает запись с помощью внешнего идентификатора.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Тип объекта Salesforce
|
table | True | string |
Тип объекта Salesforce, например "Потенциальные клиенты". |
|
Поле внешнего идентификатора
|
externalIdField | True | string |
Поле помечено как внешнее поле идентификатора в объекте Salesforce. |
|
Внешний идентификатор
|
externalId | True | string |
Внешний идентификатор извлекаемой записи. |
Возвращаемое значение
Получение результатов задания
Извлекает список записей на основе типа результата для завершенного задания.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор задания
|
jobId | True | string |
Идентификатор задания |
|
Тип результата
|
resultType | True | string |
Тип результата |
Возвращаемое значение
- response
- string
Получение сведений о задании
Извлекает подробные сведения о задании.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор задания
|
jobId | True | string |
Идентификатор задания |
Возвращаемое значение
- Тело
- CheckJobResponse
Получение типов объектов
Эта операция содержит список доступных типов объектов Salesforce.
Возвращаемое значение
Представляет список таблиц.
- Тело
- TablesList
Сервер MCP для Salesforce
Сервер MCP для Salesforce
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
jsonrpc
|
jsonrpc | string | ||
|
id
|
id | string | ||
|
method
|
method | string | ||
|
params
|
params | object | ||
|
результат
|
result | object | ||
|
ошибка
|
error | object | ||
|
идентификатор сессии
|
sessionId | string |
Возвращаемое значение
- Тело
- MCPQueryResponse
Создание задания (версия 2)
Создает задание, представляющее массовую операцию (и связанные данные), которая отправляется в Salesforce для асинхронной обработки. Предоставьте данные задания с помощью запроса на отправку данных задания.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Object
|
object | True | string |
Тип объекта для обрабатываемого данных. |
|
Операция
|
operation | True | string |
Операция обработки задания. |
|
Разделитель столбцов
|
columnDelimiter | string |
Разделитель столбцов, используемый для данных задания CSV. |
|
|
Имя поля внешнего идентификатора
|
externalIdFieldName | string |
Поле внешнего идентификатора в обновляемом объекте. Требуется только для операций upsert. Значения полей также должны существовать в данных задания CSV. |
|
|
Окончание строки
|
lineEnding | string |
Строка, используемая для данных задания CSV, помечающая конец строки данных. |
|
|
Тип контента
|
contentType | string |
Тип контента для задания. |
Возвращаемое значение
Выходные данные для операции CreateJobV2
- Тело
- CreateJobResponse
Создание задания [НЕ РЕКОМЕНДУЕТСЯ]
Это действие устарело. Вместо этого используйте задание (V2).
Создает задание, представляющее массовую операцию (и связанные данные), которая отправляется в Salesforce для асинхронной обработки. Предоставьте данные задания с помощью запроса на отправку данных задания.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Разделитель столбцов
|
columnDelimiter | string |
Разделитель столбцов |
|
|
Имя поля внешнего идентификатора
|
externalIdFieldName | string |
Имя поля внешнего идентификатора |
|
|
Окончание строки
|
lineEnding | string |
Окончание строки |
|
|
Object
|
object | True | string |
Object |
|
Операция
|
operation | True | string |
Операция |
Возвращаемое значение
- Тело
- JobInfo
Создание записи
Эта операция создает запись и разрешает значения NULL.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Тип объекта Salesforce
|
table | True | string |
Имя таблицы |
|
Запись
|
item | True | dynamic |
Запись |
Возвращаемое значение
Создание записи [DEPRECATED]
Эта операция создает запись.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Тип объекта Salesforce
|
table | True | string |
Тип объекта Salesforce, например "Потенциальные клиенты". |
|
Запись
|
item | True | dynamic |
Созданная запись. |
Возвращаемое значение
Удаление записи
Эта операция удаляет запись.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Тип объекта Salesforce
|
table | True | string |
Тип объекта Salesforce, например "Потенциальные клиенты". |
|
Идентификатор записи
|
id | True | string |
Уникальный идентификатор записи для удаления. |
Удалите задание
Удаляет задание. Чтобы удалить, задание должно иметь состояние UploadComplete, JobComplete, Aborted или Failed.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор задания
|
jobId | True | string |
Идентификатор задания |
Триггеры
| Изменение записи |
Эта операция активируется при наличии только что измененных записей. |
| При создании записи |
Эта операция активируется при создании записей. |
Изменение записи
Эта операция активируется при наличии только что измененных записей.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Тип объекта Salesforce
|
table | True | string |
Тип объекта Salesforce, например "Потенциальные клиенты". |
|
Запрос фильтра
|
$filter | string |
Запрос фильтра ODATA для ограничения возвращаемых записей (например, stringColumn eq 'string' OR numberColumn lt 123). |
|
|
Заказ по
|
$orderby | string |
Запрос oDATA orderBy для указания порядка записей. |
|
|
Выбор запроса
|
$select | string |
Определенные поля для извлечения из записей (по умолчанию = все). |
Возвращаемое значение
При создании записи
Эта операция активируется при создании записей.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Тип объекта Salesforce
|
table | True | string |
Тип объекта Salesforce, например "Потенциальные клиенты". |
|
Запрос фильтра
|
$filter | string |
Запрос фильтра ODATA для ограничения возвращаемых записей (например, stringColumn eq 'string' OR numberColumn lt 123). |
|
|
Заказ по
|
$orderby | string |
Запрос oDATA orderBy для указания порядка записей. |
|
|
Выбор запроса
|
$select | string |
Определенные поля для извлечения из записей (по умолчанию = все). |
Возвращаемое значение
Определения
CreateJobResponse
Выходные данные для операции CreateJobV2
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Object
|
object | string |
Тип объекта для обрабатываемого данных. |
|
Операция
|
operation | string |
Операция обработки задания. |
|
Разделитель столбцов
|
columnDelimiter | string |
Разделитель столбцов, используемый для данных задания CSV. |
|
Имя поля внешнего идентификатора
|
externalIdFieldName | string |
Поле внешнего идентификатора в обновляемом объекте. Требуется только для операций upsert. Значения полей также должны существовать в данных задания CSV. |
|
Окончание строки
|
lineEnding | string |
Строка, используемая для данных задания CSV, помечающая конец строки данных. |
|
Тип контента
|
contentType | string |
Тип контента для задания. |
|
Версия API
|
apiVersion | float |
Версия API, в которую было создано задание. |
|
Режим параллелизма
|
concurrencyMode | string |
Режим параллелизма для задания. |
|
URL-адрес содержимого
|
contentUrl | string |
URL-адрес, используемый для отправки запросов данных задания для этого задания. Допустимо только в том случае, если задание находится в состоянии Open. |
|
Создан идентификатором
|
createdById | string |
Идентификатор пользователя, создавшего задание. |
|
Дата создания
|
createdDate | date-time |
Дата и время в часовом поясе UTC при создании задания. |
|
Идентификатор
|
id | string |
Уникальный идентификатор для этого задания. |
|
Тип задания
|
jobType | string |
Тип задания. |
|
Государство
|
state | string |
Текущее состояние обработки задания. |
|
Системная метка модамп
|
systemModstamp | date-time |
Дата и время в часовом поясе UTC после завершения задания. |
Таблица
Представляет таблицу.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Имя
|
Name | string |
Название таблицы. Имя используется во время выполнения. |
|
Отображаемое имя
|
DisplayName | string |
Отображаемое имя таблицы. |
|
DynamicProperties
|
DynamicProperties | object |
Дополнительные свойства таблицы, предоставляемые соединителем клиентам. |
TablesList
Представляет список таблиц.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
value
|
value | array of Table |
Список таблиц |
GetAllJobsResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Выполнено
|
done | boolean |
Выполнено |
|
Записи
|
records | array of JobInfo | |
|
Следующий URL-адрес для перекореченного url-адреса
|
nextRecordUrl | string |
Следующий URL-адрес записи |
JobInfo
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Версия API
|
apiVersion | float |
Версия API |
|
Разделитель столбцов
|
columnDelimiter | string |
Разделитель столбцов |
|
Режим параллелизма
|
concurrencyMode | string |
Режим параллелизма |
|
Тип контента
|
contentType | string |
Тип контента |
|
URL-адрес содержимого
|
contentUrl | string |
URL-адрес содержимого |
|
Создан по идентификатору
|
createdById | string |
Создан по идентификатору |
|
Дата создания
|
createdDate | date-time |
Дата создания |
|
Имя поля внешнего идентификатора
|
externalIdFieldName | string |
Имя поля внешнего идентификатора |
|
Идентификатор
|
id | string |
Идентификатор |
|
Тип задания
|
jobType | string |
Тип задания |
|
Окончание строки
|
lineEnding | string |
Окончание строки |
|
Object
|
object | string |
Object |
|
Операция
|
operation | string |
Операция |
|
Государство
|
state | string |
Государство |
|
Метка мода системы
|
systemModstamp | date-time |
Метка мода системы |
CheckJobResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Время обработки APEX
|
apexProcessingTime | number |
Время обработки APEX |
|
Время активной обработки API
|
apiActiveProcessingTime | number |
Время активной обработки API |
|
Версия API
|
apiVersion | float |
Версия API |
|
Разделитель столбцов
|
columnDelimiter | string |
Разделитель столбцов |
|
Режим параллелизма
|
concurrencyMode | string |
Режим параллелизма |
|
Тип контента
|
contentType | string |
Тип контента |
|
URL-адрес содержимого
|
contentUrl | string |
URL-адрес содержимого |
|
Создан по идентификатору
|
createdById | string |
Создан по идентификатору |
|
Дата создания
|
createdDate | date-time |
Дата создания |
|
Имя внешнего поля
|
externalFieldName | string |
Имя внешнего поля |
|
Идентификатор
|
id | string |
Идентификатор |
|
Тип задания
|
jobType | string |
Тип задания |
|
Окончание строки
|
lineEnding | string |
Окончание строки |
|
Object
|
object | string |
Object |
|
Операция
|
operation | string |
Операция |
|
Повторные попытки
|
retries | number |
Повторные попытки |
|
Государство
|
state | string |
Государство |
|
systemModStamp
|
systemModStamp | date-time | |
|
Общее время обработки
|
totalProcessingTime | number |
Общее время обработки |
SOSLSearchQueryResponse
Ответ запроса поиска SOSL
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
searchRecords
|
searchRecords | array of SearchRecordObject |
Список записей поиска, возвращаемых запросом поиска SOSL |
SearchRecordObject
Отдельная запись, возвращаемая запросом SOSL
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
type
|
attributes.type | string |
Тип записи |
|
URL-адрес
|
attributes.url | string |
Путь API, который можно использовать для извлечения объекта |
|
Идентификатор
|
Id | string |
Уникальный идентификатор записи |
ObjectWithoutType
MCPQueryResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
jsonrpc
|
jsonrpc | string | |
|
id
|
id | string | |
|
method
|
method | string | |
|
params
|
params | object | |
|
результат
|
result | object | |
|
ошибка
|
error | object |
струна
Это базовый тип данных string.
объект
Это тип object.