В зависимости от того под каким пользователем идет работа список доступных команд будет отличаться, при этом ряд команд требует обязательной работы через сессию. Ниже в таблице перечислены возможные команды, требования к использованию сессий и доступность функционала в зависимости от выбранного типа работы.
Таблица 150.
| Команда | Описание | Использование сессии | Пароль SDK | Произвольный пользователь |
| /login | создание новой сессии | Необязательно | + | + |
| /health | вывод состояния “здоровья” сервера | Необязательно | + | + |
| /settings | чтение и запись настроек сервера | Необязательно | + | + |
| /objects |
вывод дерева объектов сервера применение различных методов к объектам сервера |
Необязательно | + | - |
| /classes | вывод описания классов объектов сервера | Необязательно | + | - |
| /users | создание пользователей и групп пользователей | Необязательно | + | - |
| /channels | быстрый вывод списка каналов | Обязательно | - | + |
| /events | получение событий сервера | Необязательно | + | - |
| /pos_events | получение событий POS-терминалов | Необязательно | + | - |
| /lpr_events | получение событий AutoTRASSIR | Необязательно | + | - |
| /fr_events | получение событий трекера/распознавателя лиц | Обязательно | + | - |
| /deep_detector | получение событий нейронного детектора объектов | Обязательно | + | - |
| /screenshot | запрос скриншота | Необязательно | + | - |
| /ptz | управление ptz-камерой | Обязательно | - | + |
| /archive_status | вывод состояния архива | Обязательно | - | + |
| /archive_command | управление архивом | Обязательно | - | + |
| /archive_events | запрос событий архива | Обязательно | - | + |
| /get_video | получение ссылки на видео | Обязательно | - | + |
|
/archive_export /archive_export_ss /archive_export_ex /export_archive /export_task /export_cancel |
локальный экспорт архива | Обязательно | + | + |
|
/jit-export-task /jit-export-status /jit-export-download /jit-export-cancel-task |
удаленный экспорт архива | Обязательно | + | + |
Подсказка
При работе с указанием логина/пароля в запросе, ответ сервера на команды /events, /pos_events, /lpr_events и /fr_events каждый раз будет содержать последние 100 событий.
При работе через сессию первый запрос вернет последние 100 событий, а все последующие запросы будут возвращать только новые события произошедшие со времени последнего запроса. Если долгое время событий не происходит, то наступит тайм-аут.
Подсказка
Обратите внимание, что SDK не осуществляет поиск по БД событий, а возвращает лишь те события, которые были накоплены с момента старта модуля автоматизации.
Также, рекомендуем вам ознакомиться с более подробным описанием команд и примерами их использования.
