Public API (публичный API) Case.one разработан специально для управления настройками, которые необходимы для:
- Интеграции со сторонними системами.
- Мобильных приложений.
- Скриптов в сценариях автоматизации.
Методы публичного API позволяют получать информацию, обновлять или удалять данные и создавать различные сущности в Case.one.
На текущий момент вы можете использовать методы публичного API v1, v2, v3 и v4 (подробнее о версиях см. в статье Как правильно выбрать версию API?).
Зона покрытия Public API функционала Case.one
| Функционал | Возможности |
| Авторизация | — Получение или обновление токена — Получение токена доступа с аутентификацией Windows |
| Основные настройки | — Получение нерабочих дней (конкретные даты и интервалы) (v3) — Обновление нерабочих дней (конкретные даты и интервалы) (v3) |
| Объекты | — Создание объекта — Обновление объекта — Редактирование объекта — Получение объекта по идентификатору — Получение списка объектов — Архивация объекта — Восстановление объекта из архива — Удаление объекта — Добавление участника в объект — Создание связанного объекта — Получение списка связанных объектов — Удаление связанного объекта — Получение дел любого типа с указанием параметров (v3) — Получение объектов любого типа с указанием параметров (v3) — Получение списка объектов, которые находятся в таблице, с информацией по каждому объекту |
| Типы объектов | — Получение типа объекта по идентификатору (v1, v2) — для метода v1 в ответе рассчитывается текущая дата и отдается в качестве значения по умолчанию — Получение списка типов объектов |
| Классы объектов | — Получение класса объекта по идентификатору — Получение списка классов объектов |
| Роли в деле | — Получение роли в деле по идентификатору — Получение всех ролей в деле |
| Папки | — Получение папки — Получение списка папок |
| Проекты | — Получение проекта — Получение списка проектов |
| События | — Создание события — Создание события (v3) — Обновление события — Обновление события (v3) — Получение события — Получение события (v3) — Получение списка событий — Удаление события — Получение информации по типу события — Получение списка типов событий |
| Задачи | — Создание задачи — Создание задачи с дополнительными атрибутами (v3) — Обновление задачи — Обновление задачи с дополнительными атрибутами (v3) — Получение задачи — Получение задачи с дополнительными атрибутами (v3) — Получение списка задач — Удаление задачи — Получение информации по типу задачи — Получение списка типов задач — Получение информации по статусу задачи — Получение списка статусов задач — Получение информации по приоритету задачи — Получение списка приоритетов задач |
| Документы | — Создание документа (v3) — Создание документа по шаблону (v3) — Обновление документа (v3) — Получение документа по идентификатору (v3) — Получение списка документов (v3) — Скачивание документа (v3) — Удаление документа (v3) — Скачивание файла документа в формате PDF для печати (с наложенной подписью) (v3) — Скачивание файла подписи документа (v3) |
| Участники | — Создание участника с дополнительными атрибутами — Редактирование участника с дополнительными атрибутами — Получение участника — Получение списка участников — Создание участника с дополнительными атрибутами (v3) — Редактирование участника с дополнительными атрибутами (v3) — Получение участника (v3) — Удаление участника (v3) — Исключение участника из дела/объекта (v3) — Создание участника (v4) — Редактирование участника (v4) — Получение участника (v4) |
| Организационно-правовая форма | — Получение организационно-правовой формы — Получение списка организационно-правовых форм |
| Пользователи | — Получение пользователя — Получение списка пользователей — Уведомление сообщением одного пользователя |
| Справочники | — Получение справочника по идентификатору — Получение списка справочников — Получение значения справочника по идентификатору — Получение списка значений справочника |
| Файлы | — Извлечение файлов из архива и их сохранение в файловом хранилище (v1) — Загрузка файлов в Систему — Скачивание файла |
| Звонки | — Создание звонка — Отправка уведомления о звонке — Прикрепление записи к звонку — Загрузка записи звонка |
| Сценарии автоматизации | — Запуск скрипта |
| Права роли | — Установка прав роли (v4) — Создание роли и установка прав (v4) — Создание роли с назначенными правами (v4) — Обновление прав роли (v4) — Удаление прав роли (v4) — Получение списка прав для роли (v4) |
| Служебные запросы | — Проверка состояния работоспособности сервиса — Метод проверки состояния системы (v3) |
| Логи | — Скачивание лога выполнения сценария автоматизации (v3) |