Справочник инструментов
Всего инструментов: 125, из них записывающих: 60. Записывающие инструменты блокируются режимом PILOT_READONLY (см. Конфигурация). Страницы справочника сформированы автоматически по коду сервера.
| Инструмент | Группа | Тип | Описание |
|---|---|---|---|
GetDatabaseInfo |
Подключение | чтение | Получить информацию о текущей базе данных Pilot. |
ComputeFileMd5 |
Объекты | чтение | Вычислить MD5-хэш файла: из архива Pilot (по GUID тела файла, Body.Id) или локального файла (по пути на диске). |
CreateObject |
Объекты | запись | Создать новый объект в Pilot с одним начальным атрибутом. |
DeleteFile |
Объекты | запись | Удалить файл из объекта по его Body.Id. |
DeleteObject |
Объекты | запись | Удалить объект (перемещение в корзину). |
DownloadFile |
Объекты | чтение | Скачать файл из объекта Pilot и сохранить на диск. |
FreezeObject |
Объекты | запись | Заморозить объект (запретить редактирование). |
GetAttribute |
Объекты | чтение | Прочитать полное значение одного атрибута без обрезки. |
GetFileSize |
Объекты | чтение | Определить размер файла в архиве Pilot по Body.Id. |
GetObject |
Объекты | чтение | Получить один объект по GUID. |
GetType |
Объекты | чтение | Получить информацию о типе объекта по имени. |
LockObject |
Объекты | запись | Заблокировать объект (запросить блокировку для эксклюзивного редактирования). |
MakePublic |
Объекты | запись | Снять секретность с объекта (сделать публичным). |
MakeSecret |
Объекты | запись | Сделать объект секретным (ограниченный доступ). |
MoveObject |
Объекты | запись | Переместить объект в другую папку. |
RestoreObject |
Объекты | запись | Восстановить объект из корзины. |
SetAttribute |
Объекты | запись | Установить значение одного атрибута объекта. |
SetUserState |
Объекты | запись | Установить пользовательское состояние (UserState) на объекте. |
Subscribe |
Объекты | запись | Подписаться на уведомления об изменениях объекта. |
UnfreezeObject |
Объекты | запись | Разморозить объект (разрешить редактирование). |
UnlockObject |
Объекты | запись | Разблокировать объект. |
Unsubscribe |
Объекты | запись | Отписаться от уведомлений об изменениях объекта. |
UploadFile |
Загрузка файлов | запись | Загрузить файл в существующий объект Pilot. |
GetAllObjects |
Навигация и поиск | чтение | Получить ВСЕ объекты базы (поиск в контексте корня). |
GetAutomationConfigs |
Навигация и поиск | чтение | Получить автоматизации (AutomationConfig), их триггеры (Triggers) и C# вставки/код (CSharpCode). |
GetChildren |
Навигация и поиск | чтение | Получить дочерние объекты. |
GetObjectsToFile |
Навигация и поиск | чтение | Получить несколько объектов по их GUID и записать в файл. |
GetOrganisationUnits |
Навигация и поиск | чтение | Получить список всех организационных единиц и записать в файл (JSONL). |
GetPeople |
Навигация и поиск | чтение | Получить список всех пользователей и записать в файл (JSONL). |
GetRootObjects |
Навигация и поиск | чтение | Получить корневые объекты базы Pilot. |
GetStateMachines |
Навигация и поиск | чтение | Получить машины состояний (StateMachines) — workflow и переходы между состояниями. |
GetTypes |
Навигация и поиск | чтение | Получить список типов объектов и записать в файл (JSONL). |
GetUserStates |
Навигация и поиск | чтение | Получить список пользовательских состояний (UserStates) — для задач и workflow. |
Search |
Навигация и поиск | чтение | Комбинированный поиск с несколькими фильтрами одновременно. |
SearchByAttribute |
Навигация и поиск | чтение | Поиск объектов по значению СТРОКОВОГО атрибута (числовые, даты, состояния, орг. |
SearchByCreator |
Навигация и поиск | чтение | Поиск объектов по создателю (personId). |
SearchByDate |
Навигация и поиск | чтение | Поиск объектов по дате создания (диапазон, время в UTC; дата без времени = UTC). |
SearchByState |
Навигация и поиск | чтение | Поиск объектов по пользовательскому состоянию (UserState). |
SearchByText |
Навигация и поиск | чтение | Полнотекстовый поиск объектов по слову или фразе. |
SearchByType |
Навигация и поиск | чтение | Поиск объектов по типу. |
SearchInContext |
Навигация и поиск | чтение | Поиск объектов внутри папки (рекурсивно по всем вложенным). |
GetOrgUnitsByIds |
Пользователи и организация | чтение | Получить организационные единицы по ID. |
GetPeopleByIds |
Пользователи и организация | чтение | Получить информацию о конкретных пользователях по их ID. |
GetPersonOnPosition |
Пользователи и организация | чтение | Узнать кто занимает указанную позицию (по positionId из организационной структуры). |
CreateOrgUnit |
Управление пользователями и оргструктурой | запись | Создать организационную единицу. |
CreatePerson |
Управление пользователями и оргструктурой | запись | Создать пользователя базы. |
DeleteOrgUnit |
Управление пользователями и оргструктурой | запись | Удалить организационную единицу (пометить IsDeleted). |
DeletePerson |
Управление пользователями и оргструктурой | запись | Удалить пользователя (пометить IsDeleted, как это делает myAdmin). |
MoveOrgUnits |
Управление пользователями и оргструктурой | запись | Переместить организационные единицы к новому родителю. |
RemovePersonFromPosition |
Управление пользователями и оргструктурой | запись | Снять пользователя с должности (позиции). |
SetPersonOnPosition |
Управление пользователями и оргструктурой | запись | Назначить пользователя на должность (позицию). |
UpdateOrgUnit |
Управление пользователями и оргструктурой | запись | Изменить организационную единицу. |
UpdatePersonAdmin |
Управление пользователями и оргструктурой | запись | Изменить пользователя через админский API: логин, отображаемое имя, пароль, признак администратора, признак активности. |
CountFile |
Работа с файлами результатов | чтение | Посчитать количество записей в файле результатов. |
ExportCsv |
Работа с файлами результатов | чтение | Экспортировать файл результатов в CSV. |
ExtractFieldToText |
Работа с файлами результатов | чтение | Извлечь значения одного поля из файла результатов и записать построчно в текстовый файл. |
ExtractFields |
Работа с файлами результатов | чтение | Извлечь указанные поля из файла результатов. |
FilterObjects |
Работа с файлами результатов | чтение | Отфильтровать записи из файла результатов по значению поля. |
PreviewFile |
Работа с файлами результатов | чтение | Просмотреть страницу записей из файла результатов. |
ReadFile |
Работа с файлами результатов | чтение | Прочитать текстовый файл (или его часть). |
SaveResult |
Работа с файлами результатов | чтение | Скопировать файл результатов в указанное место (переименовать/сохранить). |
ExtractPageText |
Документы | чтение | Извлечь весь текст со страницы документа с координатами. |
FindTextOnPage |
Документы | чтение | Найти текст на страницах документа и получить координаты всех вхождений (x, y, ширина, размер шрифта). |
GetDocumentPageImage |
Документы | чтение | Получить изображение страницы документа (PDF или XPS). |
GetDocumentText |
Документы | чтение | Прочитать текст документа (PDF или XPS). |
AnnotateText |
Замечания (аннотации) | запись | Создать замечание к тексту на документе. |
BuildAnnotationXml |
Замечания (аннотации) | чтение | Получить XML-разметку аннотации в старом (legacy) формате без создания объекта. |
CreateAnnotation |
Замечания (аннотации) | запись | Нарисовать графическую фигуру на документе (прямоугольник, эллипс, треугольник, стрелку, линию, ломаную, многоугольник, рисунок от руки, точку). |
CreateMarkupAnnotation |
Замечания (аннотации) | запись | Создать ОДНО замечание из нескольких фигур в формате Markup (клиент Pilot 26.20+). |
GetAnnotations |
Замечания (аннотации) | чтение | Прочитать замечания документа (любого типа замечаний, без удалённых в корзину). |
GetChangesets |
История и версии | чтение | Получить набор изменений (changesets) за период: номер, идентификатор, число изменённых объектов и их GUID. |
GetHistory |
История и версии | чтение | Получить историю изменений объекта. |
AddAccessRecord |
Права доступа | запись | Добавить запись прав доступа к объекту. |
CheckAccess |
Права доступа | чтение | Проверить права доступа пользователя к объекту. |
CheckAccessByUnit |
Права доступа | чтение | Проверить права доступа организационной единицы к объекту. |
GetAccessRecords |
Права доступа | чтение | Получить записи прав доступа объекта (кому и какие права назначены). |
GetSubscribers |
Права доступа | чтение | Получить список подписчиков объекта (personId пользователей, подписанных на уведомления). |
RemoveAllAccessRecords |
Права доступа | запись | Сделать объект публичным (удалить все ограничения доступа). |
CreateLink |
Связи между объектами | запись | Создать двустороннюю связь между двумя объектами Pilot. |
DeleteRelation |
Связи между объектами | запись | Удалить связь между двумя объектами Pilot. |
GetObjectsWithRights |
Связи между объектами | чтение | Получить объекты с правами доступа. |
CheckOnline |
Чаты | чтение | Проверить, онлайн ли пользователь. |
CreateChat |
Чаты | запись | Создать групповой чат. |
EditMessage |
Чаты | запись | Редактировать ранее отправленное сообщение. |
GetChat |
Чаты | чтение | Получить информацию о конкретном чате по его GUID. |
GetChatMembers |
Чаты | чтение | Получить участников чата. |
GetChats |
Чаты | чтение | Получить список чатов. |
GetMessage |
Чаты | чтение | Получить одно сообщение по его GUID. |
GetMessages |
Чаты | чтение | Прочитать сообщения из чата (от старых к новым внутри страницы). |
GetPersonalChat |
Чаты | чтение | Получить личный чат с конкретным пользователем (если он уже существует; сам инструмент чат не создаёт). |
GetRelatedChats |
Чаты | чтение | Получить чаты, связанные с объектом (например, обсуждение задачи или документа). |
ReplyMessage |
Чаты | запись | Ответить на конкретное сообщение в чате. |
SearchMessages |
Чаты | чтение | Поиск сообщений по тексту в указанных чатах (если chatIds пуст — во всех чатах текущего пользователя). |
SendMessage |
Чаты | запись | Отправить сообщение в чат. |
GetCommonSettings |
Настройки | чтение | Получить общие настройки базы данных. |
GetPersonalSettings |
Настройки | чтение | Получить персональные настройки текущего пользователя. |
CreateReport |
Отчёты | запись | Создать новый отчёт (.repx) в папке отчётов Pilot. |
FindReports |
Отчёты | чтение | Найти папку отчётов в базе Pilot и показать все отчёты (рекурсивно по вложенным папкам). |
GetReport |
Отчёты | чтение | Прочитать отчёт (.repx) из объекта Pilot. |
GetReportSample |
Отчёты | чтение | Прочитать пример отчёта (.repx) для изучения формата и использования как образца. |
ListReportSamples |
Отчёты | чтение | Список доступных примеров отчётов (.repx). |
UpdateReport |
Отчёты | запись | Обновить содержимое отчёта (.repx) в существующем объекте Pilot. |
ChangeSettings |
Администрирование (пользователь, настройки) | запись | Изменить настройку пользователя или общую настройку базы. |
UpdatePerson |
Администрирование (пользователь, настройки) | запись | Обновить данные пользователя по personId через админский API: email, телефон, комментарий, признак неактивности. |
AddTypeAttribute |
Метаданные и автоматизации | запись | Добавить атрибут (параметр) к типу объекта. |
AddTypeChildren |
Метаданные и автоматизации | запись | Добавить дочерние типы к типу (Children — какие типы можно создавать внутри). |
CreateAutomationConfig |
Метаданные и автоматизации | запись | Создать автоматизацию (AutomationConfig). |
CreateStateMachine |
Метаданные и автоматизации | запись | Создать машину состояний (StateMachine). |
CreateType |
Метаданные и автоматизации | запись | Создать тип объекта (MType). |
CreateUserState |
Метаданные и автоматизации | запись | Создать пользовательское состояние (UserState). |
DeleteAutomationConfig |
Метаданные и автоматизации | запись | Удалить автоматизацию (AutomationConfig) по имени. |
DeleteStateMachine |
Метаданные и автоматизации | запись | Удалить машину состояний. |
DeleteType |
Метаданные и автоматизации | запись | Удалить тип объекта (пометить IsDeleted, как это делает myAdmin). |
DeleteTypeAttribute |
Метаданные и автоматизации | запись | Удалить атрибут типа. |
DeleteUserState |
Метаданные и автоматизации | запись | Удалить пользовательское состояние (пометить IsDeleted). |
UpdateAutomationConfig |
Метаданные и автоматизации | запись | Изменить автоматизацию (AutomationConfig) по имени. |
UpdateStateMachine |
Метаданные и автоматизации | запись | Изменить машину состояний: название и/или полная замена переходов. |
UpdateType |
Метаданные и автоматизации | запись | Изменить тип объекта (MType) по имени. |
UpdateTypeAttribute |
Метаданные и автоматизации | запись | Изменить атрибут типа. |
UpdateUserState |
Метаданные и автоматизации | запись | Изменить пользовательское состояние (UserState) по имени. |
ValidateAutomationScript |
Метаданные и автоматизации | чтение | Проверить C#-код автоматизации на сервере (компиляция) без сохранения. |
CreateTask |
Задачи | запись | Создать задачу в Pilot. |
CreateWorkflow |
Задачи | запись | Создать пустой workflow (процесс) без стадий: стадии и задачи этот инструмент не добавляет. |
AddSignatureRequest |
Подписи | запись | Добавить запрос на подпись к файлу в актуальной версии объекта. |
InvokeCommand |
Команды сервера | запись | Вызвать команду, зарегистрированную серверным расширением Pilot Server (плагином на стороне сервера). |