Trigger_Management Налаштування: тригери, або набори правил

Owned by Оксана Нечепоренко
Last updated: Aug 29, 2022
3 min read

URL https://secure.ubki.ua/m2/

Test URL https://test.ubki.ua/m2/

Список тригерів моніторингу

get /trigger

Запит на отримання списку створених тригерів які рекомендовано УБКІ та створених організацією (якщо name -пусто), та пошук за назвою тригера.

Подачу запиту необхідно здійснювати в тілі GET методу.

 

Parameters

Параметр

Назва

Формат

Параметр

Назва

Формат

name

Назва тригера для пошуку

integer

 

 

Request URL https://secure.ubki.ua/m2/trigger

Response body
[
{
"id": 1,
"name": "АСВП Юрособи з більш ніж 2-ма наявними діючими виконавчими провадженнями (рекомендовано УБКІ)",
"dataSource": "asvp",
"createDate": null,
"editDate": "2021-12-15 13:57:54",
"description": " АСВП Кількість всіх діючих ВП на {voteDate} по ІПН {subjectCode} як {subjectRole} з {credName} "
},
{
"id": 2,
"name": "КІ. Закриті кредити (рекомендовано УБКІ)",
"dataSource": "credit",
"createDate": null,
"editDate": "2021-12-14 15:22:29",
"description": "Закриті кредити для ИНН {inn} "
},
{
"id": 3,
"name": "ЕДР тільки зміна засновника без відображення всіх інших змін (рекомендовано УБКІ) ",
"dataSource": "edr",
"createDate": null,
"editDate": "2021-12-14 14:07:16",
"description": "Зміна засновника по юрособі {edrpou}"
},

]

Параметр

Назва

Формат

Параметр

Назва

Формат

TriggerBriefDto

id

Номер тригера

integer

name*

Назва тригера

string
maxLength: 150
minLength: 10

dataSource

Джерело даних

string

[ asvp, edr, rrp, credit, drorm, wagedebt, taxdebt, bankruptcy, inspection ]

createDate

Дата створення тригера

string($date-time)

[YYYY-MM-DD HH.MM.SS], YYYY - рік (1920 - 2099), MM - місяць (01 - 12), DD - день (01-31), HH - година (00 - 23), MM - хвилина (00 - 59), SS - секунда (00-59)

editDate

Дата редагування тригера

string($date-time)

[YYYY-MM-DD HH.MM.SS], YYYY - рік (1920 - 2099), MM - місяць (01 - 12), DD - день (01-31), HH - година (00 - 23), MM - хвилина (00 - 59), SS - секунда (00-59)

description

Опис тригера

string
maxLength: 200
minLength: 10

 

Створення тригера

post /trigger

Запит на створення тригера.

Подачу запиту необхідно здійснювати в тілі POST методу.

Request https://secure.ubki.ua/m2/trigger

 

No parameters


Request body
New trigger data
{
"name": "ЄДР тільки зміна засновника ",
"description": "Зміна засновника по юрособі {edrpou}",
"dataSource": "edr",
"rules": [
{
"type": "changed",
"watchingFields": [
"founder"
],

"aggregation": [

{

"operation": "count",

"fields": [

"string"

]

}

],
"params": [
{
"field": "string",
"condition": "more",
"value": "string"
}
]
}
]
}

Response body

{
"id": 16,
"name": "ЄДР тільки зміна засновника ",
"description": "Зміна засновника по юрособі {edrpou}",
"dataSource": "edr",
"createDate": "2022-02-01 14:31:07",
"editDate": null,
"rules": [
{
"type": "changed",
"watchingFields": [
"founder"
],

"aggregation": [

{

"operation": "count",

"fields": [

"string"

]

}

],
"params": [
{
"field": "string",
"condition": "more",
"value": "string"
}
]
}
]
}


Параметр

Назва

Формат

Параметр

Назва

Формат

TriggerDto

id

Номер тригера

integer

name

Назва тригера

string
maxLength: 150
minLength: 10

description

Опис тригера
Для опису можна використовувати поля CaseData,наприклад:
"Нове провадження для {subjectCode} як {subjectRole} з {credName}",

"АСВП Кількість всіх діючих ВП на {voteDate} по ІПН {subjectCode} як {subjectRole} з {credName}"

string
maxLength: 200
minLength: 10

dataSource

Джерело даних

 

string

 

createDate

Дата створення тригера

string($date-time)

[YYYY-MM-DD HH.MM.SS], YYYY - рік (1920 - 2099), MM - місяць (01 - 12), DD - день (01-31), HH - година (00 - 23), MM - хвилина (00 - 59), SS - секунда (00-59)

editDate

Дата редагування тригера

string($date-time)

[YYYY-MM-DD HH.MM.SS], YYYY - рік (1920 - 2099), MM - місяць (01 - 12), DD - день (01-31), HH - година (00 - 23), MM - хвилина (00 - 59), SS - секунда (00-59)

rules

Набір правил

 

 

TriggerRuleDto Набір правил

type

Тип івента/події

 

watchingFields

Список полів, що відстежуються

string

params

 

Параметри правил

 

RuleParameterDto Параметри правил

field

Поле, значення кого перевіряється

string

condition

Умова

string

value

Значення параметра

string

aggregationDto Параметри агрегації

operation

Операція агрегації

string

fields

Поля, значення яких агрегуються

string

 

Параметри тригера

get /trigger/{triggerId}

Запит на отримання параметрів створеного тригера.

Подачу запиту необхідно здійснювати в тілі GET методу.

 

Parameters

Параметр

Назва

Формат

Параметр

Назва

Формат

triggerID

Номер тригера для пошуку

integer


Request https://secure.ubki.ua/m2/trigger/{triggerID}

Response body

{
"id": 16,
"name": "ЄДР тільки зміна засновника ",
"description": "Зміна засновника по юрособі {edrpou}",
"dataSource": "edr",
"createDate": "2022-02-01 14:31:07",
"editDate": null,
"rules": [
{
"type": "changed",
"watchingFields": [
"founder"
],

"aggregation": [

{

"operation": "count",

"fields": [

"string"

]

}

],
"params": [
{
"field": "string",
"condition": "more",
"value": "string"
}
]
}
]
}

  1. Опис відповіді див. в запиті Створення тригера Trigger_ManagementНалаштування: тригери, або набори правил | :~:text=Формат ,TriggerDto, id

Редагування тригера

Запит на редагування тригера( зміна: назви, набору правил, строку роботи, пареметрів правил).
Подачу запиту необхідно здійснювати в тілі POST методу.

Request https://secure.ubki.ua/m2/trigger/triggerID

 

Parameters

Параметр

Назва

Формат

Параметр

Назва

Формат

triggerID

Номер тригера

integer

 

Request body

New trigger data

{
"name": "ЄДР юрособи із закритим статусом та з відображенням всіх інших змін ",
"description": "ЄДР юрособа із закритим статусом {edrpou} ",
"dataSource": "edr",
"createDate": null,
"editDate": "2021-12-14 12:26:18",
"rules": [
{
"type": "all",
"watchingFields": [],
"params": []
},
{
"type": "closed",
"watchingFields": [],

"aggregation": [

{

"operation": "count",

"fields": [

"string"

]

}

],
"params": []
}
]
}
}
Response body

Response body
Download
{
"id": 16,
"name": "ЄДР юрособи із закритим статусом та з відображенням всіх інших змін ",
"description": "ЄДР юрособа із закритим статусом {edrpou} ",
"dataSource": "edr",
"createDate": null,
"editDate": "2022-02-01 14:56:56",
"rules": [
{
"type": "all",
"watchingFields": [],

"aggregation": [

{

"operation": "count",

"fields": [

"string"

]

}

],
"params": []
},
{
"type": "closed",
"watchingFields": [],
"params": []
}
]
}

 

  1. Опис відповіді див. в запиті Створення тригера Trigger_ManagementНалаштування: тригери, або набори правил | :~:text=Формат ,TriggerDto, id

Копіювання тригера

Запит на створення копії тригера з однаковими параметрами та правилами.

Подачу запиту необхідно здійснювати в тілі POST методу.

Request https://secure.ubki.ua/m2/trigger/{triggerID}/copy

 

Parameters

Параметр

Назва

Формат

Параметр

Назва

Формат

triggerID

Номер тригера

integer

 

Response body
{
"id": 19,
"name": "(Копія) ЄДР юрособи із закритим статусом та з відображенням всіх інших змін ",
"description": "ЄДР юрособа із закритим статусом {edrpou} ",
"dataSource": "edr",
"createDate": "2022-02-01 14:58:33",
"editDate": "2022-02-01 14:58:33",
"rules": [
{
"type": "closed",
"watchingFields": [],
"params": []
},
{
"type": "all",
"watchingFields": [],
"params": []
}
]
}

  1. Опис відповіді див. в запиті Створення тригера Trigger_ManagementНалаштування: тригери, або набори правил | :~:text=Формат ,TriggerDto, id

Видалення тригера