Навигация и поиск
GetAllObjects
Чтение.
Получить ВСЕ объекты базы (поиск в контексте корня). НЕ используйте рекурсивный обход через GetChildren — используйте этот инструмент!
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
maxResults |
int |
нет | 10000 |
Макс. объектов (по умолчанию 10000). |
GetAutomationConfigs
Чтение.
Получить автоматизации (AutomationConfig), их триггеры (Triggers) и C# вставки/код (CSharpCode).
Параметров нет.
GetChildren
Чтение.
Получить дочерние объекты. Результат записывается в файл (JSONL).
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
parentId |
string |
да | GUID родительского объекта. Корень базы: 00000001-0001-0001-0001-000000000001 |
GetObjectsToFile
Чтение.
Получить несколько объектов по их GUID и записать в файл.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
objectIds |
string |
да | GUID идентификаторы через запятую |
GetOrganisationUnits
Чтение.
Получить список всех организационных единиц и записать в файл (JSONL).
Параметров нет.
GetPeople
Чтение.
Получить список всех пользователей и записать в файл (JSONL).
Параметров нет.
GetRootObjects
Чтение.
Получить корневые объекты базы Pilot. Результат записывается в файл (JSONL).
Параметров нет.
GetStateMachines
Чтение.
Получить машины состояний (StateMachines) — workflow и переходы между состояниями.
Параметров нет.
GetTypes
Чтение.
Получить список типов объектов и записать в файл (JSONL). Работает из кэша — не требует активного соединения.
Параметров нет.
GetUserStates
Чтение.
Получить список пользовательских состояний (UserStates) — для задач и workflow.
Параметров нет.
Search
Чтение.
Комбинированный поиск с несколькими фильтрами одновременно. Используйте когда нужно совместить несколько критериев (тип + состояние + дата и т.д.). Для простых запросов используйте специализированные инструменты: GetAllObjects, SearchByText, SearchByType и др.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
query |
string |
нет | "*" |
Текстовый поиск. '*' или пусто = без текстового фильтра. |
maxResults |
int |
нет | 100 |
Макс. результатов. |
context |
string |
нет | "" |
GUID объекта-контекста (поиск внутри). |
typeId |
int |
нет | 0 |
ID типа объекта (0 = любой). |
creatorId |
int |
нет | 0 |
ID создателя (0 = любой). |
stateId |
string |
нет | "" |
GUID состояния. |
createdFrom |
string |
нет | "" |
Дата создания ОТ (ISO 8601, UTC). |
createdTo |
string |
нет | "" |
Дата создания ДО (ISO 8601, включительно: '2025-01-31' = весь день). |
attribute |
string |
нет | "" |
Фильтр по строковому атрибуту: 'имя=значение' (значение ищется как фраза). |
excludeFrozen |
bool |
нет | false |
Исключить замороженные. |
SearchByAttribute
Чтение.
Поиск объектов по значению СТРОКОВОГО атрибута (числовые, даты, состояния, орг. единицы не находятся). Значение ищется как точная фраза, в т.ч. из нескольких слов. Например: attributeName='$Title', value='Договор'.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
attributeName |
string |
да | Имя атрибута (например '$Title', 'code', 'mark'). | |
value |
string |
да | Значение атрибута для поиска. | |
maxResults |
int |
нет | 100 |
Макс. результатов. |
SearchByCreator
Чтение.
Поиск объектов по создателю (personId).
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
creatorId |
int |
да | ID создателя (personId). Получите через GetPeople. | |
maxResults |
int |
нет | 1000 |
Макс. результатов. |
SearchByDate
Чтение.
Поиск объектов по дате создания (диапазон, время в UTC; дата без времени = UTC).
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
from |
string |
нет | "" |
Дата ОТ (ISO 8601, например '2025-01-01'). Пусто = без нижней границы. |
to |
string |
нет | "" |
Дата ДО (ISO 8601, включительно: '2025-01-31' = весь день 31 января). Пусто = без верхней границы. |
maxResults |
int |
нет | 1000 |
Макс. результатов. |
SearchByState
Чтение.
Поиск объектов по пользовательскому состоянию (UserState). stateId — GUID состояния из GetUserStates.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
stateId |
string |
да | GUID пользовательского состояния. | |
maxResults |
int |
нет | 1000 |
Макс. результатов. |
SearchByText
Чтение.
Полнотекстовый поиск объектов по слову или фразе. Ищет по всем атрибутам и содержимому. Поддерживает русский язык.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
text |
string |
да | Текст для поиска (слово или фраза). | |
maxResults |
int |
нет | 100 |
Макс. результатов. |
SearchByType
Чтение.
Поиск объектов по типу. typeId — числовой ID типа из GetTypes.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
typeId |
int |
да | ID типа объекта (число). Получите список типов через GetTypes. | |
maxResults |
int |
нет | 1000 |
Макс. результатов. |
SearchInContext
Чтение.
Поиск объектов внутри папки (рекурсивно по всем вложенным). Для получения всех объектов внутри папки: SearchInContext(contextId, query='*').
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
contextId |
string |
да | GUID папки/объекта, внутри которого искать. | |
query |
string |
нет | "*" |
Текст для поиска внутри контекста. '*' = все вложенные объекты. |
maxResults |
int |
нет | 10000 |
Макс. результатов. |