Методы для работы с задачами распределены по следующим группам:
- Задачи — Tasks
- Типы задач — TaskTypes
- Статусы задач — TaskStatuses
- Приоритеты задач — TaskPriorities
В публичном API проверяются права пользователя на Создание и Удаление задач.
Задачи — Tasks
Доступные версии: V1, V2, V3.
При работе с методами группы Tasks вам доступны следующие операции с документами:
- Получение информации о документах, прикрепленных к задаче.
- Прикрепление/открепление существующих в Case.one документов в задачу.
- Создание задачи с загруженным в Case.one документом или несколькими документами.
API V2 (V1):
- POST /api/v2/tasks — метод позволяет создать задачу:
- Задача создается одним запросом, даже если по названию задачи указаны дополнительные атрибуты
- Название задачи доступно выбрать только из соответствующего справочника, из уже существующих значений
- При создании задачи через API это попадает в историю задачи
- Можно создать задачу с прикреплением одного или нескольких документов:
- В исходящих параметрах запроса доступно передать идентификаторы всех документов, которые должны быть прикреплены к задаче
- Если в задаче есть хотя бы один документ, в ответе отображаются данные по каждому из указанных в запросе документах: идентификатор документа и название документа
- Можно не передавать:
- Файлы
- Ремайндеры
- PUT /api/v2/tasks/{id} — метод позволяет обновить задачу:
- Изменение задачи через API попадает в историю задачи
- Возможно прикрепить (или открепить) к задаче один или сразу несколько документов:
- В исходящих параметрах запроса доступно передать идентификаторы всех документов, которые должны быть прикреплены к задаче:
- Если в параметрах запроса передается пустой массив Documents, документы будут удалены из задачи
- Если в параметрах запроса для документа передается значение null, документы останутся без изменений
- Если включить в запрос параметры документов, которые нужно прикрепить к задаче:
- Новые документы будут прикреплены
- Существующие в задаче документы останутся без изменений
- Остальные документы, которых нет в запросе, будут откреплены
- В ответе отображаются данные по каждому из указанных в запросе документах: идентификатор документа и название документа.
- В исходящих параметрах запроса доступно передать идентификаторы всех документов, которые должны быть прикреплены к задаче:
- GET /api/v2/tasks/{id} — метод позволяет получить задачу по идентификатору:
- Просмотр задачи через API не попадает в историю задачи
- Если в задаче есть хотя бы один документ, в ответе отображаются данные по каждому документу:
- Идентификатор документа
- Название документа
- GET /api/v2/tasks — метод позволяет получить список задач:
- Возможна фильтрации по: делу, дате выполнения, ответственному
- Фильтрация по ответственному позволяет посмотреть задачи, назначенные на определенного пользователя или группу пользователей:
- Фильтрация выполняется по GUID (статистически уникальному 128-битный идентификатору)
- В результат фильтрации попадают только те задачи, у которых хотя бы один ответственный пользователь совпал по GUID
- При фильтрации по пользователю в результат не попадут задачи, назначенные на группу, в которую входит указанный пользователь, т.к. вхождение пользователя в группу не проверяется
- Если в задаче есть хотя бы один документ, в ответе отображаются данные по каждому документу:
- Идентификатор документа
- Название документа
- DELETE /api/v2/tasks/{id} — метод позволяет удалить задачу по идентификатору.
API V3:
- POST /api/v3/tasks — метод позволяет создать задачу с заполненными дополнительными атрибутами — работа с созданными полями выполняется через связку Тег — Значение (как и в методах работы с объектами).
- PUT /api/v3/tasks/{id} — метод позволяет обновить задачу с дополнительными атрибутами — работа с созданными полями выполняется через связку Тег — Значение (как и в методах работы с объектами).
- GET /api/v3/tasks/{id} — метод позволяет получить задачу с дополнительными атрибутами по идентификатору — работа с созданными полями выполняется через связку Тег — Значение (как и в методах работы с объектами).
Типы задач — TaskTypes
Доступные версии: V1, V2:
- GET /api/v2/taskTypes/{id} — метод позволяет получить подробную информацию по указанному типу задачи по идентификатору.
- GET /api/v2/taskTypes — метод позволяет получить список всех типов задач.
Статусы задач — TaskStatuses
Доступные версии: V1, V2:
- GET /api/v2/taskStatuses/{id} — метод позволяет получить подробную информацию по указанному статусу задачи по идентификатору.
- GET /api/v2/taskStatuses — метод позволяет получить список всех статусов задач.
Приоритеты задач — TaskPriorities
Доступные версии: V1, V2:
- GET /api/v2/taskPriorities/{id} — метод позволяет получить подробную информацию по указанному приоритету задачи по идентификатору.
- GET /api/v2/taskPriorities — метод позволяет получить список всех приоритетов задач.