Каталог контекстных переменных

Типы объектов

objectType запроса Префикс ключей Тип параметров Объект

process

process:

process

Процесс

user

user:

user

Пользователь

customer

customer:

customer

Контрагент

bgbilling-commonContract

bgbilling-commonContract:

bgbilling-commonContract

Единый договор

house

house:

address_house

Дом

street

street:

address_street

Улица

city

city:

address_city

Город

objectType — внешнее имя для ContextVariableBuilderFactory и HTTP API. Для адресных сущностей оно короче внутреннего типа, под которым зарегистрированы определения параметров.

Все значения возвращаются строками. null маскируется пустой строкой.

Процесс

Ключ Название в каталоге Значение

process:id

Процесс: ID

ID процесса

process:title

Процесс: название

Заголовок процесса

process:type

Процесс: тип

Название типа процесса

process:status

Процесс: статус

Название текущего статуса

process:description

Процесс: описание

Описание процесса

process:priority

Процесс: приоритет

Числовой приоритет

process:createTime

Процесс: время создания

Дата и время в формате dd.MM.yyyy HH:mm:ss

process:createUserId

Процесс: ID создавшего

ID создавшего пользователя

process:createUserTitle

Процесс: кто создал

Имя создавшего пользователя

process:closeTime

Процесс: время закрытия

Дата и время в формате dd.MM.yyyy HH:mm:ss

process:closeUser

Процесс: ID закрывшего

ID закрывшего пользователя

process:initiateGroups

Процесс: группы с ролью инициации

ID групп через запятую

process:executeGroups

Процесс: группы с ролью выполнения

ID групп через запятую

process:initiators

Процесс: исполнители с ролью инициации

Текущее строковое представление объектов ProcessExecutor

process:executors

Процесс: исполнители с ролью выполнения

Текущее строковое представление объектов ProcessExecutor
process:initiators и process:executors передают Set<ProcessExecutor> в общий Utils.toString, но ProcessExecutor не переопределяет toString(). В текущей реализации результат имеет технический вид ru.bgcrm.model.process.ProcessExecutor@…​, а не список ID или имён. Эти ключи нельзя использовать как стабильный пользовательский формат.
Историческое имя process:closeUser содержит ID, что отражено в названии каталога.

Пользователь

Ключ Название в каталоге Значение

user:id

Пользователь: ID

ID пользователя

user:title

Пользователь: имя

Отображаемое имя

user:login

Пользователь: логин

Логин

user:description

Пользователь: описание

Описание

user:roles

Пользователь: роли

Строковое представление ролей пользователя

user:email

Пользователь: почта

Электронная почта

user:queueIds

Пользователь: очереди

ID очередей через запятую

Контрагент

Ключ Название в каталоге Значение

customer:id

Контрагент: ID

ID контрагента

customer:title

Контрагент: название

Название контрагента

Единый договор

Ключ Название в каталоге Значение

bgbilling-commonContract:id

Единый договор: ID

ID единого договора

bgbilling-commonContract:title

Единый договор: номер

Форматированный номер

bgbilling-commonContract:password

Единый договор: пароль

Пароль договора
Пароль — чувствительное значение. Не помещайте его в журнал, ошибку, новость или другой текст с широким кругом читателей.

Дом

Ключ Название в каталоге Значение

house:id

Дом: ID

ID дома

house:houseAndFrac

Дом: номер и дробь

Номер дома с дробью

house:street

Дом: улица

Название улицы

house:area

Дом: район

Название района

house:quarter

Дом: квартал

Название квартала

house:city

Дом: город

Название города

house:country

Дом: страна

Название страны

house:postIndex

Дом: почтовый индекс

Почтовый индекс

house:comment

Дом: комментарий

Комментарий дома

Улица

Ключ Название в каталоге Значение

street:id

Улица: ID

ID улицы

street:title

Улица: название

Название улицы

Город

Ключ Название в каталоге Значение

city:id

Город: ID

ID города

city:title

Город: название

Название города

Постоянные переменные и параметры

Постоянные переменные объявлены в ContextVariableDefinition и всегда присутствуют в контексте существующего объекта, даже если их значение пусто.

Параметрическая переменная присутствует в рабочем контексте только когда параметр:

  • объявлен для типа объекта;

  • заполнен у конкретного объекта.

В каталоге для интерфейса показываются все объявленные параметры, в том числе ещё не заполненные. Поэтому ключ из каталога может отсутствовать в ответе значений конкретного объекта.

Переменные, добавленные через ContextVariablesBuildEvent, в этом каталоге не показываются.

Ключ любого параметра строится одинаково: к префиксу из первой таблицы добавляются param и ID параметра. Например, параметр процесса с ID 5503 имеет ключ process:param5503, а параметр дома с тем же ID — house:param5503.