Salesforce
Работайте с Salesforce CRM
Инструмент Salesforce позволяет напрямую подключаться к вашему Salesforce CRM и выполнять широкий набор операций по управлению взаимоотношениями с клиентами в рамках ваших воркфлоу. Благодаря бесшовной и безопасной интеграции вы можете эффективно работать с ключевыми бизнес-процессами в данных по продажам, поддержке и маркетингу и автоматизировать их.
Инструмент Salesforce позволяет:
- Получение аккаунтов: используйте операцию
salesforce_get_accounts для получения Account из Salesforce с пользовательскими фильтрами, сортировкой и выбором полей.
- Создание аккаунтов: автоматически добавляйте новые Account в Salesforce через операцию
salesforce_create_account, указывая такие данные, как имя, отрасль и платёжный адрес.
- Управление контактами: (при наличии — аналогичный набор инструментов доступен и для Contacts: добавление, обновление или получение контактов по необходимости.)
- Работа с лидами и сделками: встраивайте управление лидами и сделками в ваш воркфлоу, чтобы агенты могли фиксировать, квалифицировать и обновлять данные в воронке продаж.
- Отслеживание кейсов и задач: автоматизируйте клиентскую поддержку и follow-up, взаимодействуя с Case и Task в Salesforce.
Инструмент Salesforce идеально подходит для воркфлоу, в которых ваши AI-агенты упорядочивают продажи, ведение аккаунтов, генерацию лидов и поддержку. Независимо от того, синхронизируют ли агенты данные между платформами, предоставляют ли инсайты о клиентах в реальном времени или автоматизируют рутинные обновления CRM — инструмент Salesforce приносит всю мощь и расширяемость Salesforce в ваши программные процессы, управляемые агентами.
Интегрируйте Salesforce в ваш рабочий процесс. Управлять accounts, contacts, leads, opportunities, cases, и tasks с powerful automation capabilities.
Получитьccounts from Salesforce CRM
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | ID token from Salesforce OAuth (contains instance URL) |
instanceUrl | string | Нет | Salesforce instance URL |
limit | string | Нет | Maximum number of results (default: 100, max: 2000) |
fields | string | Нет | Comma-separated field API names (e.g., "Id,Name,Industry,Phone") |
orderBy | string | Нет | Field and direction for sorting (e.g., "Name ASC" or "CreatedDate DESC") |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Accounts data |
↳ paging | object | Pagination information from Salesforce API |
↳ nextRecordsUrl | string | URL to fetch the next batch of records (present when done is false) |
↳ totalSize | number | Total number of records matching the query (may exceed records returned) |
↳ done | boolean | Whether all records have been returned (false if more batches exist) |
↳ metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records exist (inverse of done) |
↳ accounts | array | Массив account objects |
↳ success | boolean | Salesforce operation success |
Создать новый account in Salesforce CRM
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | No description |
instanceUrl | string | Нет | No description |
name | string | Да | Account name (required) |
type | string | Нет | Account type (e.g., Customer, Partner, Prospect) |
industry | string | Нет | Industry (e.g., Technology, Healthcare, Finance) |
phone | string | Нет | Phone number |
website | string | Нет | Website URL |
billingStreet | string | Нет | Billing street address |
billingCity | string | Нет | Billing city |
billingState | string | Нет | Billing state/province |
billingPostalCode | string | Нет | Billing postal code |
billingCountry | string | Нет | Billing country |
description | string | Нет | Account description |
annualRevenue | string | Нет | Annual revenue as a number |
numberOfEmployees | string | Нет | Number of employees as an integer |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Created account data |
↳ id | string | The Salesforce ID of the newly created record |
↳ success | boolean | Произошла ли create operation was successful |
↳ created | boolean | Произошла ли record was created (always true on success) |
Обновитьn existing account in Salesforce CRM
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | No description |
instanceUrl | string | Нет | No description |
accountId | string | Да | Salesforce Account ID to update (18-character string starting with 001) |
name | string | Нет | Account name |
type | string | Нет | Account type (e.g., Customer, Partner, Prospect) |
industry | string | Нет | Industry (e.g., Technology, Healthcare, Finance) |
phone | string | Нет | Phone number |
website | string | Нет | Website URL |
billingStreet | string | Нет | Billing street address |
billingCity | string | Нет | Billing city |
billingState | string | Нет | Billing state/province |
billingPostalCode | string | Нет | Billing postal code |
billingCountry | string | Нет | Billing country |
description | string | Нет | Account description |
annualRevenue | string | Нет | Annual revenue as a number |
numberOfEmployees | string | Нет | Number of employees as an integer |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Updated account data |
↳ id | string | The Salesforce ID of the updated record |
↳ updated | boolean | Произошла ли record was updated (always true on success) |
Удалитьn account from Salesforce CRM
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | No description |
instanceUrl | string | Нет | No description |
accountId | string | Да | Salesforce Account ID to delete (18-character string starting with 001) |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Deleted account data |
↳ id | string | The Salesforce ID of the deleted record |
↳ deleted | boolean | Произошла ли record was deleted (always true on success) |
Получить contact(s) from Salesforce - single contact if ID provided, или list if not
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | No description |
instanceUrl | string | Нет | No description |
contactId | string | Нет | Salesforce Contact ID (18-character string starting with 003) to get a single contact |
limit | string | Нет | Maximum number of results (default: 100, max: 2000). Only for list query. |
fields | string | Нет | Comma-separated field API names (e.g., "Id,FirstName,LastName,Email,Phone") |
orderBy | string | Нет | Field and direction for sorting (e.g., "LastName ASC"). Only for list query. |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Contact(s) data |
↳ paging | object | Pagination information from Salesforce API |
↳ nextRecordsUrl | string | URL to fetch the next batch of records (present when done is false) |
↳ totalSize | number | Total number of records matching the query (may exceed records returned) |
↳ done | boolean | Whether all records have been returned (false if more batches exist) |
↳ metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records exist (inverse of done) |
↳ contacts | array | Массив contacts (list query) |
↳ contact | object | Single contact (by ID) |
↳ singleContact | boolean | Whether single contact was returned |
↳ success | boolean | Salesforce operation success |
Создать новый contact in Salesforce CRM
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | No description |
instanceUrl | string | Нет | No description |
lastName | string | Да | Last name (required) |
firstName | string | Нет | First name |
email | string | Нет | Email address |
phone | string | Нет | Phone number |
accountId | string | Нет | Salesforce Account ID (18-character string starting with 001) |
title | string | Нет | No description |
department | string | Нет | Department |
mailingStreet | string | Нет | Mailing street |
mailingCity | string | Нет | Mailing city |
mailingState | string | Нет | Mailing state |
mailingPostalCode | string | Нет | Mailing postal code |
mailingCountry | string | Нет | Mailing country |
description | string | Нет | Contact description |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Created contact data |
↳ id | string | The Salesforce ID of the newly created record |
↳ success | boolean | Произошла ли create operation was successful |
↳ created | boolean | Произошла ли record was created (always true on success) |
Обновитьn existing contact in Salesforce CRM
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | No description |
instanceUrl | string | Нет | No description |
contactId | string | Да | Salesforce Contact ID to update (18-character string starting with 003) |
lastName | string | Нет | Last name |
firstName | string | Нет | First name |
email | string | Нет | Email address |
phone | string | Нет | Phone number |
accountId | string | Нет | Salesforce Account ID (18-character string starting with 001) |
title | string | Нет | No description |
department | string | Нет | Department |
mailingStreet | string | Нет | Mailing street |
mailingCity | string | Нет | Mailing city |
mailingState | string | Нет | Mailing state |
mailingPostalCode | string | Нет | Mailing postal code |
mailingCountry | string | Нет | Mailing country |
description | string | Нет | Contact description |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Updated contact data |
↳ id | string | The Salesforce ID of the updated record |
↳ updated | boolean | Произошла ли record was updated (always true on success) |
Удалить contact from Salesforce CRM
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | No description |
instanceUrl | string | Нет | No description |
contactId | string | Да | Salesforce Contact ID to delete (18-character string starting with 003) |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Deleted contact data |
↳ id | string | The Salesforce ID of the deleted record |
↳ deleted | boolean | Произошла ли record was deleted (always true on success) |
Получить lead(s) from Salesforce
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | No description |
instanceUrl | string | Нет | No description |
leadId | string | Нет | Salesforce Lead ID (18-character string starting with 00Q) to get a single lead |
limit | string | Нет | Maximum number of results to return (default: 100) |
fields | string | Нет | Comma-separated list of field API names to return |
orderBy | string | Нет | Field and direction for sorting (e.g., LastName ASC) |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Lead data |
↳ paging | object | Pagination information from Salesforce API |
↳ nextRecordsUrl | string | URL to fetch the next batch of records (present when done is false) |
↳ totalSize | number | Total number of records matching the query (may exceed records returned) |
↳ done | boolean | Whether all records have been returned (false if more batches exist) |
↳ metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records exist (inverse of done) |
↳ lead | object | Single lead object (when leadId provided) |
↳ leads | array | Массив lead objects (when listing) |
↳ singleLead | boolean | Whether single lead was returned |
↳ success | boolean | Operation success status |
Создать новый lead
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | No description |
instanceUrl | string | Нет | No description |
lastName | string | Да | Last name (required) |
company | string | Да | Company name (required) |
firstName | string | Нет | First name |
email | string | Нет | Email address |
phone | string | Нет | Phone number |
status | string | Нет | Lead status (e.g., Open, Working, Closed) |
leadSource | string | Нет | Lead source (e.g., Web, Referral, Campaign) |
title | string | Нет | No description |
description | string | Нет | Lead description |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Created lead data |
↳ id | string | The Salesforce ID of the newly created record |
↳ success | boolean | Произошла ли create operation was successful |
↳ created | boolean | Произошла ли record was created (always true on success) |
Обновитьn existing lead
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | No description |
instanceUrl | string | Нет | No description |
leadId | string | Да | Salesforce Lead ID to update (18-character string starting with 00Q) |
lastName | string | Нет | Last name |
company | string | Нет | Company name |
firstName | string | Нет | First name |
email | string | Нет | Email address |
phone | string | Нет | Phone number |
status | string | Нет | Lead status (e.g., Open, Working, Closed) |
leadSource | string | Нет | Lead source (e.g., Web, Referral, Campaign) |
title | string | Нет | No description |
description | string | Нет | Lead description |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Updated lead data |
↳ id | string | The Salesforce ID of the updated record |
↳ updated | boolean | Произошла ли record was updated (always true on success) |
Удалить lead
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | No description |
instanceUrl | string | Нет | No description |
leadId | string | Да | Salesforce Lead ID to delete (18-character string starting with 00Q) |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Deleted lead data |
↳ id | string | The Salesforce ID of the deleted record |
↳ deleted | boolean | Произошла ли record was deleted (always true on success) |
Получить opportunity(ies) from Salesforce
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | No description |
instanceUrl | string | Нет | No description |
opportunityId | string | Нет | Salesforce Opportunity ID (18-character string starting with 006) to get a single opportunity |
limit | string | Нет | Maximum number of results to return (default: 100) |
fields | string | Нет | Comma-separated list of field API names to return |
orderBy | string | Нет | Field and direction for sorting (e.g., CloseDate DESC) |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Opportunity data |
↳ paging | object | Pagination information from Salesforce API |
↳ nextRecordsUrl | string | URL to fetch the next batch of records (present when done is false) |
↳ totalSize | number | Total number of records matching the query (may exceed records returned) |
↳ done | boolean | Whether all records have been returned (false if more batches exist) |
↳ metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records exist (inverse of done) |
↳ opportunity | object | Single opportunity object (when opportunityId provided) |
↳ opportunities | array | Массив opportunity objects (when listing) |
↳ success | boolean | Operation success status |
Создать новый opportunity
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | No description |
instanceUrl | string | Нет | No description |
name | string | Да | Opportunity name (required) |
stageName | string | Да | Stage name (required, e.g., Prospecting, Qualification, Closed Won) |
closeDate | string | Да | Close date in YYYY-MM-DD format (required) |
accountId | string | Нет | Salesforce Account ID (18-character string starting with 001) |
amount | string | Нет | Deal amount as a number |
probability | string | Нет | Win probability as integer (0-100) |
description | string | Нет | Opportunity description |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Created opportunity data |
↳ id | string | The Salesforce ID of the newly created record |
↳ success | boolean | Произошла ли create operation was successful |
↳ created | boolean | Произошла ли record was created (always true on success) |
Обновитьn existing opportunity
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | No description |
instanceUrl | string | Нет | No description |
opportunityId | string | Да | Salesforce Opportunity ID to update (18-character string starting with 006) |
name | string | Нет | Opportunity name |
stageName | string | Нет | Stage name (e.g., Prospecting, Qualification, Closed Won) |
closeDate | string | Нет | Close date in YYYY-MM-DD format |
accountId | string | Нет | Salesforce Account ID (18-character string starting with 001) |
amount | string | Нет | Deal amount as a number |
probability | string | Нет | Win probability as integer (0-100) |
description | string | Нет | Opportunity description |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Updated opportunity data |
↳ id | string | The Salesforce ID of the updated record |
↳ updated | boolean | Произошла ли record was updated (always true on success) |
Удалитьn opportunity
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | No description |
instanceUrl | string | Нет | No description |
opportunityId | string | Да | Salesforce Opportunity ID to delete (18-character string starting with 006) |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Deleted opportunity data |
↳ id | string | The Salesforce ID of the deleted record |
↳ deleted | boolean | Произошла ли record was deleted (always true on success) |
Получить case(s) from Salesforce
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | No description |
instanceUrl | string | Нет | No description |
caseId | string | Нет | Salesforce Case ID (18-character string starting with 500) to get a single case |
limit | string | Нет | Maximum number of results to return (default: 100) |
fields | string | Нет | Comma-separated list of field API names to return |
orderBy | string | Нет | Field and direction for sorting (e.g., CreatedDate DESC) |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Case data |
↳ paging | object | Pagination information from Salesforce API |
↳ nextRecordsUrl | string | URL to fetch the next batch of records (present when done is false) |
↳ totalSize | number | Total number of records matching the query (may exceed records returned) |
↳ done | boolean | Whether all records have been returned (false if more batches exist) |
↳ metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records exist (inverse of done) |
↳ case | object | Single case object (when caseId provided) |
↳ cases | array | Массив case objects (when listing) |
↳ success | boolean | Operation success status |
Создать новый case
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | No description |
instanceUrl | string | Нет | No description |
subject | string | Да | Case subject (required) |
status | string | Нет | Status (e.g., New, Working, Escalated) |
priority | string | Нет | Priority (e.g., Low, Medium, High) |
origin | string | Нет | Origin (e.g., Phone, Email, Web) |
contactId | string | Нет | Salesforce Contact ID (18-character string starting with 003) |
accountId | string | Нет | Salesforce Account ID (18-character string starting with 001) |
description | string | Нет | Case description |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Created case data |
↳ id | string | The Salesforce ID of the newly created record |
↳ success | boolean | Произошла ли create operation was successful |
↳ created | boolean | Произошла ли record was created (always true on success) |
Обновитьn existing case
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | No description |
instanceUrl | string | Нет | No description |
caseId | string | Да | Salesforce Case ID to update (18-character string starting with 500) |
subject | string | Нет | Case subject |
status | string | Нет | Status (e.g., New, Working, Escalated, Closed) |
priority | string | Нет | Priority (e.g., Low, Medium, High) |
description | string | Нет | Case description |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Updated case data |
↳ id | string | The Salesforce ID of the updated record |
↳ updated | boolean | Произошла ли record was updated (always true on success) |
Удалить case
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | No description |
instanceUrl | string | Нет | No description |
caseId | string | Да | Salesforce Case ID to delete (18-character string starting with 500) |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Deleted case data |
↳ id | string | The Salesforce ID of the deleted record |
↳ deleted | boolean | Произошла ли record was deleted (always true on success) |
Получить task(s) from Salesforce
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | No description |
instanceUrl | string | Нет | No description |
taskId | string | Нет | Salesforce Task ID (18-character string starting with 00T) to get a single task |
limit | string | Нет | Maximum number of results to return (default: 100) |
fields | string | Нет | Comma-separated list of field API names to return |
orderBy | string | Нет | Field and direction for sorting (e.g., ActivityDate DESC) |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Task data |
↳ paging | object | Pagination information from Salesforce API |
↳ nextRecordsUrl | string | URL to fetch the next batch of records (present when done is false) |
↳ totalSize | number | Total number of records matching the query (may exceed records returned) |
↳ done | boolean | Whether all records have been returned (false if more batches exist) |
↳ metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records exist (inverse of done) |
↳ task | object | Single task object (when taskId provided) |
↳ tasks | array | Массив task objects (when listing) |
↳ success | boolean | Operation success status |
Создать новый task
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | No description |
instanceUrl | string | Нет | No description |
subject | string | Да | Task subject (required) |
status | string | Нет | Status (e.g., Not Started, In Progress, Completed) |
priority | string | Нет | Priority (e.g., Low, Normal, High) |
activityDate | string | Нет | Due date in YYYY-MM-DD format |
whoId | string | Нет | Related Contact ID (003...) or Lead ID (00Q...) |
whatId | string | Нет | Related Account ID (001...) or Opportunity ID (006...) |
description | string | Нет | Task description |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Created task data |
↳ id | string | The Salesforce ID of the newly created record |
↳ success | boolean | Произошла ли create operation was successful |
↳ created | boolean | Произошла ли record was created (always true on success) |
Обновитьn existing task
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | No description |
instanceUrl | string | Нет | No description |
taskId | string | Да | Salesforce Task ID to update (18-character string starting with 00T) |
subject | string | Нет | Task subject |
status | string | Нет | Status (e.g., Not Started, In Progress, Completed) |
priority | string | Нет | Priority (e.g., Low, Normal, High) |
activityDate | string | Нет | Due date in YYYY-MM-DD format |
description | string | Нет | Task description |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Updated task data |
↳ id | string | The Salesforce ID of the updated record |
↳ updated | boolean | Произошла ли record was updated (always true on success) |
Удалить task
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | No description |
instanceUrl | string | Нет | No description |
taskId | string | Да | Salesforce Task ID to delete (18-character string starting with 00T) |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Deleted task data |
↳ id | string | The Salesforce ID of the deleted record |
↳ deleted | boolean | Произошла ли record was deleted (always true on success) |
Получить список reports accessible by the current user
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | No description |
instanceUrl | string | Нет | No description |
folderName | string | Нет | Filter reports by folder name (case-insensitive partial match) |
searchTerm | string | Нет | Search term to filter reports by name or description |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Reports data |
↳ totalReturned | number | Number of items returned |
↳ success | boolean | Salesforce operation success |
↳ reports | array | Массив report objects |
Получить metadata и describe information для a specific report
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | No description |
instanceUrl | string | Нет | No description |
reportId | string | Да | Salesforce Report ID (18-character string starting with 00O) |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Report metadata |
↳ report | object | Report metadata object |
↳ reportId | string | Report ID |
↳ success | boolean | Salesforce operation success |
Выполнить a report и retrieve the results
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | No description |
instanceUrl | string | Нет | No description |
reportId | string | Да | Salesforce Report ID (18-character string starting with 00O) |
includeDetails | string | Нет | Include detail rows (true/false, default: true) |
filters | string | Нет | JSON array of report filter objects to apply |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Report results |
↳ reportId | string | Report ID |
↳ reportMetadata | object | Report metadata including name, format, and filter definitions |
↳ reportExtendedMetadata | object | Extended metadata for aggregate columns and groupings |
↳ factMap | object | Report data organized by groupings with aggregates and row data |
↳ groupingsDown | object | Row grouping hierarchy and values |
↳ groupingsAcross | object | Column grouping hierarchy and values |
↳ hasDetailRows | boolean | Произошла ли report includes detail-level row data |
↳ allData | boolean | Whether all data is returned (false if truncated due to size limits) |
↳ reportName | string | Display name of the report |
↳ reportFormat | string | Report format type (TABULAR, SUMMARY, MATRIX, JOINED) |
↳ success | boolean | Salesforce operation success |
Получить список available report types
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | No description |
instanceUrl | string | Нет | No description |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Report types data |
↳ totalReturned | number | Number of items returned |
↳ success | boolean | Salesforce operation success |
↳ reportTypes | array | Массив report type objects |
Получить список dashboards accessible by the current user
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | No description |
instanceUrl | string | Нет | No description |
folderName | string | Нет | Filter dashboards by folder name (case-insensitive partial match) |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Dashboards data |
↳ totalReturned | number | Number of items returned |
↳ success | boolean | Salesforce operation success |
↳ dashboards | array | Массив dashboard objects |
Получить details и results для a specific dashboard
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | No description |
instanceUrl | string | Нет | No description |
dashboardId | string | Да | Salesforce Dashboard ID (18-character string starting with 01Z) |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Dashboard data |
↳ dashboard | object | Full dashboard details object |
↳ dashboardId | string | Dashboard ID |
↳ components | array | Массив dashboard component data with visualizations and filters |
↳ dashboardName | string | Display name of the dashboard |
↳ folderId | string | ID of the folder containing the dashboard |
↳ runningUser | object | User context under which the dashboard data was retrieved |
↳ success | boolean | Salesforce operation success |
Refresh a dashboard to get the latest data
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | No description |
instanceUrl | string | Нет | No description |
dashboardId | string | Да | Salesforce Dashboard ID (18-character string starting with 01Z) |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Refreshed dashboard data |
↳ dashboard | object | Full dashboard details object |
↳ dashboardId | string | Dashboard ID |
↳ components | array | Массив dashboard component data with fresh visualizations |
↳ status | object | Dashboard refresh status information |
↳ dashboardName | string | Display name of the dashboard |
↳ refreshDate | string | ISO 8601 timestamp when the dashboard was last refreshed |
↳ success | boolean | Salesforce operation success |
Выполнить a custom SOQL запрос to retrieve data from Salesforce
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | No description |
instanceUrl | string | Нет | No description |
query | string | Да | SOQL query to execute (e.g., SELECT Id, Name FROM Account LIMIT 10) |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Query results |
↳ records | array | Массив sObject records matching the query |
↳ query | string | The executed SOQL query |
↳ metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records exist (inverse of done) |
↳ success | boolean | Salesforce operation success |
Получитьdditional запрос results using the nextRecordsUrl from a previous запрос
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | No description |
instanceUrl | string | Нет | No description |
nextRecordsUrl | string | Да | The nextRecordsUrl value from a previous query response (e.g., /services/data/v59.0/query/01g...) |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Query results |
↳ records | array | Массив sObject records matching the query |
↳ metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records exist (inverse of done) |
↳ success | boolean | Salesforce operation success |
Получить metadata и field information для a Salesforce object
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | No description |
instanceUrl | string | Нет | No description |
objectName | string | Да | Salesforce object API name (e.g., Account, Contact, Lead, Custom_Object__c) |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Object metadata |
↳ objectName | string | API name of the object (e.g., Account, Contact) |
↳ label | string | Human-readable singular label for the object |
↳ labelPlural | string | Human-readable plural label for the object |
↳ fields | array | Массив field metadata objects |
↳ name | string | API name of the field |
↳ label | string | Display label of the field |
↳ type | string | Field data type (string, boolean, int, double, date, etc.) |
↳ length | number | Maximum length for text fields |
↳ precision | number | Precision for numeric fields |
↳ scale | number | Scale for numeric fields |
↳ nillable | boolean | Произошла ли field can be null |
↳ unique | boolean | Whether values must be unique |
↳ createable | boolean | Whether field can be set on create |
↳ updateable | boolean | Whether field can be updated |
↳ defaultedOnCreate | boolean | Whether field has default value on create |
↳ calculated | boolean | Whether field is a formula field |
↳ autoNumber | boolean | Whether field is auto-number |
↳ externalId | boolean | Whether field is an external ID |
↳ idLookup | boolean | Whether field can be used in ID lookup |
↳ inlineHelpText | string | Help text for the field |
↳ picklistValues | array | Available picklist values for picklist fields |
↳ referenceTo | array | Objects this field can reference (for lookup fields) |
↳ relationshipName | string | Relationship name for lookup fields |
↳ custom | boolean | Произошла ли эта is a custom field |
↳ filterable | boolean | Whether field can be used in SOQL filter |
↳ groupable | boolean | Whether field can be used in GROUP BY |
↳ sortable | boolean | Whether field can be used in ORDER BY |
↳ keyPrefix | string | Three-character prefix used in record IDs (e.g., "001" for Account) |
↳ queryable | boolean | Произошла ли object can be queried via SOQL |
↳ createable | boolean | Whether records can be created for this object |
↳ updateable | boolean | Whether records can be updated for this object |
↳ deletable | boolean | Whether records can be deleted for this object |
↳ childRelationships | array | Массив child relationship metadata for related objects |
↳ recordTypeInfos | array | Массив record type information for the object |
↳ fieldCount | number | Total number of fields on the object |
↳ success | boolean | Salesforce operation success |
Получить список all available Salesforce objects
| Параметр | Тип | Обязательный | Описание |
|---|
idToken | string | Нет | No description |
instanceUrl | string | Нет | No description |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Objects list |
↳ objects | array | Массив sObject metadata |
↳ name | string | API name of the object |
↳ label | string | Display label of the object |
↳ labelPlural | string | Plural display label |
↳ keyPrefix | string | Three-character ID prefix |
↳ custom | boolean | Произошла ли эта is a custom object |
↳ queryable | boolean | Whether object can be queried |
↳ createable | boolean | Whether records can be created |
↳ updateable | boolean | Whether records can be updated |
↳ deletable | boolean | Whether records can be deleted |
↳ searchable | boolean | Whether object is searchable |
↳ triggerable | boolean | Whether triggers are supported |
↳ layoutable | boolean | Whether page layouts are supported |
↳ replicateable | boolean | Whether object can be replicated |
↳ retrieveable | boolean | Whether records can be retrieved |
↳ undeletable | boolean | Whether records can be undeleted |
↳ urls | object | URLs for accessing object resources |
↳ encoding | string | Character encoding for the organization (e.g., UTF-8) |
↳ maxBatchSize | number | Maximum number of records that can be returned in a single query batch (typically 200) |
↳ totalReturned | number | Number of objects returned |
↳ success | boolean | Salesforce operation success |