Monitoring_Data Отримання результатів моніторингу

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

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

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

Журнал роботи пула, статистика по дням і тригерам

Get /data/{poolId}/journal

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

Request https://secure.ubki.ua/m2/data/{poolID}/journal?{sinceDate}&{untilDate}

 

Parameters

Параметр

Назва

Формат

Параметр

Назва

Формат

poolID

Номер пула

integer

sinceDate

З дати

string [YYYY-MM-DD], YYYY - рік (1920 - 2099), MM - місяць (01 - 12), DD - день

untilDate

По дату

string [YYYY-MM-DD], YYYY - рік (1920 - 2099), MM - місяць (01 - 12), DD - день

Responses

 

Парметр

Назва

Формат

Парметр

Назва

Формат

PoolJournalDto

poolID

Номер пула

integer

poolName

Назва пула

string

processingDate

Дата даних

string($date) [YYYY-MM-DD], YYYY - рік (1920 - 2099), MM - місяць (01 - 12), DD - день

workState

Стан роботи на даний момент

string

[ new, closed, done, wip, failed ]

innCount

Кількість перевірених суб'єктів

integer

triggerCount

Кількість перевірених тригерів

integer

checkedCount

Кількість перевірок

integer

eventCount

Кількість знайдених змін і відповідно подій у джерелах даних

integer

caseCount

Кількість відфільтрованих тригер-кейсів згідно з правилами підключених тригерів

integer

insertAt

Час початку обробки пула

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)

updateAt

Час закінчення обробки пула

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)

 

Отримання останіх результатів роботи пулу(списку нових спрацювань)

gET /data/{poolId}/latest

Подачу запиту необхідно здійснювати в тілі GET методу.
Request https://secure.ubki.ua/m2/data/{poolID}/latest?{caseId}&{page}&{size}


Parameters

Параметр

Назва

Формат

Параметр

Назва

Формат

poolID

Номер пула

integer

caseId

Ідентифікатор тригер-кейсу

string

(Default value : пусто)

page

Сторінка

integer

(Default value : 0),

size

Кількість тигер-кейсів (спрацювань) на сторінці

integer

(Default value : 20)


Responses

 

Парметр

Назва

Формат

Парметр

Назва

Формат

PoolResponseData

 

poolId

Ідентифікатор пула

integer

poolName

Назва пула

string

poolState

Стан пула

string

[ created, active, inactive, finished, invalid ]

poolExecState

Стан роботи на даний момент

string

[ new, closed, done, wip, failed ]

since

Початковий час вигрузки перевірок пула

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)

until

Кінцевий час вигрузки перевірок пула

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)

lastCaseId

Ідентифікатор останньоrо кейсу даної вигрузки для юзера

string($uuid)

dataSources

Джерела даних пула

uniqueItems string

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

innCount

Кількість перевірених іпн/єдрпоу пула за час існування пула

integer

eventCount

Кількість виявлених змін у джерелах даних за час існування пула

integer

caseCount

Кількість знайдених кейсів за час існування пула

integer

totalCheckCount

Кількість перевірок всього за час існування пула

integer

 

todayCheckingCount

Кількість запланованих перевірок на сьогодні, всього

integer

todayCheckedCount

Кількість уже перевірених пар іпн:тригер сьогодні

integer

SubjectPoolData

 

 

subjectChanges

Дані змін по моніторингу

 

subjectCode

Код клієнта, ІПН або ЄДРПОУ

string

datasourceEvents

Зміни у джерелі даних по клієнту,

у RFC6902 форматі

eventId

Ідентифікатор події джерела даних

string($uuid)

subjectCode

Код клієнта, ІПН або ЄДРПОУ

string

dataSource

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

 

string

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

currentDate

Дата перевірки/виявлення змін

string($date)

[YYYY-MM-DD HH.MM.SS], YYYY - рік (1920 - 2099), MM - місяць (01 - 12), DD - день (01-31)

eventDate

Дата коли зміни відбулися фактично

string($date)

[YYYY-MM-DD HH.MM.SS], YYYY - рік (1920 - 2099), MM - місяць (01 - 12), DD - день (01-31)

eventFoundAt

Дата-час перевірки/виявлення змін

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)

baseDate

Дата попередньої перевірки/виявлення змін

string($date)

[YYYY-MM-DD HH.MM.SS], YYYY - рік (1920 - 2099), MM - місяць (01 - 12), DD - день (01-31)

upPatch

Додаткові або агреговані дані

 

downPatch

Додаткові або агреговані дані

 

TriggerCaseData

 

caseId

Ідентифікатор тригер-кейсу

string($uuid)

 

caseDate

Дата змін по кейсу

string($date)

[YYYY-MM-DD HH.MM.SS], YYYY - рік (1920 - 2099), MM - місяць (01 - 12), DD - день (01-31)

caseTriggerDate

Дата/час перевірки/виявлення змін

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)

subjectCode

Код клієнта, ІПН або ЄДРПОУ

string

 

triggerId

Тригер, що спрацював

integer

 

caseMessage

Повідомлення тригер-кейсу

string

 

caseData

Поточний зріз даних

 

 

baseDate

Дата попередньої перевірки/виявлення змін

string($date)

[YYYY-MM-DD HH.MM.SS], YYYY - рік (1920 - 2099), MM - місяць (01 - 12), DD - день (01-31)

baseData

Попередній зріз даних

 

 

additionalInfo

Додаткові або агреговані дані

 

 

dataSource

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

 

string

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

eventId

Ідентифікатор події джерела даних

string($uuid)

 

todayPoolProgress

Прогрес розрахунку пула за сьогодні

number($double)

 

additionalInfoDto - Інформація за агрегацією даних

subjectCode

Код клієнта, ІПН або ЄДРПОУ

string

currentDate

Дата розрахунку агрегації

string($date)

[YYYY-MM-DD HH.MM.SS], YYYY - рік (1920 - 2099), MM - місяць (01 - 12), DD - день (01-31)

dlamtexpSum

Результат розрахунок агрегації

number($double)

count

Кількість об'єктів, що брали участь у розрахунку

integer

currentDataCount

Кількість об'єктів у поточному зрізі

integer

baseDataCount

Кількість об'єктів у попередньому зрізі

integer

casesCount

Кількість кейсів

integer

Отримання результатів роботи пула за період . Список подій і статистика по пулу

Get /data/{poolId}/results

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

Request https://secure.ubki.ua/m2/data/{poolId}/results?{sinceDate}&{untilDate}&{page}&{size}


Parameters

Параметр

Назва

Формат

Параметр

Назва

Формат

poolID

Номер пула

integer

sinceDate

З дати

string [YYYY-MM-DD], YYYY - рік (1920 - 2099), MM - місяць (01 - 12), DD - день

untilDate

По дату

string [YYYY-MM-DD], YYYY - рік (1920 - 2099), MM - місяць (01 - 12), DD - день

page

Сторінка

integer

(Default value : 0),

size

Кількість тигер-кейсів (спрацювань) на сторінці

integer

(Default value : 20)


Responses

 

Параметр

Назва

Формат

Параметр

Назва

Формат

PoolResponseData

poolId

Ідентифікатор пула

integer

poolName

 

Назва пула

string

poolState

Стан пула

 

 

[ created, active, inactive, finished, invalid ]

poolExecState

Стан роботи на даний момент



string

[ new, closed, done, wip, failed ]

since

Початковий час вигрузки перевірок пула

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)

 

until

Кінцевий час вигрузки перевірок пула

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)

lastCaseId

Ідентифікатор останньоrо кейсу даної вигрузки для юзера

string($uuid)

 

dataSources

Джерела даних пула

 

uniqueItems: true

TriggerDataSourcestring

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

 

string

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

innCount

Кількість перевірених іпн/єдрпоу пула за час існування пула

integer

 

eventCount

Кількість виявлених змін у джерелах даних за час існування пула

integer

 

caseCount

Кількість знайдених кейсів за час існування пула

integer

 

totalCheckCount

Кількість перевірок всього за час існування пула

integer

 

todayCheckingCount

Кількість запланованих перевірок на сьогодні, всього

integer

 

todayCheckedCount

Кількість уже перевірених пар іпн:тригер сьогодні

integer

 

SubjectPoolData

 

 

subjectChanges

Дані змін по моніторингу

 

subjectCodestring

Код клієнта, ІПН або ЄДРПОУ

string

datasourceEvents

Зміни у джерелі даних по клієнту,

у RFC6902 форматі

eventId

Ідентифікатор події джерела даних

string($uuid)

subjectCode

Код клієнта, ІПН або ЄДРПОУ

string

dataSource

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

 

string

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

currentDate

Дата перевірки/виявлення змін

string($date)

[YYYY-MM-DD HH.MM.SS], YYYY - рік (1920 - 2099), MM - місяць (01 - 12), DD - день (01-31)

eventDate

Дата коли зміни відбулися фактично

string($date)

[YYYY-MM-DD HH.MM.SS], YYYY - рік (1920 - 2099), MM - місяць (01 - 12), DD - день (01-31)

eventFoundAt

Дата-час перевірки/виявлення змін

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)

baseDate

Дата попередньої перевірки/виявлення змін

string($date)

[YYYY-MM-DD HH.MM.SS], YYYY - рік (1920 - 2099), MM - місяць (01 - 12), DD - день (01-31)

upPatch

Додаткові або агреговані дані

 

downPatch

Додаткові або агреговані дані

 

TriggerCaseData

 

caseId

Ідентифікатор тригер-кейсу

string($uuid)

 

caseDate

Дата змін по кейсу

string($date)

 

caseTriggerDate

Дата/час перевірки/виявлення змін

string($date-time)

 

subjectCode

Код клієнта, ІПН або ЄДРПОУ

string

 

triggerId

Тригер, що спрацював

integer

 

caseMessage

Повідомлення тригер-кейсу

string

 

caseData

Додаткові або агреговані дані

 

 

baseDate

Дата попередньої перевірки/виявлення змін

string($date)

[YYYY-MM-DD HH.MM.SS], YYYY - рік (1920 - 2099), MM - місяць (01 - 12), DD - день (01-31)

baseData

Додаткові або агреговані дані

 

 

additionalInfo

Додаткові або агреговані дані

 

 

dataSource

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

 

string

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

eventId

Ідентифікатор події джерела даних

string($uuid)

 

todayPoolProgress

Прогрес розрахунку пула за сьогодні

number($double)

 

additionalInfoDto - Інформація за агрегацією даних

subjectCode

Код клієнта, ІПН або ЄДРПОУ

string

currentDate

Дата розрахунку агрегації

string($date)

[YYYY-MM-DD HH.MM.SS], YYYY - рік (1920 - 2099), MM - місяць (01 - 12), DD - день (01-31)

dlamtexpSum

Результат розрахунок агрегації

number($double)

count

Кількість об'єктів, що брали участь у розрахунку

integer

currentDataCount

Кількість об'єктів у поточному зрізі

integer

baseDataCount

Кількість об'єктів у попередньому зрізі

integer

casesCount

Кількість кейсів

integer

 

Перегляд даних події по ідентифікатору

Request https://secure.ubki.ua/m2/data/event/{eventId}

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

 

Parameters

Параметр

Назва

Формат

Параметр

Назва

Формат

eventId

Ідентифікатор події джерела даних

string

Responses

Параметр

Назва

Формат

Параметр

Назва

Формат

eventId

Ідентифікатор події джерела даних

string($uuid)

 

eventDate

Дата коли зміни відбулися фактично

string($date)

[YYYY-MM-DD HH.MM.SS], YYYY - рік (1920 - 2099), MM - місяць (01 - 12), DD - день (01-31)

subjectCode

Код клієнта, ІПН або ЄДРПОУ

string

dataSource

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

 

string

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

workPeriod

Періодичність роботи

string

[daily, weekly, monthly]

createdAt

Дата створення пула

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)

currentDate

Дата перевірки/виявлення змін

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)

currentData

Актуальні дані

string

baseDate

Дата попередньої перевірки/виявлення змін

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)

baseData

Попередні дані

string

upPatchData

Зміни даних згідно RFC-6902

 

downPatchData

Зміни даних згідно RFC-6902

 

Перегляд даних тригер-кейсу по ідентифікатору

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

Request https://secure.ubki.ua/m2/data/case/{caseId}

 

Parameters

Параметр

Назва

Формат

Параметр

Назва

Формат

caseId

Ідентифікатор події тригер-кейсу

string

Responses

Параметр

Назва

Формат

Параметр

Назва

Формат

caseId

Ідентифікатор події тригер-кейсу

string

eventId

Ідентифікатор події джерела даних

string($uuid)

 

createdAt
TriggerCaseData

Дата створення пула

Дата/час перевірки/виявлення змін

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)

processingDate

 

Дата даних

 

string($date) [YYYY-MM-DD], YYYY - рік (1920 - 2099), MM - місяць (01 - 12), DD - день

subjectCode

Код клієнта, ІПН або ЄДРПОУ

string

poolID

Номер пула

integer

triggerId

номер тригера, що спрацював

integer

caseMessage

Повідомлення тригер-кейсу

string

 

caseDate

Дата змін по кейсу

string($date)

 

caseData

Додаткові або агреговані дані

 

string

additionalInfo

Додаткова інформація за кейсом

string

changedFields

Поля які змінилися

string

dataSource

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

 

string

https://wiki-ubki.atlassian.net/wiki/spaces/Spec/pages/123666763