API docs by Redocly

Event Chains API (1.0.0)

Download OpenAPI specification:

Получение информации о текущем аутентифицированном пользователе

Возвращает информацию о текущем пользователе на основе его сессии/токена, включая базовые атрибуты профиля и данные из ID-токена (claims).

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "preferred_username": "u_m2d7d1",
  • "email": "tsoprano@alfabank.ru",
  • "name": "Тони Сопрано",
  • "authenticated": true,
  • "sub": "ab9bbeb4-ea20-4ad6-bb12-4ef30a8002df",
  • "expires_at": "2026-04-16T12:44:21.000000000Z",
  • "claims": {
    }
}

Поиск и получение списка событий

Возвращает список событий с возможностью фильтрации, сортировки и пагинации. Фильтры передаются в requestBody (все поля опциональны). Пагинация и сортировка передаются в query (offset, limit — обязательные). Если requestBody пустой — возвращается общий список с пагинацией и сортировкой. Неизвестные поля в requestBody и parameters[] не допускаются.

Формат дат: DD.MM.YYYY (например: 31.01.2026).

Авторизация: требуется Bearer JWT-токен в заголовке Authorization.

query Parameters
offset
required
integer >= 0

Смещение (0-based)

limit
required
integer [ 1 .. 100 ]

Количество записей на странице

sort
string
Enum: "eventId,asc" "eventId,desc" "eventName,asc" "eventName,desc" "eventSourceName,asc" "eventSourceName,desc" "deletedFlag,asc" "deletedFlag,desc" "isCounter,asc" "isCounter,desc"

Сортировка результатов. Формат: <поле>,<направление>

Вторичная сортировка: всегда применяется eventId,desc — как дефолтная (если sort не передан), так и как дополнительный ключ при совпадении значений основного поля сортировки.

Допустимые поля:

Поле Описание
eventId Идентификатор события
eventName Наименование события
eventSourceName Источник события
deletedFlag Активность
isCounter Является счётчиком

Допустимые направления: asc (по возрастанию), desc (по убыванию).

Пример: eventId,desc

header Parameters
Tenant-Id
required
string
Enum: "retail" "sme"

Идентификатор пространства (схемы БД). retail — работает со схемой rts_retail, sme — работает со схемой rts_sme.

Request Body schema: application/json
optional
eventSourceCcode
string [ 1 .. 50 ] characters ^[A-Za-z0-9_.-]+$

Код источника события

deletedFlag
string
Enum: "N" "Y"

Флаг активности: - N — активные события - Y — неактивные события - если параметр не указан, отображаются все события с признаком и без.

isCounter
string
Enum: "Y" "N"

Признак «Является счётчиком»: - Y — событие является счётчиком - N — не является счётчиком - если параметр не указан, отображаются все события с признаком и без.

eventId
Array of integers [ 1 .. 100 ] items [ items >= 1 ]

Один или несколько уникальных идентификаторов событий. Элементы массива не могут быть null или <= 0. При передаче невалидного элемента возвращается "Некорректное значение eventId". Пустой массив [] возвращает "Размер eventId должен быть от 1 до 100".

eventName
Array of strings [ 1 .. 100 ] items [ items [ 1 .. 255 ] characters ]

Наименование события (одно или несколько значений). Элементы массива не могут быть null или пустой строкой (minLength: 1). При передаче невалидного элемента возвращается "Некорректное значение eventName". Пустой массив [] возвращает "Размер eventName должен быть от 1 до 100".

Array of objects [ 1 .. 100 ] items

Массив параметров фильтрации. Каждый элемент:

  • paramName — имя параметра (string)
  • compareSign — знак сравнения (enum: "=", "!=", "<=", ">=", "in", "not in")
  • paramValue — одно значение (string)

Валидация paramValue зависит от compareSign:

  • Для "<=", ">=" — только числа (целые или дробные, включая отрицательные). Паттерн: ^-?\d+(.\d+)?$
  • Для "=", "!=" — любая строка 0..1020 символов. Пустая строка "" разрешена (поиск записей с пустым значением в БД)
  • Для "in", "not in" — строка 1..1020 символов без ведущих/хвостовых пробелов. Паттерн: ^\S+(\s+\S+)*$. Пустая строка запрещена

Responses

Request samples

Content type
application/json
Example
{ }

Response samples

Content type
application/json
{
  • "events": [
    ],
  • "pagination": {
    }
}

Получение справочной информации по событиям

Возвращает справочник всех событий в системе. Используется при создании и редактировании цепочек событий (event chains), чтобы выбрать событие и увидеть, к какому источнику оно относится.

Authorizations:
bearerAuth
header Parameters
Tenant-Id
required
string
Enum: "retail" "sme"

Идентификатор пространства (схемы БД). retail — работает со схемой rts_retail, sme — работает со схемой rts_sme.

Responses

Response samples

Content type
application/json
{
  • "event": [
    ]
}

Создание события

Этот метод используется для создания нового события в системе. Флаг активности deletedFlag принимает значения Y или N и передаётся пользователем при создании.

query Parameters
isForced
required
boolean
Default: false

Принудительное создание при частичном совпадении параметров (по умолчанию false)

header Parameters
Tenant-Id
required
string
Enum: "retail" "sme"

Идентификатор пространства (схемы БД). retail — работает со схемой rts_retail, sme — работает со схемой rts_sme.

Request Body schema: application/json
required

Данные для создания нового события

eventSourceCcode
required
string [ 1 .. 50 ] characters ^[A-Za-z0-9_.-]+$

Код источника события

eventName
required
string [ 1 .. 1020 ] characters

Наименование события

deletedFlag
required
string
Enum: "N" "Y"

Флаг активности (N = активна, Y = неактивна).

isCounter
required
string
Enum: "Y" "N"

Признак «Является счётчиком»

required
Array of objects [ 1 .. 100 ] items

Список параметров события.

Валидация paramValue зависит от compareSign:

  • Для "<=", ">=" — только числа (целые или дробные, включая отрицательные). Паттерн: ^-?\d+(.\d+)?$
  • Для "=", "!=" — любая строка 0..1020 символов. Пустая строка "" разрешена (создаёт параметр с пустым значением в БД)
  • Для "in", "not in", "like", "not like" — строка 1..1020 символов без ведущих/хвостовых пробелов. Паттерн: ^\S+(\s+\S+)*$. Пустая строка запрещена
object

Заполняется, если isCounter = Y

Responses

Request samples

Content type
application/json
Example
{
  • "eventSourceCcode": "events_test",
  • "eventName": "Тестовое событие со счётчиком (event)",
  • "deletedFlag": "N",
  • "isCounter": "Y",
  • "parameters": [
    ],
  • "counter": {
    }
}

Response samples

Content type
application/json
{
  • "eventId": 13025
}

Получение информации о событии по его ID

Возвращает подробную информацию о событии с указанным идентификатором.

path Parameters
eventId
required
integer <int64> [ 1 .. 9223372036854776000 ]

Уникальный идентификатор события

header Parameters
Tenant-Id
required
string
Enum: "retail" "sme"

Идентификатор пространства (схемы БД). retail — работает со схемой rts_retail, sme — работает со схемой rts_sme.

Responses

Response samples

Content type
application/json
Example
{
  • "eventId": 13016,
  • "eventSourceName": "Справочники. Метод /events",
  • "eventSourceCcode": "ALFA_MOBILE",
  • "deletedFlag": "N",
  • "author": "system",
  • "eventChains": [
    ],
  • "eventName": "Обновлённое тестовое событие (event_attr)",
  • "isCounter": "Y",
  • "counter": {
    },
  • "parameters": [
    ],
  • "updatedAt": "27.11.2025 18:06:13"
}

Изменение события

Обновление информации о событии по его уникальному идентификатору.

path Parameters
eventId
required
integer <int64>

Уникальный идентификатор события

query Parameters
isForced
boolean
Default: false

Принудительное обновление при частичном совпадении параметров (по умолчанию false)

header Parameters
Tenant-Id
required
string
Enum: "retail" "sme"

Идентификатор пространства (схемы БД). retail — работает со схемой rts_retail, sme — работает со схемой rts_sme.

Request Body schema: application/json
required

Данные для обновления события

eventName
required
string [ 1 .. 1020 ] characters

Наименование события

eventSourceCcode
required
string [ 1 .. 50 ] characters ^[A-Za-z0-9_.-]+$

Код источника события

deletedFlag
required
string
Enum: "N" "Y"

Флаг активности (N = активна, Y = неактивна)

isCounter
required
string
Enum: "Y" "N"

Признак «Является счётчиком»

Array of objects [ 0 .. 100 ] items

Список параметров события. Может быть пустым массивом — в этом случае все параметры будут удалены.

Валидация paramValue зависит от compareSign:

  • Для "<=", ">=" — только числа (целые или дробные, включая отрицательные). Паттерн: ^-?\d+(.\d+)?$
  • Для "=", "!=" — любая строка 0..1020 символов. Пустая строка "" разрешена
  • Для "in", "not in", "like", "not like" — строка 1..1020 символов без ведущих/хвостовых пробелов. Паттерн: ^\S+(\s+\S+)*$. Пустая строка запрещена
object

Заполняется, если isCounter = Y

Responses

Request samples

Content type
application/json
{
  • "eventName": "Обновлённое тестовое событие (event_attr)",
  • "eventSourceCcode": "events_test",
  • "deletedFlag": "N",
  • "isCounter": "Y",
  • "parameters": [
    ],
  • "counter": {
    }
}

Response samples

Content type
application/json
{
  • "eventId": 13016,
  • "eventName": "Обновлённое тестовое событие (event_attr)",
  • "eventSourceName": "Справочники. Метод /events",
  • "deletedFlag": "N",
  • "isCounter": "Y",
  • "updatedAt": "27.11.2025 18:06:13",
  • "author": "system",
  • "parameters": [
    ],
  • "counter": {
    }
}

Добавление новой цепочки событий

Метод используется для создания цепочки событий с параметрами, шагами, сегментами и отображением параметров.

Authorizations:
bearerAuth
header Parameters
Tenant-Id
required
string
Enum: "retail" "sme"

Идентификатор пространства (схемы БД). retail — работает со схемой rts_retail, sme — работает со схемой rts_sme.

Request Body schema: application/json
required
eventChainCcode
required
string

Уникальный код цепочки событий. Задаётся пользователем при создании (POST). В PUT-запросе игнорируется — берётся из path-параметра eventChainCcode.

eventChainName
required
string

Наименование цепочки

businessStreamCcode
required
string

Код бизнес-направления

checkOfferType
required
string
Enum: "ANY" "ALL"

Проверка офферов (ANY — хотя бы один, ALL — все)

checkPriorityFlag
required
string
Enum: "Y" "N"

Проверка приоритета (Y — требуется, N — не требуется)

priorityWeight
integer [ 1 .. 100 ]

Вес цепочки (диапазон 1–100, default 60)

startDttm
required
string

Дата начала. Формат DD.MM.YYYY.

endDttm
required
string

Дата окончания. Формат DD.MM.YYYY.

deletedFlag
required
string
Enum: "N" "Y"

Флаг активности (N — активна, Y — не активна)

required
Array of objects
required
Array of objects
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "deletedFlag": "N",
  • "eventChainCcode": "1001",
  • "eventChainName": "Цепочка приветствия",
  • "businessStreamCcode": "RTM",
  • "checkOfferType": "ANY",
  • "checkPriorityFlag": "Y",
  • "priorityWeight": 60,
  • "startDttm": "15.10.2025",
  • "endDttm": "31.12.2025",
  • "steps": [
    ],
  • "segment": [
    ],
  • "mapping": [
    ]
}

Response samples

Content type
application/json
{
  • "eventChainCcode": "1001"
}

Получение списка цепочек

Возвращает список цепочек с фильтрацией, сортировкой и пагинацией. Фильтры передаются в requestBody (все поля опциональны). Пагинация и сортировка передаются в query-параметрах (offset, limit — обязательные). Если requestBody пустой или не передан — возвращается общий список с пагинацией и сортировкой. Неизвестные поля в requestBody не допускаются (additionalProperties: false). Формат дат: DD.MM.YYYY (например: 31.01.2026). Авторизация: требуется Bearer JWT-токен в заголовке Authorization.

Authorizations:
bearerAuth
query Parameters
offset
required
integer >= 0

Смещение от начала результирующего набора (0-based). Формула для перехода на страницу N: offset = (N - 1) * limit.

limit
required
integer [ 1 .. 100 ]
Example: limit=10

Количество записей на одной странице.

sort
string
Enum: "eventChainCcode,asc" "eventChainCcode,desc" "eventChainName,asc" "eventChainName,desc" "startDttm,asc" "startDttm,desc" "endDttm,asc" "endDttm,desc" "priorityWeight,asc" "priorityWeight,desc" "checkPriorityFlag,asc" "checkPriorityFlag,desc" "deletedFlag,asc" "deletedFlag,desc"

Сортировка результатов. Формат: <поле>,<направление>

Вторичная сортировка: всегда применяется eventChainCcode,desc — как дефолтная (если sort не передан), так и как дополнительный ключ при совпадении значений основного поля сортировки.

Допустимые поля:

Поле Описание
eventChainCcode Код цепочки
eventChainName Наименование
startDttm Дата начала
endDttm Дата окончания
priorityWeight Вес приоритета
checkPriorityFlag Включена рулетка
deletedFlag Активность

Допустимые направления: asc (по возрастанию), desc (по убыванию).

Пример: endDttm,desc

header Parameters
Tenant-Id
required
string
Enum: "retail" "sme"

Идентификатор пространства (схемы БД). retail — работает со схемой rts_retail, sme — работает со схемой rts_sme.

Request Body schema: application/json
optional
businessStreamCcode
string [ 1 .. 200 ] characters

Код бизнес-направления (необязательный)

deletedFlag
string
Value: "N"

Фильтр по активности цепочки. Передаётся только значение "N" (показать только активные). Если параметр не передан — возвращаются все цепочки независимо от активности.

eventChainCcode
Array of strings [ 1 .. 100 ] items [ items [ 1 .. 200 ] characters ]

Фильтрация по коду цепочки (можно передавать несколько значений)

eventChainName
Array of strings [ 1 .. 100 ] items [ items [ 1 .. 255 ] characters ]

Фильтрация по названию цепочки (можно передавать несколько значений)

checkPriorityFlag
string
Enum: "Y" "N"

Проверка приоритета (Y — требуется, N — не требуется)

checkOfferFlag
string
Enum: "Y" "N"

Признак фильтрации по сегменту оффера: - Y — да - N — нет - если не передан — фильтрация не применяется

campaignSegmentCcode
Array of strings [ 1 .. 100 ] items [ items [ 1 .. 200 ] characters ]

Коды сегментов оффера (можно выбрать несколько)

startDttm
string

Дата начала действия цепочки. Формат: DD.MM.YYYY.

endDttm
string

Дата окончания действия цепочки. Формат: DD.MM.YYYY.

isExpiredChain
boolean
Default: false

Показать цепочки с истёкшим сроком действия: - true — показывать - false — не показывать (по умолчанию)

Responses

Request samples

Content type
application/json
Example
{ }

Response samples

Content type
application/json
{
  • "eventChains": [
    ],
  • "pagination": {
    }
}

Получение справочника цепочек

Метод возвращает справочник цепочек, включая код и наименование. Используется для фильтров в формах "Поиск цепочек".

Authorizations:
bearerAuth
header Parameters
Tenant-Id
required
string
Enum: "retail" "sme"

Идентификатор пространства (схемы БД). retail — работает со схемой rts_retail, sme — работает со схемой rts_sme.

Responses

Response samples

Content type
application/json
{
  • "chains": [
    ]
}

Получение списка сегментов цепочек

Возвращает список уникальных кодов сегментов оффера, используемых в цепочках событий. Данные формируются на основе таблицы EVENT_CHAIN_OFFER_PARAM. Возвращается distinct-набор campaignsegmentCcode. Используется для справочников и dropdown в UI. Метод возвращает массив строк без дополнительной бизнес-обёртки.

Authorizations:
bearerAuth
header Parameters
Tenant-Id
required
string
Enum: "retail" "sme"

Идентификатор пространства (схемы БД). retail — работает со схемой rts_retail, sme — работает со схемой rts_sme.

Responses

Response samples

Content type
application/json
{
  • "segments": [
    ]
}

Получение цепочки событий

Возвращает полную карточку цепочки событий по её уникальному коду.

Authorizations:
bearerAuth
path Parameters
eventChainCcode
required
string [ 1 .. 50 ] characters

Уникальный код цепочки событий

header Parameters
Tenant-Id
required
string
Enum: "retail" "sme"

Идентификатор пространства (схемы БД). retail — работает со схемой rts_retail, sme — работает со схемой rts_sme.

Responses

Response samples

Content type
application/json
{
  • "eventChainCcode": "1001",
  • "eventChainName": "Цепочка лояльности",
  • "businessStreamCcode": "LOYALTY",
  • "checkOfferType": "ANY",
  • "startDttm": "15.10.2025",
  • "endDttm": "31.12.2025",
  • "checkPriorityFlag": "Y",
  • "deletedFlag": "N",
  • "priorityWeight": 80,
  • "steps": [
    ],
  • "segment": [
    ],
  • "mapping": [
    ]
}

Обновление цепочки событий

Метод используется для обновления существующих данных цепочки событий по указанному коду. Тело запроса содержит полную актуальную версию сущности — отсутствующие в теле дочерние записи считаются удалёнными (полная замена). Авторизация: требуется Bearer JWT-токен в заголовке Authorization.

Authorizations:
bearerAuth
path Parameters
eventChainCcode
required
string

Уникальный код цепочки событий

header Parameters
Tenant-Id
required
string
Enum: "retail" "sme"

Идентификатор пространства (схемы БД). retail — работает со схемой rts_retail, sme — работает со схемой rts_sme.

Request Body schema: application/json
required

Данные для обновления цепочки событий

eventChainCcode
required
string

Уникальный код цепочки событий. Задаётся пользователем при создании (POST). В PUT-запросе игнорируется — берётся из path-параметра eventChainCcode.

eventChainName
required
string

Наименование цепочки

businessStreamCcode
required
string

Код бизнес-направления

checkOfferType
required
string
Enum: "ANY" "ALL"

Проверка офферов (ANY — хотя бы один, ALL — все)

checkPriorityFlag
required
string
Enum: "Y" "N"

Проверка приоритета (Y — требуется, N — не требуется)

priorityWeight
integer [ 1 .. 100 ]

Вес цепочки (диапазон 1–100, default 60)

startDttm
required
string

Дата начала. Формат DD.MM.YYYY.

endDttm
required
string

Дата окончания. Формат DD.MM.YYYY.

deletedFlag
required
string
Enum: "N" "Y"

Флаг активности (N — активна, Y — не активна)

required
Array of objects
required
Array of objects
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "eventChainName": "Цепочка лояльности",
  • "businessStreamCcode": "RTM",
  • "checkOfferType": "ANY",
  • "startDttm": "15.10.2025",
  • "endDttm": "31.12.2025",
  • "checkPriorityFlag": "Y",
  • "deletedFlag": "N",
  • "priorityWeight": 80,
  • "steps": [
    ],
  • "segment": [
    ],
  • "mapping": [
    ]
}

Response samples

Content type
application/json
{
  • "eventChainCcode": "1001"
}

Получение списка бизнес-стримов

Возвращает список активных бизнес-направлений (бизнес-стримов). Метод не поддерживает параметры фильтрации и всегда возвращает записи с deletedFlag = 'N'.

Authorizations:
bearerAuth
header Parameters
Tenant-Id
required
string
Enum: "retail" "sme"

Идентификатор пространства (схемы БД). retail — работает со схемой rts_retail, sme — работает со схемой rts_sme.

Responses

Response samples

Content type
application/json
{
  • "businessStreams": [
    ]
}

Получение списка источников событий

Возвращает полный список источников событий (без фильтрации). Результат отсортирован по наименованию источника (eventSourceName) по возрастанию.

Authorizations:
bearerAuth
header Parameters
Tenant-Id
required
string
Enum: "retail" "sme"

Идентификатор пространства (схемы БД). retail — работает со схемой rts_retail, sme — работает со схемой rts_sme.

Responses

Response samples

Content type
application/json
{
  • "eventSources": [
    ]
}

Получить список параметров

Возвращает список параметров по коду источника события.

Authorizations:
bearerAuth
query Parameters
eventSourceCcode
required
string [ 1 .. 200 ] characters

Уникальный код источника события. Обязательный параметр. Не может быть пустой строкой. Длина: 1..200 символов. Пробелы по краям игнорируются (trim).

header Parameters
Tenant-Id
required
string
Enum: "retail" "sme"

Идентификатор пространства (схемы БД). retail — работает со схемой rts_retail, sme — работает со схемой rts_sme.

Responses

Response samples

Content type
application/json
{
  • "parameters": [
    ]
}

Блокировка объекта

Устанавливает временную блокировку на объект для указанного пользователя. Пользователь определяется автоматически из JWT-токена (поле preferred_username). Срок действия: 3 часа с момента создания или продления. При повторном вызове тем же пользователем для того же объекта: - Блокировка продлевается на 3 часа - Возвращается тот же lockId с обновлённым expiresAt. Истёкшие блокировки (expires_at <= текущее время) автоматически игнорируются системой. Записи старше 7 дней удаляются фоновым процессом.

Authorizations:
bearerAuth
header Parameters
Tenant-Id
required
string
Enum: "retail" "sme"

Идентификатор пространства (схемы БД). retail — работает со схемой rts_retail, sme — работает со схемой rts_sme.

Request Body schema: application/json
required
objectName
required
string
Enum: "EVENT" "EVENT-CHAIN"

Идентификатор объекта (enum-код объекта)

entityId
required
string

Идентификатор записи объекта

Responses

Request samples

Content type
application/json
{
  • "objectName": "EVENT",
  • "entityId": "12345"
}

Response samples

Content type
application/json
{
  • "lockId": "cdfa40c4-a40d-4932-a36d-4e3e6b4f7142",
  • "expiresAt": "18.05.2026 17:45:23"
}

Разблокировка объекта

Снимает блокировку с объекта вручную. Пользователь определяется автоматически из JWT-токена (поле preferred_username). Разблокировка доступна только владельцу блокировки или пользователю с ролью ADMIN.

Authorizations:
bearerAuth
query Parameters
objectName
required
string
Enum: "EVENT" "EVENT-CHAIN"

Идентификатор объекта (enum-код объекта)

entityId
required
string

Идентификатор записи объекта

header Parameters
Tenant-Id
required
string
Enum: "retail" "sme"

Идентификатор пространства (схемы БД). retail — работает со схемой rts_retail, sme — работает со схемой rts_sme.

Responses

Response samples

Content type
application/json
Example
{
  • "error": "objectName является обязательным параметром"
}

Проверка состояния блокировки

Проверяет наличие активной блокировки на объекте.

Authorizations:
bearerAuth
query Parameters
objectName
required
string
Enum: "EVENT" "EVENT-CHAIN"

Идентификатор объекта (enum-код объекта)

entityId
required
string

Идентификатор записи объекта, например уникальный идентификатор события

header Parameters
Tenant-Id
required
string
Enum: "retail" "sme"

Идентификатор пространства (схемы БД). retail — работает со схемой rts_retail, sme — работает со схемой rts_sme.

Responses

Response samples

Content type
application/json
{
  • "isLocked": true,
  • "userName": "v.ivanov",
  • "expiresAt": "15.10.2025 14:30:00"
}

Получение информации о настройке приоритета

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

Authorizations:
bearerAuth
header Parameters
Tenant-Id
required
string
Enum: "retail" "sme"

Идентификатор пространства (схемы БД). retail — работает со схемой rts_retail, sme — работает со схемой rts_sme.

Responses

Response samples

Content type
application/json
{
  • "prioritySettings": [
    ]
}

Изменение активной настройки режима работы priority-service

Вносит изменения в параметр активности настройки приоритета по ID.

Authorizations:
bearerAuth
path Parameters
pk
required
integer

Идентификатор настройки

header Parameters
Tenant-Id
required
string
Enum: "retail" "sme"

Идентификатор пространства (схемы БД). retail — работает со схемой rts_retail, sme — работает со схемой rts_sme.

Request Body schema: application/json
required
paramValue
required
string

Новое значение активной настройки

Responses

Request samples

Content type
application/json
{
  • "paramValue": "REALTIME"
}

Response samples

Content type
application/json
{
  • "paramValue": "REALTIME"
}

Получение шаблона маппинга

Возвращает шаблон маппинга параметров для заданного бизнес-направления.

Authorizations:
bearerAuth
path Parameters
businessStreamCcode
required
string [ 1 .. 50 ] characters

Код бизнес-направления. Длина: 1..50 символов

header Parameters
Tenant-Id
required
string
Enum: "retail" "sme"

Идентификатор пространства (схемы БД). retail — работает со схемой rts_retail, sme — работает со схемой rts_sme.

Responses

Response samples

Content type
application/json
{
  • "mapping": [
    ]
}

Поиск и получение справочной информации по счётчикам

Возвращает список счётчиков с возможностью фильтрации по заданным параметрам. Поля counterCcode, startDt, endDt и counterIncType являются обязательными.

Authorizations:
bearerAuth
header Parameters
Tenant-Id
required
string
Enum: "retail" "sme"

Идентификатор пространства (схемы БД). retail — работает со схемой rts_retail, sme — работает со схемой rts_sme.

Request Body schema: application/json
required
eventId
integer

ID события

counterCcode
required
string

Код счётчика (обязательно)

counterName
string

Описание/наименование счётчика

startDt
required
string

Дата начала периода действия (формат ISO 8601 или dd.MM.yyyy) (обязательно)

endDt
required
string

Дата окончания периода действия (формат ISO 8601 или dd.MM.yyyy) (обязательно)

counterIncType
required
string

Тип инкремента счётчика (обязательно)

counterIncAttr
string

Значение/атрибут инкремента

Responses

Request samples

Content type
application/json
{
  • "eventId": 101,
  • "counterCcode": "CNT_PURCHASES",
  • "counterName": "Количество покупок",
  • "startDt": "2025-01-01",
  • "endDt": "2025-12-31",
  • "counterIncType": "SUM",
  • "counterIncAttr": "amount"
}

Response samples

Content type
application/json
{
  • "counters": [
    ]
}

Обновление или создание записи в справочнике

Обновляет существующую запись в справочнике или создаёт новую, если запись с указанным PK не существует (UPSERT-логика).

Tenant-Id: метод работает с учётом заголовка Tenant-Id:

  • retail — работаем со схемой rts_retail
  • sme — работаем со схемой rts_sme

Авторизация: требуется Bearer JWT-токен с правами на запись (администратор). Пользователи с правами только на чтение получат 403.

Audit-поля: поля USER_MODIFY и UPDATE_DTTM заполняются автоматически из JWT-токена и текущей timestamp. Передавать их в requestBody не нужно.

Валидация: выполняется динамически через метаданные таблицы (типы данных, NOT NULL constraints, длина строк). Ограничения БД (CHECK, UNIQUE, FOREIGN KEY) обрабатываются через механизм constraint violations.

Response коды:

  • 200 OK — запись с указанным PK существовала, выполнено обновление
  • 201 Created — запись с указанным PK не существовала, выполнено создание
Authorizations:
bearerAuth
path Parameters
tableName
required
string

Наименование таблицы в схеме, определённой по переданному значению Tenant-Id

header Parameters
Tenant-Id
required
string
Enum: "retail" "sme"

Код пространства для определения схемы в БД

Request Body schema: application/json
required

JSON-объект с динамической структурой, соответствующей колонкам таблицы.

Обязательно должен присутствовать Primary Key таблицы.

Не передавайте поля USER_MODIFY и UPDATE_DTTM — они заполняются автоматически.

Формат дат: DD.MM.YYYY для полей типа DATE без времени, DD.MM.YYYY HH:mm:ss для полей с временем.

property name*
additional property
any

Responses

Request samples

Content type
application/json
Example
{
  • "PK": 2328220,
  • "EVENT_CHAIN_CCODE": "ACLUB_RESPONSE_CC",
  • "EVENT_CHAIN_NAME": "Обновлённое название цепочки",
  • "BUSINESS_STREAM_CCODE": "METRICA",
  • "CHECK_OFFER_TYPE": "ANY",
  • "START_DTTM": "01.01.2024",
  • "END_DTTM": "31.12.2100",
  • "DELETED_FLAG": "N",
  • "CHECK_PRIORITY_FLAG": "N",
  • "PRIORITY_WEIGHT": 20
}

Response samples

Content type
application/json
{
  • "PK": 2328220,
  • "EVENT_CHAIN_CCODE": "ACLUB_RESPONSE_CC",
  • "EVENT_CHAIN_NAME": "Обновлённое название цепочки",
  • "BUSINESS_STREAM_CCODE": "METRICA",
  • "CHECK_OFFER_TYPE": "ANY",
  • "START_DTTM": "01.01.2024",
  • "END_DTTM": "31.12.2100",
  • "USER_MODIFY": "U_M25K9",
  • "UPDATE_DTTM": "19.05.2026 14:23:15",
  • "DELETED_FLAG": "N",
  • "CHECK_PRIORITY_FLAG": "N",
  • "PRIORITY_WEIGHT": 20
}

Получение данных справочника по наименованию таблицы

Возвращает данные справочника с учётом пагинации по переданному наименованию таблицы.

Tenant-Id: метод работает с учётом заголовка Tenant-Id:

  • retail — работаем со схемой rts_retail
  • sme — работаем со схемой rts_sme

Авторизация: требуется Bearer JWT-токен в заголовке Authorization.

Authorizations:
bearerAuth
path Parameters
tableName
required
string

Наименование таблицы в схеме, определённой по переданному значению Tenant-Id

query Parameters
offset
required
integer >= 0

Смещение (0-based)

limit
required
integer [ 1 .. 100 ]

Количество записей на странице

header Parameters
Tenant-Id
required
string
Enum: "retail" "sme"

Код пространства для определения схемы в БД

Responses

Response samples

Content type
application/json
{
  • "meta": [
    ],
  • "data": [
    ]
}