Задачи: типовые сценарии

Сценарий описывает одну практическую задачу и порядок методов для ее выполнения. Сценарии помогают создать задачу с файлом, прикрепить файл к существующей задаче, перенести файл из CRM, добавить комментарий с вложением, связать задачу со смарт-процессом, посчитать время сотрудников и передать задачи уволенного сотрудника

Быстрый переход: все сценарии

Пользовательская документация: Задачи в Битрикс24

Связь с другими объектамиСвязь с другими объектами

Сценарии строятся вокруг задачи и связанных с ней объектов: файлов Диска, комментариев и CRM. Создание и получение задач выполняет группа методов tasks.task.*.

• Файлы Диска. Чтобы прикрепить файл к задаче, сначала загрузите его на Диск методом disk.folder.uploadFile. Полученный ID объекта Диска передайте в поле UF_TASK_WEBDAV_FILES метода tasks.task.add или в параметр fileId метода tasks.task.files.attach, если задача уже создана. Формат значения для поля и метода различается

• Комментарии. Комментарии задачи хранятся в чате задачи. Чтобы добавить комментарий с файлом, получите chatId задачи методом tasks.task.get и отправьте файл с текстом сообщения методом im.v2.File.upload. Метод task.commentitem.add продолжает добавлять комментарий, но его развитие остановлено с версии модуля tasks 25.700.0

• CRM и смарт-процессы. Задача связывается с объектами CRM через поле UF_CRM_TASK метода tasks.task.add. Для смарт-процесса значение имеет формат SYMBOL_CODE_SHORT_id, например Tb1_29: код типа возвращает crm.enum.ownertype, а id элемента — crm.item.list. Порядок действий описан в сценарии привязки

Как начать работуКак начать работу

1. Определите сценарий: создать задачу с файлом, прикрепить файл с Диска или из CRM, добавить комментарий с файлом, связать задачу со смарт-процессом, посчитать затраченное время или передать задачи уволенного сотрудника
2. Выберите сценарий в таблице Как выбрать сценарий
3. Проверьте, какие права и scopes указаны в выбранном сценарии
4. Подготовьте данные из колонки «Что подготовить» выбранного сценария
5. Выполните методы в порядке, который описан в сценарии

Что важно учитыватьЧто важно учитывать

• Для методов задач нужен scope task. Для загрузки файла на Диск дополнительно нужен disk, для переноса файла из CRM и привязки смарт-процесса — crm. Для комментария с файлом через чат задачи нужен im, а disk не нужен. Для сценариев с сотрудниками нужны user_brief или user_basic в зависимости от способа поиска. Точный набор указан в начале каждого туториала
• Методы выполняются с правами пользователя приложения или вебхука. Для работы с существующей задачей проверьте доступ к ней; для файлов Диска — право добавления в папку и чтения файла; для комментария — доступ к чату задачи; для поиска элемента CRM — право чтения объекта CRM
• В поле UF_TASK_WEBDAV_FILES метода tasks.task.add передавайте массив с ID объекта Диска и префиксом n, например ["n6687"]. Без префикса файл может не появиться в задаче. В параметр fileId метода tasks.task.files.attach передавайте тот же ID числом без n, например 6687: значение с префиксом не подходит для числового параметра. В обоих случаях не подставляйте FILE_ID из ответа Диска вместо ID
• Если в UF_CRM_TASK вместо SYMBOL_CODE_SHORT передать entityTypeId или код другого типа, задача может создаться без ошибки, но поле ufCrmTask останется пустым. Такое же поведение возможно, если смарт-процесс не подключен к задачам. Проверьте привязку методом tasks.task.get с полем UF_CRM_TASK в select, а настройку linkedUserFields — по сценарию привязки

Как выбрать сценарийКак выбрать сценарий