Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

...

...

...

...

...

...

...

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

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

...

List of monitoring triggers

Info

Status
colourBlue
titleget
/trigger

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

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

Parameters

Назва тригера для пошуку
Expand
titleДетальніше

Параметр

Назва

Формат

name

More details

Request to receive a list of generated triggers, recommended by the UBCH and generated by the organization (if the name is empty), and searching by the trigger name.

The request must be submitted in the GET method body.

Parameters

Parameter

Name

Format

name

The name of the trigger to search for

integer

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

Response body
[
{
"id": 1,
"name": "АСВП Юрособи з більш ніж 2-ма наявними діючими виконавчими провадженнями (рекомендовано УБКІEnforcement Proceedings Automated System. Legal entities with over 2 valid enforcement proceedings (recommended by the UBCH)",
"dataSource": "asvp",
"createDate": null,
"editDate": "2021-12-15 13:57:54",
"description": " АСВП Кількість всіх діючих ВП на Enforcement Proceedings Automated System. Number of all the valid enforcement proceedings from {voteDate} по ІПН by TIN {subjectCode} як as {subjectRole} з with {credName} "
},
{
"id": 2,
"name": "КІ. Закриті кредити (рекомендовано УБКІCredit history. Closed loans (recommended by the UBCH)",
"dataSource": "credit",
"createDate": null,
"editDate": "2021-12-14 15:22:29",
"description": "Закриті кредити для ИНН Closed loans for TIN {inn} "
},
{
"id": 3,
"name": "ЕДР тільки зміна засновника без відображення всіх інших змін (рекомендовано УБКІUnified State Register: founder change only, without displaying all the other changes (recommended by the UBCH) ",
"dataSource": "edr",
"createDate": null,
"editDate": "2021-12-14 14:07:16",
"description": "Зміна засновника по юрособі Founder change by legal entity {edrpou}"
},

]

Параметр

Parameter

Назва

Name

Формат

Format

TriggerBriefDto

idНомер

тригераTrigger number

integer

name*

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

string
maxLength: 150
minLength: 10

dataSourceДжерело

данихData source

string

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

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

Trigger generation date

string($date-time)

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

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

Date of trigger revision

string($date-time)

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

descriptionОпис

тригераTrigger description

string
maxLength: 200
minLength: 10

...

Trigger generation

Info

Status
colourGreen
titlepost
/trigger

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

Подачу запиту необхідно здійснювати в тілі POST методу
Expand
titleДетальніше
More details

Trigger generation request

The request must be submitted in the POST method body.

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

No parameters


Request body
New trigger data
{
"name": "ЄДР тільки зміна засновника Unified State Register: founder change only",
"description": "Зміна засновника по юрособі Founder change by legal entity {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": "ЄДР тільки зміна засновника Unified State Register: founder change only",
"description": "Зміна засновника по юрособі Founder change by legal entity {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"
}
]
}
]
}

Параметр

Parameter

Назва

Name

Формат

Format

TriggerDto

idНомер

тригераTrigger number

integer

nameНазва

тригераTrigger name

string
maxLength: 150
minLength: 10

description

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

"АСВП Кількість всіх діючих ВП на {voteDate} по ІПН {subjectCode} як {subjectRole} з {credName}"Trigger description
You can use CaseData fields for description, e.g.:
“New proceedings for {subjectCode} as {subjectRole} with {credName}”,
“Enforcement Proceedings Automated System. Number of all the valid enforcement proceedings from {voteDate} by TIN {subjectCode} as {subjectRole} with {credName}”

string
maxLength: 200
minLength: 10

dataSourceДжерело

данихData source

string

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

Trigger generation date

string($date-time)

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

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

Date of trigger revision

string($date-time)

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

rulesНабір

правилRule set

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

typeТип

івента/подіїEvent type

https://wiki-ubki.atlassian.net/wiki/spaces/SpecSpecification/pages/123666793124912394

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

List of monitored fields

string

https://wiki-ubki.atlassian.net/wiki/spaces/SpecSpecification/pages/123666853124912466

paramsПараметри

правилRule parameters

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

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

Field with the inspected value

string

condition

УмоваCondition

string

https://wiki-ubki.atlassian.net/wiki/spaces/SpecSpecification/pages/123666823124912430

valueЗначення

параметраParameter value

string

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

operationОперація

агрегаціїAggregation operation

string

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

Fields with aggregated values

string

...

Trigger parameters

Info

Status
colourBlue
titleget
/trigger/{triggerId}

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

Подачу запиту необхідно здійснювати в тілі GET методу
Expand
titleДетальніше
More details

Request to receive generated trigger parameters

The request must be submitted in the GET method body.

Parameters

Параметр

Parameter

Назва

Name

Формат

Format

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

The trigger number to search for

integer


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

Response body

{
"id": 16,
"name": "ЄДР тільки зміна засновника Unified State Register: founder change only",
"description": "Зміна засновника по юрособі Founder change by legal entity {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"
}
]
}
]
}

...

Trigger revision

Info

Status
colourGreen
titlepost
/trigger/{triggerId}

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

Request for trigger revision (change: names, rule set, operation period, rule parameters)

The request must be submitted in the POST method body.

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

Parameters

Параметр

Parameter

Назва

Name

Формат

Format

triggerIDНомер

тригера Trigger number

integer

Request body

New trigger data

{
"name": "ЄДР юрособи із закритим статусом та з відображенням всіх інших змін Unified State Register number of the legal entity with a closed status, displaying all the other changes",
"description": "ЄДР юрособа із закритим статусом Unified State Register number of the legal entity with a closed status {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": "ЄДР юрособи із закритим статусом та з відображенням всіх інших змін Unified State Register number of the legal entity with a closed status, displaying all the other changes",
"description": "ЄДР юрособа із закритим статусом Unified State Register number of the legal entity with a closed status {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": []
}
]
}

...

Copying the trigger

Info

Status
colourGreen
titlepost
/trigger/{triggerId}/copy

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

Подачу запиту необхідно здійснювати в тілі POST методу
Expand
titleДетальніше
More details

Request to create a copy of the trigger with the same parameters and rules

The request must be submitted in the POST method body.

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

Parameters

Параметр

Parameter

Назва

Name

Формат

Format

triggerIDНомер

тригера Trigger number

integer

Response body
{
"id": 19,
"name": "(Копія) ЄДР юрособи із закритим статусом та з відображенням всіх інших змін Copy) Unified State Register number of the legal entity with a closed status, displaying all the other changes",
"description": "ЄДР юрособа із закритим статусом Unified State Register number of the legal entity with a closed status {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": []
}
]
}

...

Trigger deletion

Info

Status
colourGreen
titlepost
/trigger/{triggerId}/delete

Запит на видалення тригера( можливий, якщо тригер створений організацією)
Подачу запиту необхідно здійснювати в тілі POST методу
Expand
titleДетальніше
More details

Request to delete the trigger (possible if the trigger is generated by the organization)

The request must be submitted in the POST method body.

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


Parameters

Параметр

Parameter

Назва

Name

Формат

Format

triggerIDНомер

тригера Trigger number

integer

Response body

true (boolean)