Trigger_Management Settings: triggers or rule sets
URL https://secure.ubki.ua/m2/
Test URL https://test.ubki.ua/m2/
List of monitoring triggers
get /trigger
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 |
|---|
Parameter | Name | Format |
|---|---|---|
name | The name of the trigger to search for | integer |
Request URL https://secure.ubki.ua/m2/trigger
Response body[{"id": 1,"name": "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 |
|---|
Parameter | Name | Format |
|---|---|---|
TriggerBriefDto | ||
id | Trigger number | integer |
name* | Trigger name | string |
dataSource | Data source | string [ asvp, edr, rrp, credit, drorm, wagedebt, taxdebt, bankruptcy, inspection ] |
createDate | Trigger generation date | string($date-time) [YYYY-MM-DD], YYYY – year (1920–2099), MM – month (01–12), DD – 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], YYYY – year (1920–2099), MM – month (01–12), DD – day (01–31), HH - hour (00 - 23), MM - minute (00 - 59), SS - second (00-59) |
description | Trigger description | string |
Trigger generation
post /trigger
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 |
|---|
Parameter | Name | Format |
|---|---|---|
TriggerDto | ||
id | Trigger number | integer |
name | Trigger name | string |
description | Trigger description | string |
dataSource | Data source | string
|
createDate | Trigger generation date | string($date-time) [YYYY-MM-DD], YYYY – year (1920–2099), MM – month (01–12), DD – 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], YYYY – year (1920–2099), MM – month (01–12), DD – 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/Specification/pages/124912394 |
watchingFields | List of monitored fields | string https://wiki-ubki.atlassian.net/wiki/spaces/Specification/pages/124912466 |
params | Rule parameters |
|
RuleParameterDto Rule parameters | ||
field | Field with the inspected value | string |
condition | Condition | string https://wiki-ubki.atlassian.net/wiki/spaces/Specification/pages/124912430 |
value | Parameter value | string |
aggregationDto Parameter value | ||
operation | Aggregation operation | string |
fields | Fields with aggregated values | string |
Trigger parameters
Request to receive generated trigger parameters
The request must be submitted in the GET method body.
Parameters
Parameter | Name | Format |
|---|
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"}]}]}
- The response description see in the Trigger Generation request Trigger_ManagementНалаштування: тригери, або набори правил | :~:text=Формат ,TriggerDto, id
Trigger revision
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 |
|---|
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 bodyDownload{"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": []}]}
- The response description see in the Trigger Generation request Trigger_ManagementНалаштування: тригери, або набори правил | :~:text=Формат ,TriggerDto, id
Copying the trigger
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 |
|---|
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": []}]}
- The response description see in the Trigger Generation request Trigger_ManagementНалаштування: тригери, або набори правил | :~:text=Формат ,TriggerDto, id