Задачи

Задачи в системе Идеалист могут быть созданы администраторами подписки, либо пользователями с ролью apiclient через сторонние сервисы. Так же имеется недокументированное API для получения задач из системы Callmart, но в случае написание собственной интеграции необходимо использовать API /api/task.

Просмотр задач

Получить сохраненные в системе задачи можно с помощью API GET /api/task. На данный момент через GET-параметры поддерживаются следующие фильтры:

Ключ

Тип

Описание

task_type

List[str]

Тип задачи (Enum TaskType (str))

user_responsible

List[ObjectId]

Ответственный сотрудник

unit

List[ObjectId]

Связанная точка

mine

bool

Задачи, назначенные на текущего пользователя

Набор полей, описывающих задачу, перечислен с следующем разделе.

Создание задачи

Задачи создаются с помощью POST /api/task. В корне JSON-объекта запроса должны содержаться следующие поля:

Поле

Обязательное

Тип

Описание

name

Да

str

Название задачи

type

Да

Enum TaskType (str)

Тип задачи

deadline

Да

datetime

Необходимая дата завершения задачи

description

Нет

str

Описание задачи

user_responsible

Нет

List[ObjectId]

Список ответственных за задачу пользователей

unit

Нет

ObjectId

Точка, к которой привязана задача

order

Нет

ObjectId

Продажа (визит), к которой привязана задача

client

Нет

ObjectId

Клиент, к которому привязана задача

Выполнение задачи

Для выполнения (закрытия) задачи необходимо использовать API PUT /api/task/<objectid:task>/close со следующими полями:

Поле

Обязательное

Тип

Описание

status

Да

Финальный Enum TaskStatus (str)

Статус задачи

comment

Нет

str

Комментарий к закрытию задачи

Структуры данных

Enum TaskType (str)

Значение

Описание

call

Звонок

sms

Отправка СМС

email

Отправка email

other

Другое (неизвестно)

Enum TaskStatus (str)

Значение

Финальный

Описание

processing

Нет

В обработке

cancelled

Да

Отменена

completed

Да

Успешно завершена