Метаданные и автоматизации
AddTypeAttribute
Запись. Блокируется режимом PILOT_READONLY.
Добавить атрибут (параметр) к типу объекта. Требует учётку администратора сервера. attrType: Integer, Double, DateTime, String, Decimal, Numerator, Array, UserState, OrgUnit, ElementBook, Inherited, Boolean, ByteArray.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
typeName |
string |
да | Имя типа | |
name |
string |
да | Имя атрибута (латиницей, уникальное в типе) | |
title |
string |
да | Отображаемое название атрибута | |
attrType |
string |
да | Тип атрибута (см. описание инструмента) | |
obligatory |
bool |
нет | false |
Обязательный (true/false) |
showInTree |
bool |
нет | false |
Показывать в обозревателе объектов (true/false) |
displaySortOrder |
int |
нет | -1 |
Порядок отображения (-1 = в конец) |
configuration |
string |
нет | "" |
Конфигурация атрибута (XML/JSON, зависит от типа; пусто = нет) |
isService |
bool |
нет | false |
Служебный атрибут (true/false) |
AddTypeChildren
Запись. Блокируется режимом PILOT_READONLY.
Добавить дочерние типы к типу (Children — какие типы можно создавать внутри). Требует учётку администратора сервера.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
parentTypeName |
string |
да | Имя родительского типа | |
childTypeNames |
string |
да | Имена дочерних типов через запятую |
CreateAutomationConfig
Запись. Блокируется режимом PILOT_READONLY.
Создать автоматизацию (AutomationConfig). Требует учётку администратора сервера (PILOT_ADMIN_LOGIN/PILOT_ADMIN_PASSWORD). Triggers и CSharpCode — в том же формате, что возвращает GetAutomationConfigs. Перед созданием код можно проверить через ValidateAutomationScript.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
name |
string |
да | Имя автоматизации (уникальное) | |
triggers |
string |
да | Триггеры (строка, формат как в GetAutomationConfigs) | |
cSharpCode |
string |
да | C#-код автоматизации | |
isPaused |
bool |
нет | false |
Создать приостановленной (true/false) |
CreateStateMachine
Запись. Блокируется режимом PILOT_READONLY.
Создать машину состояний (StateMachine). Требует учётку администратора сервера. transitionsJson — JSON вида {"<имя или Guid исходного состояния>": [{"stateTo": "<имя или Guid>", "displayName": "..."}]}.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
title |
string |
да | Название машины состояний | |
transitionsJson |
string |
нет | "" |
Переходы (JSON, см. описание; пусто = без переходов) |
CreateType
Запись. Блокируется режимом PILOT_READONLY.
Создать тип объекта (MType). Требует учётку администратора сервера. parentTypeNames — имена родительских типов через запятую: новый тип будет добавлен в их Children.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
name |
string |
да | Имя типа (латиницей, уникальное) | |
title |
string |
да | Отображаемое название | |
kind |
string |
нет | "User" |
Вид типа: User, System, Service |
hasFiles |
bool |
нет | false |
Тип может содержать файлы (true/false) |
isMountable |
bool |
нет | false |
Тип монтируемый — Pilot Storage (true/false) |
isService |
bool |
нет | false |
Служебный тип (true/false) |
isProject |
bool |
нет | false |
Проектный тип (true/false) |
parentTypeNames |
string |
нет | "" |
Имена родительских типов через запятую (пусто = корневой) |
sort |
int |
нет | -1 |
Порядок сортировки (-1 = в конец) |
CreateUserState
Запись. Блокируется режимом PILOT_READONLY.
Создать пользовательское состояние (UserState). Требует учётку администратора сервера. color: None, Color1..Color7.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
name |
string |
да | Имя состояния (латиницей, уникальное) | |
title |
string |
да | Отображаемое название | |
color |
string |
нет | "None" |
Цвет: None, Color1..Color7 |
isCompletionState |
bool |
нет | false |
Завершающее состояние (true/false) |
DeleteAutomationConfig
Запись. Блокируется режимом PILOT_READONLY.
Удалить автоматизацию (AutomationConfig) по имени. Требует учётку администратора сервера.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
name |
string |
да | Имя автоматизации |
DeleteStateMachine
Запись. Блокируется режимом PILOT_READONLY.
Удалить машину состояний. Отклоняется, если машина привязана к типам. Требует учётку администратора сервера.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
machine |
string |
да | ID (Guid) или название машины состояний |
DeleteType
Запись. Блокируется режимом PILOT_READONLY.
Удалить тип объекта (пометить IsDeleted, как это делает myAdmin). Требует учётку администратора сервера.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
name |
string |
да | Имя типа |
DeleteTypeAttribute
Запись. Блокируется режимом PILOT_READONLY.
Удалить атрибут типа. Требует учётку администратора сервера.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
typeName |
string |
да | Имя типа | |
name |
string |
да | Имя атрибута |
DeleteUserState
Запись. Блокируется режимом PILOT_READONLY.
Удалить пользовательское состояние (пометить IsDeleted). Отклоняется, если состояние используется в машинах состояний. Требует учётку администратора сервера.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
name |
string |
да | Имя состояния |
UpdateAutomationConfig
Запись. Блокируется режимом PILOT_READONLY.
Изменить автоматизацию (AutomationConfig) по имени. Пустые параметры не меняются. Требует учётку администратора сервера.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
name |
string |
да | Имя автоматизации | |
newName |
string |
нет | "" |
Новое имя (пусто = не менять) |
triggers |
string |
нет | "" |
Новые триггеры (пусто = не менять) |
cSharpCode |
string |
нет | "" |
Новый C#-код (пусто = не менять) |
isPaused |
string |
нет | "" |
Приостановить: true/false (пусто = не менять) |
UpdateStateMachine
Запись. Блокируется режимом PILOT_READONLY.
Изменить машину состояний: название и/или полная замена переходов. Пустые параметры не меняются. Требует учётку администратора сервера.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
machine |
string |
да | ID (Guid) или название машины состояний | |
title |
string |
нет | "" |
Новое название (пусто = не менять) |
transitionsJson |
string |
нет | "" |
Новые переходы (JSON, ПОЛНОСТЬЮ заменяют существующие; пусто = не менять) |
UpdateType
Запись. Блокируется режимом PILOT_READONLY.
Изменить тип объекта (MType) по имени. Пустые параметры не меняются. Требует учётку администратора сервера.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
name |
string |
да | Имя типа | |
title |
string |
нет | "" |
Новое отображаемое название (пусто = не менять) |
hasFiles |
string |
нет | "" |
Может содержать файлы: true/false (пусто = не менять) |
isMountable |
string |
нет | "" |
Монтируемый: true/false (пусто = не менять) |
sort |
string |
нет | "" |
Порядок сортировки (пусто = не менять) |
stateMachineId |
string |
нет | "" |
ID машины состояний (Guid; 'none' = отвязать; пусто = не менять) |
UpdateTypeAttribute
Запись. Блокируется режимом PILOT_READONLY.
Изменить атрибут типа. Пустые параметры не меняются. Требует учётку администратора сервера.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
typeName |
string |
да | Имя типа | |
name |
string |
да | Имя атрибута | |
title |
string |
нет | "" |
Новое отображаемое название (пусто = не менять) |
obligatory |
string |
нет | "" |
Обязательный: true/false (пусто = не менять) |
showInTree |
string |
нет | "" |
Показывать в обозревателе: true/false (пусто = не менять) |
displaySortOrder |
string |
нет | "" |
Порядок отображения (пусто = не менять) |
configuration |
string |
нет | "" |
Конфигурация атрибута (пусто = не менять) |
UpdateUserState
Запись. Блокируется режимом PILOT_READONLY.
Изменить пользовательское состояние (UserState) по имени. Пустые параметры не меняются. Требует учётку администратора сервера.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
name |
string |
да | Имя состояния | |
title |
string |
нет | "" |
Новое отображаемое название (пусто = не менять) |
color |
string |
нет | "" |
Цвет: None, Color1..Color7 (пусто = не менять) |
isCompletionState |
string |
нет | "" |
Завершающее состояние: true/false (пусто = не менять) |
ValidateAutomationScript
Чтение.
Проверить C#-код автоматизации на сервере (компиляция) без сохранения. Требует учётку администратора сервера.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
cSharpCode |
string |
да | C#-код автоматизации |