Salesforce
Аккаунты, контакты, лиды и отчёты в Salesforce CRM
Salesforce — CRM (Customer Relationship Management — учёт клиентов и сделок): аккаунты, контакты, лиды, возможности, обращения, задачи, отчёты и дашборды.
С Salesforce в Pailot вы можете:
- Читать, создавать, обновлять и удалять аккаунты, контакты, лиды, возможности, обращения и задачи
- Смотреть и запускать отчёты, читать и обновлять дашборды
- Выполнять SOQL (Salesforce Object Query Language — язык запросов Salesforce) и дочитывать страницы
- Смотреть список объектов и метаданные полей
Нужен OAuth (вход по разрешению сервиса) Salesforce: idToken и instanceUrl. Блок ставят на холст как отдельный шаг или прикрепляют к агенту.
Получить аккаунты из Salesforce CRM.
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | ID-токен Salesforce OAuth (содержит URL инстанса) |
instanceUrl | string | Нет | URL инстанса Salesforce |
limit | string | Нет | Число результатов (по умолчанию 100, макс. 2000) |
fields | string | Нет | Поля через запятую (например "Id,Name,Industry,Phone") |
orderBy | string | Нет | Поле сортировки (например "Name ASC" или "CreatedDate DESC") |
| Параметр | Тип | Описание |
|---|
success | boolean | Операция успешна |
output | object | Данные аккаунтов |
↳ accounts | array | Массив аккаунтов |
↳ paging | object | Данные постраничного вывода |
↳ nextRecordsUrl | string | URL следующей страницы |
↳ totalSize | number | Всего записей |
↳ done | boolean | Все записи уже получены |
↳ nextRecordsUrl | string | URL следующей страницы |
↳ totalSize | number | Всего записей |
↳ done | boolean | Все записи уже получены |
↳ metadata | object | Метаданные ответа |
↳ totalReturned | number | Число возвращённых аккаунтов |
↳ hasMore | boolean | Есть ещё записи |
↳ totalReturned | number | Число возвращённых аккаунтов |
↳ hasMore | boolean | Есть ещё записи |
↳ success | boolean | Операция Salesforce успешна |
Создать аккаунт в Salesforce CRM.
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | Нет описания |
instanceUrl | string | Нет | Нет описания |
name | string | Да | Название аккаунта (обязательно) |
type | string | Нет | Тип аккаунта (например Customer, Partner, Prospect) |
industry | string | Нет | Отрасль (например Technology, Healthcare, Finance) |
phone | string | Нет | Телефон |
website | string | Нет | URL сайта |
billingStreet | string | Нет | Улица для счетов |
billingCity | string | Нет | Город для счетов |
billingState | string | Нет | Регион для счетов |
billingPostalCode | string | Нет | Индекс для счетов |
billingCountry | string | Нет | Страна для счетов |
description | string | Нет | Описание аккаунта |
annualRevenue | string | Нет | Годовая выручка (число) |
numberOfEmployees | string | Нет | Число сотрудников (число) |
| Параметр | Тип | Описание |
|---|
success | boolean | Операция успешна |
output | object | Данные созданного аккаунта |
↳ id | string | ID созданного аккаунта |
↳ success | boolean | Операция Salesforce успешна |
↳ created | boolean | Аккаунт создан |
Обновить аккаунт в Salesforce CRM.
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | Нет описания |
instanceUrl | string | Нет | Нет описания |
accountId | string | Да | ID аккаунта для обновления (обязательно) |
name | string | Нет | Название аккаунта |
type | string | Нет | Тип аккаунта |
industry | string | Нет | Отрасль |
phone | string | Нет | Телефон |
website | string | Нет | URL сайта |
billingStreet | string | Нет | Улица для счетов |
billingCity | string | Нет | Город для счетов |
billingState | string | Нет | Регион для счетов |
billingPostalCode | string | Нет | Индекс для счетов |
billingCountry | string | Нет | Страна для счетов |
description | string | Нет | Описание аккаунта |
annualRevenue | string | Нет | Годовая выручка (число) |
numberOfEmployees | string | Нет | Число сотрудников (число) |
| Параметр | Тип | Описание |
|---|
success | boolean | Операция успешна |
output | object | Данные обновлённого аккаунта |
↳ id | string | ID обновлённого аккаунта |
↳ updated | boolean | Аккаунт обновлён |
Удалить аккаунт из Salesforce CRM.
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | Нет описания |
instanceUrl | string | Нет | Нет описания |
accountId | string | Да | ID аккаунта для удаления (обязательно) |
| Параметр | Тип | Описание |
|---|
success | boolean | Операция успешна |
output | object | Данные удалённого аккаунта |
↳ id | string | ID удалённого аккаунта |
↳ deleted | boolean | Аккаунт удалён |
Контакты Salesforce: один по ID или список.
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | Нет описания |
instanceUrl | string | Нет | Нет описания |
contactId | string | Нет | ID контакта (если задан — один контакт) |
limit | string | Нет | Число результатов (по умолчанию 100, макс. 2000). Только для списка. |
fields | string | Нет | Поля через запятую (например "Id,FirstName,LastName,Email,Phone") |
orderBy | string | Нет | Поле сортировки (например "LastName ASC"). Только для списка. |
| Параметр | Тип | Описание |
|---|
success | boolean | Операция успешна |
output | object | Данные контакта(ов) |
↳ contacts | array | Массив контактов (список) |
↳ contact | object | Один контакт (по ID) |
↳ paging | object | Данные постраничного вывода |
↳ nextRecordsUrl | string | URL следующей страницы |
↳ totalSize | number | Всего записей |
↳ done | boolean | Все записи уже получены |
↳ nextRecordsUrl | string | URL следующей страницы |
↳ totalSize | number | Всего записей |
↳ done | boolean | Все записи уже получены |
↳ metadata | object | Метаданные ответа |
↳ totalReturned | number | Число возвращённых контактов |
↳ hasMore | boolean | Есть ещё записи |
↳ totalReturned | number | Число возвращённых контактов |
↳ hasMore | boolean | Есть ещё записи |
↳ singleContact | boolean | Вернули один контакт |
↳ success | boolean | Операция Salesforce успешна |
Создать контакт в Salesforce CRM.
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | Нет описания |
instanceUrl | string | Нет | Нет описания |
lastName | string | Да | Фамилия (обязательно) |
firstName | string | Нет | Имя |
email | string | Нет | Адрес email |
phone | string | Нет | Телефон |
accountId | string | Нет | ID аккаунта для связи с контактом |
title | string | Нет | Нет описания |
department | string | Нет | Отдел |
mailingStreet | string | Нет | Улица для корреспонденции |
mailingCity | string | Нет | Город для корреспонденции |
mailingState | string | Нет | Регион для корреспонденции |
mailingPostalCode | string | Нет | Индекс для корреспонденции |
mailingCountry | string | Нет | Страна для корреспонденции |
description | string | Нет | Описание контакта |
| Параметр | Тип | Описание |
|---|
success | boolean | Операция успешна |
output | object | Данные созданного контакта |
↳ id | string | ID созданного контакта |
↳ success | boolean | Операция Salesforce успешна |
↳ created | boolean | Контакт создан |
Обновить контакт в Salesforce CRM.
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | Нет описания |
instanceUrl | string | Нет | Нет описания |
contactId | string | Да | ID контакта для обновления (обязательно) |
lastName | string | Нет | Фамилия |
firstName | string | Нет | Имя |
email | string | Нет | Адрес email |
phone | string | Нет | Телефон |
accountId | string | Нет | ID аккаунта для связи |
title | string | Нет | Нет описания |
department | string | Нет | Отдел |
mailingStreet | string | Нет | Улица для корреспонденции |
mailingCity | string | Нет | Город для корреспонденции |
mailingState | string | Нет | Регион для корреспонденции |
mailingPostalCode | string | Нет | Индекс для корреспонденции |
mailingCountry | string | Нет | Страна для корреспонденции |
description | string | Нет | Описание |
| Параметр | Тип | Описание |
|---|
success | boolean | Операция успешна |
output | object | Данные обновлённого контакта |
↳ id | string | ID обновлённого контакта |
↳ updated | boolean | Контакт обновлён |
Удалить контакт из Salesforce CRM.
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | Нет описания |
instanceUrl | string | Нет | Нет описания |
contactId | string | Да | ID контакта для удаления (обязательно) |
| Параметр | Тип | Описание |
|---|
success | boolean | Операция успешна |
output | object | Данные удалённого контакта |
↳ id | string | ID удалённого контакта |
↳ deleted | boolean | Контакт удалён |
Лиды Salesforce.
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | Нет описания |
instanceUrl | string | Нет | Нет описания |
leadId | string | Нет | ID лида (необязательно) |
limit | string | Нет | Максимум результатов (по умолчанию 100) |
fields | string | Нет | Поля через запятую |
orderBy | string | Нет | Поле сортировки |
| Параметр | Тип | Описание |
|---|
success | boolean | Операция успешна |
output | object | Данные лида |
↳ lead | object | Один лид (если задан leadId) |
↳ leads | array | Массив лидов (список) |
↳ paging | object | Данные постраничного вывода |
↳ nextRecordsUrl | string | URL следующей страницы |
↳ totalSize | number | Всего записей |
↳ done | boolean | Все записи уже получены |
↳ nextRecordsUrl | string | URL следующей страницы |
↳ totalSize | number | Всего записей |
↳ done | boolean | Все записи уже получены |
↳ metadata | object | Метаданные ответа |
↳ totalReturned | number | Число возвращённых лидов |
↳ hasMore | boolean | Есть ещё записи |
↳ totalReturned | number | Число возвращённых лидов |
↳ hasMore | boolean | Есть ещё записи |
↳ singleLead | boolean | Вернули один лид |
↳ success | boolean | Операция успешна |
Создать лид.
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | Нет описания |
instanceUrl | string | Нет | Нет описания |
lastName | string | Да | Фамилия (обязательно) |
company | string | Да | Компания (обязательно) |
firstName | string | Нет | Имя |
email | string | Нет | Нет описания |
phone | string | Нет | Нет описания |
status | string | Нет | Статус лида |
leadSource | string | Нет | Источник лида |
title | string | Нет | Нет описания |
description | string | Нет | Описание |
| Параметр | Тип | Описание |
|---|
success | boolean | Операция успешна |
output | object | Данные созданного лида |
↳ id | string | ID созданного лида |
↳ success | boolean | Операция Salesforce успешна |
↳ created | boolean | Лид создан |
Обновить лид.
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | Нет описания |
instanceUrl | string | Нет | Нет описания |
leadId | string | Да | ID лида (обязательно) |
lastName | string | Нет | Фамилия |
company | string | Нет | Нет описания |
firstName | string | Нет | Имя |
email | string | Нет | Нет описания |
phone | string | Нет | Нет описания |
status | string | Нет | Статус лида |
leadSource | string | Нет | Источник лида |
title | string | Нет | Нет описания |
description | string | Нет | Описание |
| Параметр | Тип | Описание |
|---|
success | boolean | Операция успешна |
output | object | Данные обновлённого лида |
↳ id | string | ID обновлённого лида |
↳ updated | boolean | Лид обновлён |
Удалить лид.
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | Нет описания |
instanceUrl | string | Нет | Нет описания |
leadId | string | Да | ID лида (обязательно) |
| Параметр | Тип | Описание |
|---|
success | boolean | Операция успешна |
output | object | Данные удалённого лида |
↳ id | string | ID удалённого лида |
↳ deleted | boolean | Лид удалён |
Возможности Salesforce.
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | Нет описания |
instanceUrl | string | Нет | Нет описания |
opportunityId | string | Нет | ID возможности (необязательно) |
limit | string | Нет | Максимум результатов (по умолчанию 100) |
fields | string | Нет | Поля через запятую |
orderBy | string | Нет | Поле сортировки |
| Параметр | Тип | Описание |
|---|
success | boolean | Операция успешна |
output | object | Данные возможности |
↳ opportunity | object | Одна возможность (если задан opportunityId) |
↳ opportunities | array | Массив возможностей (список) |
↳ paging | object | Данные постраничного вывода |
↳ nextRecordsUrl | string | URL следующей страницы |
↳ totalSize | number | Всего записей |
↳ done | boolean | Все записи уже получены |
↳ nextRecordsUrl | string | URL следующей страницы |
↳ totalSize | number | Всего записей |
↳ done | boolean | Все записи уже получены |
↳ metadata | object | Метаданные ответа |
↳ totalReturned | number | Число возвращённых возможностей |
↳ hasMore | boolean | Есть ещё записи |
↳ totalReturned | number | Число возвращённых возможностей |
↳ hasMore | boolean | Есть ещё записи |
↳ success | boolean | Операция успешна |
Создать возможность.
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | Нет описания |
instanceUrl | string | Нет | Нет описания |
name | string | Да | Название возможности (обязательно) |
stageName | string | Да | Название этапа (обязательно) |
closeDate | string | Да | Дата закрытия YYYY-MM-DD (обязательно) |
accountId | string | Нет | ID аккаунта |
amount | string | Нет | Сумма (число) |
probability | string | Нет | Вероятность (0–100) |
description | string | Нет | Описание |
| Параметр | Тип | Описание |
|---|
success | boolean | Операция успешна |
output | object | Данные созданной возможности |
↳ id | string | ID созданной возможности |
↳ success | boolean | Операция Salesforce успешна |
↳ created | boolean | Возможность создана |
Обновить возможность.
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | Нет описания |
instanceUrl | string | Нет | Нет описания |
opportunityId | string | Да | ID возможности (обязательно) |
name | string | Нет | Название возможности |
stageName | string | Нет | Название этапа |
closeDate | string | Нет | Дата закрытия YYYY-MM-DD |
accountId | string | Нет | ID аккаунта |
amount | string | Нет | Нет описания |
probability | string | Нет | Вероятность (0–100) |
description | string | Нет | Описание |
| Параметр | Тип | Описание |
|---|
success | boolean | Операция успешна |
output | object | Данные обновлённой возможности |
↳ id | string | ID обновлённой возможности |
↳ updated | boolean | Возможность обновлена |
Удалить возможность.
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | Нет описания |
instanceUrl | string | Нет | Нет описания |
opportunityId | string | Да | ID возможности (обязательно) |
| Параметр | Тип | Описание |
|---|
success | boolean | Операция успешна |
output | object | Данные удалённой возможности |
↳ id | string | ID удалённой возможности |
↳ deleted | boolean | Возможность удалена |
Обращения Salesforce.
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | Нет описания |
instanceUrl | string | Нет | Нет описания |
caseId | string | Нет | ID обращения (необязательно) |
limit | string | Нет | Максимум результатов (по умолчанию 100) |
fields | string | Нет | Поля через запятую |
orderBy | string | Нет | Поле сортировки |
| Параметр | Тип | Описание |
|---|
success | boolean | Операция успешна |
output | object | Данные обращения |
↳ case | object | Одно обращение (если задан caseId) |
↳ cases | array | Массив обращений (список) |
↳ paging | object | Данные постраничного вывода |
↳ nextRecordsUrl | string | URL следующей страницы |
↳ totalSize | number | Всего записей |
↳ done | boolean | Все записи уже получены |
↳ nextRecordsUrl | string | URL следующей страницы |
↳ totalSize | number | Всего записей |
↳ done | boolean | Все записи уже получены |
↳ metadata | object | Метаданные ответа |
↳ totalReturned | number | Число возвращённых обращений |
↳ hasMore | boolean | Есть ещё записи |
↳ totalReturned | number | Число возвращённых обращений |
↳ hasMore | boolean | Есть ещё записи |
↳ success | boolean | Операция успешна |
Создать обращение.
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | Нет описания |
instanceUrl | string | Нет | Нет описания |
subject | string | Да | Тема обращения (обязательно) |
status | string | Нет | Статус (например New, Working, Escalated) |
priority | string | Нет | Приоритет (например Low, Medium, High) |
origin | string | Нет | Источник (например Phone, Email, Web) |
contactId | string | Нет | ID контакта |
accountId | string | Нет | ID аккаунта |
description | string | Нет | Описание |
| Параметр | Тип | Описание |
|---|
success | boolean | Операция успешна |
output | object | Данные созданного обращения |
↳ id | string | ID созданного обращения |
↳ success | boolean | Операция Salesforce успешна |
↳ created | boolean | Обращение создано |
Обновить обращение.
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | Нет описания |
instanceUrl | string | Нет | Нет описания |
caseId | string | Да | ID обращения (обязательно) |
subject | string | Нет | Тема обращения |
status | string | Нет | Статус |
priority | string | Нет | Приоритет |
description | string | Нет | Описание |
| Параметр | Тип | Описание |
|---|
success | boolean | Операция успешна |
output | object | Данные обновлённого обращения |
↳ id | string | ID обновлённого обращения |
↳ updated | boolean | Обращение обновлено |
Удалить обращение.
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | Нет описания |
instanceUrl | string | Нет | Нет описания |
caseId | string | Да | ID обращения (обязательно) |
| Параметр | Тип | Описание |
|---|
success | boolean | Операция успешна |
output | object | Данные удалённого обращения |
↳ id | string | ID удалённого обращения |
↳ deleted | boolean | Обращение удалено |
Задачи Salesforce.
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | Нет описания |
instanceUrl | string | Нет | Нет описания |
taskId | string | Нет | ID задачи (необязательно) |
limit | string | Нет | Максимум результатов (по умолчанию 100) |
fields | string | Нет | Поля через запятую |
orderBy | string | Нет | Поле сортировки |
| Параметр | Тип | Описание |
|---|
success | boolean | Операция успешна |
output | object | Данные задачи |
↳ task | object | Одна задача (если задан taskId) |
↳ tasks | array | Массив задач (список) |
↳ paging | object | Данные постраничного вывода |
↳ nextRecordsUrl | string | URL следующей страницы |
↳ totalSize | number | Всего записей |
↳ done | boolean | Все записи уже получены |
↳ nextRecordsUrl | string | URL следующей страницы |
↳ totalSize | number | Всего записей |
↳ done | boolean | Все записи уже получены |
↳ metadata | object | Метаданные ответа |
↳ totalReturned | number | Число возвращённых задач |
↳ hasMore | boolean | Есть ещё записи |
↳ totalReturned | number | Число возвращённых задач |
↳ hasMore | boolean | Есть ещё записи |
↳ success | boolean | Операция успешна |
Создать задачу.
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | Нет описания |
instanceUrl | string | Нет | Нет описания |
subject | string | Да | Тема задачи (обязательно) |
status | string | Нет | Статус (например Not Started, In Progress, Completed) |
priority | string | Нет | Приоритет (например Low, Normal, High) |
activityDate | string | Нет | Срок YYYY-MM-DD |
whoId | string | Нет | ID связанного контакта или лида |
whatId | string | Нет | ID связанного аккаунта или возможности |
description | string | Нет | Описание |
| Параметр | Тип | Описание |
|---|
success | boolean | Операция успешна |
output | object | Данные созданной задачи |
↳ id | string | ID созданной задачи |
↳ success | boolean | Операция Salesforce успешна |
↳ created | boolean | Задача создана |
Обновить задачу.
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | Нет описания |
instanceUrl | string | Нет | Нет описания |
taskId | string | Да | ID задачи (обязательно) |
subject | string | Нет | Тема задачи |
status | string | Нет | Статус |
priority | string | Нет | Приоритет |
activityDate | string | Нет | Срок YYYY-MM-DD |
description | string | Нет | Описание |
| Параметр | Тип | Описание |
|---|
success | boolean | Операция успешна |
output | object | Данные обновлённой задачи |
↳ id | string | ID обновлённой задачи |
↳ updated | boolean | Задача обновлена |
Удалить задачу.
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | Нет описания |
instanceUrl | string | Нет | Нет описания |
taskId | string | Да | ID задачи (обязательно) |
| Параметр | Тип | Описание |
|---|
success | boolean | Операция успешна |
output | object | Данные удалённой задачи |
↳ id | string | ID удалённой задачи |
↳ deleted | boolean | Задача удалена |
Список отчётов, доступных текущему пользователю.
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | Нет описания |
instanceUrl | string | Нет | Нет описания |
folderName | string | Нет | Фильтр по имени папки |
searchTerm | string | Нет | Поиск отчётов по имени |
| Параметр | Тип | Описание |
|---|
success | boolean | Операция успешна |
output | object | Данные отчётов |
↳ reports | array | Массив отчётов |
↳ totalReturned | number | Число возвращённых отчётов |
↳ success | boolean | Операция Salesforce успешна |
Метаданные конкретного отчёта.
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | Нет описания |
instanceUrl | string | Нет | Нет описания |
reportId | string | Да | ID отчёта (обязательно) |
| Параметр | Тип | Описание |
|---|
success | boolean | Операция успешна |
output | object | Метаданные отчёта |
↳ report | object | Объект метаданных отчёта |
↳ reportId | string | ID отчёта |
↳ success | boolean | Операция Salesforce успешна |
Выполнить отчёт и получить результат.
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | Нет описания |
instanceUrl | string | Нет | Нет описания |
reportId | string | Да | ID отчёта (обязательно) |
includeDetails | string | Нет | Включить детальные строки (true/false, по умолчанию true) |
filters | string | Нет | JSON-строка фильтров отчёта |
| Параметр | Тип | Описание |
|---|
success | boolean | Операция успешна |
output | object | Результаты отчёта |
↳ reportId | string | ID отчёта |
↳ reportMetadata | object | Метаданные отчёта |
↳ reportExtendedMetadata | object | Расширенные метаданные |
↳ factMap | object | Данные отчёта по группировкам |
↳ groupingsDown | object | Группировки строк |
↳ groupingsAcross | object | Группировки колонок |
↳ hasDetailRows | boolean | В отчёте есть детальные строки |
↳ allData | boolean | Вернули все данные |
↳ reportName | string | Название отчёта |
↳ reportFormat | string | Формат отчёта |
↳ success | boolean | Операция Salesforce успешна |
Список доступных типов отчётов.
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | Нет описания |
instanceUrl | string | Нет | Нет описания |
| Параметр | Тип | Описание |
|---|
success | boolean | Операция успешна |
output | object | Данные типов отчётов |
↳ reportTypes | array | Массив типов отчётов |
↳ totalReturned | number | Число типов отчётов |
↳ success | boolean | Операция Salesforce успешна |
Список дашбордов, доступных текущему пользователю.
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | Нет описания |
instanceUrl | string | Нет | Нет описания |
folderName | string | Нет | Фильтр по имени папки |
| Параметр | Тип | Описание |
|---|
success | boolean | Операция успешна |
output | object | Данные дашбордов |
↳ dashboards | array | Массив дашбордов |
↳ totalReturned | number | Число возвращённых дашбордов |
↳ success | boolean | Операция Salesforce успешна |
Данные и результаты дашборда.
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | Нет описания |
instanceUrl | string | Нет | Нет описания |
dashboardId | string | Да | ID дашборда (обязательно) |
| Параметр | Тип | Описание |
|---|
success | boolean | Операция успешна |
output | object | Данные дашборда |
↳ dashboard | object | Данные дашборда |
↳ dashboardId | string | ID дашборда |
↳ components | array | Данные компонентов дашборда |
↳ dashboardName | string | Название дашборда |
↳ folderId | string | ID папки с дашбордом |
↳ runningUser | object | Пользователь, от имени которого считают |
↳ success | boolean | Операция Salesforce успешна |
Обновить дашборд до актуальных данных.
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | Нет описания |
instanceUrl | string | Нет | Нет описания |
dashboardId | string | Да | ID дашборда (обязательно) |
| Параметр | Тип | Описание |
|---|
success | boolean | Операция успешна |
output | object | Обновлённые данные дашборда |
↳ dashboard | object | Данные дашборда |
↳ dashboardId | string | ID дашборда |
↳ components | array | Данные компонентов дашборда |
↳ status | object | Статус дашборда |
↳ dashboardName | string | Название дашборда |
↳ refreshDate | string | Когда дашборд обновили |
↳ success | boolean | Операция Salesforce успешна |
Выполнить произвольный запрос SOQL в Salesforce.
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | Нет описания |
instanceUrl | string | Нет | Нет описания |
query | string | Да | Запрос SOQL (например SELECT Id, Name FROM Account LIMIT 10) |
| Параметр | Тип | Описание |
|---|
success | boolean | Операция успешна |
output | object | Результаты запроса |
↳ records | array | Массив записей |
↳ totalSize | number | Всего записей по запросу |
↳ done | boolean | Все записи уже получены |
↳ nextRecordsUrl | string | URL следующей порции записей |
↳ query | string | Выполненный запрос SOQL |
↳ metadata | object | Метаданные ответа |
↳ totalReturned | number | Записей в этом ответе |
↳ hasMore | boolean | Есть ещё записи |
↳ totalReturned | number | Записей в этом ответе |
↳ hasMore | boolean | Есть ещё записи |
↳ success | boolean | Операция Salesforce успешна |
Дочитать результаты по nextRecordsUrl предыдущего запроса.
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | Нет описания |
instanceUrl | string | Нет | Нет описания |
nextRecordsUrl | string | Да | nextRecordsUrl из предыдущего ответа |
| Параметр | Тип | Описание |
|---|
success | boolean | Операция успешна |
output | object | Результаты запроса |
↳ records | array | Массив записей |
↳ totalSize | number | Всего записей по запросу |
↳ done | boolean | Все записи уже получены |
↳ nextRecordsUrl | string | URL следующей порции записей |
↳ metadata | object | Метаданные ответа |
↳ totalReturned | number | Записей в этом ответе |
↳ hasMore | boolean | Есть ещё записи |
↳ totalReturned | number | Записей в этом ответе |
↳ hasMore | boolean | Есть ещё записи |
↳ success | boolean | Операция Salesforce успешна |
Метаданные и поля объекта Salesforce.
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | Нет описания |
instanceUrl | string | Нет | Нет описания |
objectName | string | Да | Имя объекта в API (например Account, Contact, Lead, Custom_Object__c) |
| Параметр | Тип | Описание |
|---|
success | boolean | Операция успешна |
output | object | Метаданные объекта |
↳ objectName | string | Имя объекта в API |
↳ label | string | Отображаемая подпись |
↳ labelPlural | string | Подпись во множественном числе |
↳ fields | array | Определения полей |
↳ keyPrefix | string | Префикс ID этого типа объекта |
↳ queryable | boolean | Объект можно запрашивать |
↳ createable | boolean | Записи можно создавать |
↳ updateable | boolean | Записи можно обновлять |
↳ deletable | boolean | Записи можно удалять |
↳ childRelationships | array | Дочерние связи |
↳ recordTypeInfos | array | Типы записей |
↳ fieldCount | number | Число полей объекта |
↳ success | boolean | Операция Salesforce успешна |
Список всех доступных объектов Salesforce.
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | Нет описания |
instanceUrl | string | Нет | Нет описания |
| Параметр | Тип | Описание |
|---|
success | boolean | Операция успешна |
output | object | Список объектов |
↳ objects | array | Доступные объекты Salesforce |
↳ encoding | string | Использованная кодировка |
↳ maxBatchSize | number | Максимальный размер пакета |
↳ totalReturned | number | Число возвращённых объектов |
↳ success | boolean | Операция Salesforce успешна |
