Возвращает список документов выбранной сущности с ключевыми полями.
Для кого и какую проблему решает
Робот полезен для сотрудника, который собирает перечень документов выбранного заказа. Для обработки нужен полный набор ID, номеров и названий, а ручной перенос из карточки неудобен. Робот возвращает списки ключевых сведений о доступных документах указанной сущности.
Что делает и когда применять
Робот нужен для получения полного списка документов по вручную заданной сущности.
Что подготовить
Нужен установленный робот из приложения «CRM роботы 2.0 + AI» и право на настройку автоматизации нужной CRM-воронки или шаблона бизнес-процесса. Пользователю, от имени которого работает приложение, должны быть доступны выбранные CRM-элементы и нужное действие с ними.
Передайте тип и ID карточки заказа. Права на карточку и документы должны быть доступны подключению приложения; список документов не заменяет список произвольных вложений CRM.
Как настроить и использовать
- Откройте автоматизацию нужной сущности и выберите стадию, на которой нужен робот «Список документов выбранной сущности». В шаблоне бизнес-процесса добавьте одноимённое действие.
- Передайте тип и ID карточки заказа. Права на карточку и документы должны быть доступны подключению приложения; список документов не заменяет список произвольных вложений CRM.
- Заполните ID типа сущности, ID сущности. Для рабочего сценария подставьте значения полей документа или результаты предыдущих действий вместо учебных данных ниже.
- Проверьте обязательные поля и варианты выбора в таблице настроек. Сохраните действие и свяжите его результаты с дальнейшими условиями процесса.
- Выполните пробный запуск на отдельном учебном элементе. Проверьте статус и возвращённые данные; если действие не завершилось, разберите ошибку в журнале процесса до использования результата.
Параметры робота
Имена полей ниже совпадают с настройками действия. Значения из таблицы относятся к самому роботу; результаты предыдущих шагов выбирайте через подстановку значения в редакторе.
| Поле в настройках | Что передать | Обязательность и исходное значение |
|---|---|---|
ID типа сущности (entityTypeId) |
Формат: целое число. | Обязательно. Значение по умолчанию в настройках не задано |
ID сущности (entityId) |
Формат: целое число. | Обязательно. Значение по умолчанию в настройках не задано |
Учебный пример
Пример показывает способ настройки на вымышленных данных и ожидаемый смысл результата; это не отчёт о запуске на вашем портале.
- ID типа сущности (
entityTypeId):2. - ID сущности (
entityId):501.
Для двух доступных документов вернутся соответствующие ID и реквизиты с количеством 2. Ссылки скачивания требуют проверки доступа и готовности файла; наличие записи документа не гарантирует успешное скачивание любым получателем.
Какие данные возвращает и что делать дальше
| Результат | Какое значение получает следующий шаг |
|---|---|
ID документов (documentIds) |
целое число, несколько значений |
Номера документов (numbers) |
строка, несколько значений |
Названия документов (titles) |
строка, несколько значений |
Ссылки на скачивание (downloadUrls) |
строка, несколько значений |
ID шаблонов документов (templateIds) |
целое число, несколько значений |
Количество документов (documentsCount) |
целое число |
Статус выполнения (status) |
да/нет |
Обрабатывайте списки документов по согласованному порядку и проверяйте количество. Перед внешней отправкой проверьте нужный документ и доступ к его файлу отдельно.
Ошибки и ограничения
Проверяйте результат действия до следующего изменения карточки. Ошибка доступа, неверный идентификатор и отсутствие найденного элемента требуют разных веток процесса. Не подставляйте нулевой или пустой результат как идентификатор существующего документа.