Объекты
ComputeFileMd5
Чтение.
Вычислить MD5-хэш файла: из архива Pilot (по GUID тела файла, Body.Id) или локального файла (по пути на диске). Возвращает hex-строку в том же формате, что использует Pilot.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
fileBodyIdOrPath |
string |
да | GUID тела файла (Body.Id) или путь к локальному файлу |
CreateObject
Запись. Блокируется режимом PILOT_READONLY.
Создать новый объект в Pilot с одним начальным атрибутом. Атрибут должен быть определён в типе; значение разбирается по типу атрибута (числа и даты — в инвариантном формате, например 12.5 и 2025-01-31T10:00:00Z; Boolean — true/false; OrgUnit — id через запятую). Для установки дополнительных атрибутов вызовите SetAttribute несколько раз.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
parentId |
string |
да | GUID родительского объекта. Корень базы: 00000001-0001-0001-0001-000000000001 | |
typeName |
string |
да | Системное имя типа объекта | |
attributeName |
string |
да | Имя атрибута, например: name | |
attributeValue |
string |
да | Значение атрибута |
DeleteFile
Запись. Блокируется режимом PILOT_READONLY.
Удалить файл из объекта по его Body.Id.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
objectId |
string |
да | GUID объекта | |
fileId |
string |
да | GUID файла (Body.Id) |
DeleteObject
Запись. Блокируется режимом PILOT_READONLY.
Удалить объект (перемещение в корзину).
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
objectId |
string |
да | GUID объекта для удаления |
DownloadFile
Чтение.
Скачать файл из объекта Pilot и сохранить на диск.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
fileBodyId |
string |
да | GUID тела файла (Body.Id из информации об объекте) | |
savePath |
string |
да | Путь для сохранения файла на диске |
FreezeObject
Запись. Блокируется режимом PILOT_READONLY.
Заморозить объект (запретить редактирование). Доступно только для объекта в состоянии Alive.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
objectId |
string |
да | GUID объекта |
GetAttribute
Чтение.
Прочитать полное значение одного атрибута без обрезки. Используйте когда GetObject обрезал значение (показал '... (N chars total)').
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
objectId |
string |
да | GUID объекта | |
attributeName |
string |
да | Имя атрибута |
GetFileSize
Чтение.
Определить размер файла в архиве Pilot по Body.Id. Размер считается чтением содержимого по частям (на диск ничего не сохраняется), поэтому для больших файлов может занять время. Несуществующий или пустой файл — ошибка.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
fileBodyId |
string |
да | GUID тела файла (Body.Id) |
GetObject
Чтение.
Получить один объект по GUID. brief=true для краткой сводки (id, тип, имя, количество детей/файлов). Для массовых запросов используйте search или get_children.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
objectId |
string |
да | GUID идентификатор объекта | |
brief |
bool |
нет | false |
Краткий режим — только основные поля без атрибутов, связей и файлов (экономит контекст) |
GetType
Чтение.
Получить информацию о типе объекта по имени.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
typeName |
string |
да | Системное имя типа |
LockObject
Запись. Блокируется режимом PILOT_READONLY.
Заблокировать объект (запросить блокировку для эксклюзивного редактирования). Доступно только для объекта в состоянии Alive.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
objectId |
string |
да | GUID объекта |
MakePublic
Запись. Блокируется режимом PILOT_READONLY.
Снять секретность с объекта (сделать публичным).
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
objectId |
string |
да | GUID объекта |
MakeSecret
Запись. Блокируется режимом PILOT_READONLY.
Сделать объект секретным (ограниченный доступ).
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
objectId |
string |
да | GUID объекта |
MoveObject
Запись. Блокируется режимом PILOT_READONLY.
Переместить объект в другую папку.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
objectId |
string |
да | GUID объекта | |
newParentId |
string |
да | GUID новой родительской папки |
RestoreObject
Запись. Блокируется режимом PILOT_READONLY.
Восстановить объект из корзины. Возвращает объект в исходную родительскую папку.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
objectId |
string |
да | GUID объекта в корзине |
SetAttribute
Запись. Блокируется режимом PILOT_READONLY.
Установить значение одного атрибута объекта. Значение разбирается по типу атрибута (числа и даты — в инвариантном формате, например 12.5 и 2025-01-31T10:00:00Z; Boolean — true/false; UserState — GUID; OrgUnit — id через запятую; Array — значения через ';'). Неизвестное имя атрибута — ошибка. Для изменения нескольких атрибутов вызовите этот инструмент несколько раз.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
objectId |
string |
да | GUID объекта | |
attributeName |
string |
да | Имя атрибута, например: code, name, title | |
attributeValue |
string |
да | Новое значение атрибута |
SetUserState
Запись. Блокируется режимом PILOT_READONLY.
Установить пользовательское состояние (UserState) на объекте. Используется для задач и workflow. Вызовите GetUserStates чтобы увидеть доступные состояния.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
objectId |
string |
да | GUID объекта | |
stateAttributeName |
string |
да | Имя атрибута состояния (обычно содержит 'state' в имени) | |
stateId |
string |
да | GUID состояния (из GetUserStates) |
Subscribe
Запись. Блокируется режимом PILOT_READONLY.
Подписаться на уведомления об изменениях объекта.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
objectId |
string |
да | GUID объекта | |
personId |
int |
нет | 0 |
ID пользователя (personId). Если 0 — текущий пользователь. |
UnfreezeObject
Запись. Блокируется режимом PILOT_READONLY.
Разморозить объект (разрешить редактирование). Доступно только для замороженного объекта (состояние Frozen).
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
objectId |
string |
да | GUID объекта |
UnlockObject
Запись. Блокируется режимом PILOT_READONLY.
Разблокировать объект. Доступно только для объекта в состоянии LockRequested или LockAccepted (замороженный объект разморозьте через UnfreezeObject).
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
objectId |
string |
да | GUID объекта |
Unsubscribe
Запись. Блокируется режимом PILOT_READONLY.
Отписаться от уведомлений об изменениях объекта.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
objectId |
string |
да | GUID объекта | |
personId |
int |
нет | 0 |
ID пользователя (personId). Если 0 — текущий пользователь. |