Pool_Management Налаштування: пули ІПН/ЄДРПОУ, що моніторяться тригерами

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

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

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

GET /pool

Запит на отримання списку всіх створених пулів організації (якщо name -пусто) , та пошук за назвою пулу.

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

Request https://secure.ubki.ua/m2/pool?{name}

Parameters

Параметр	Назва	Формат

Параметр	Назва	Формат
name	Назва пула для пошуку	integer

Response

Параметр	Назва	Формат

Параметр	Назва	Формат
PoolBriefDto
poolID	Номер пула	integer
poolName	Назва пула	string maxLength: 150 minLength: 3
createDate	Дата створення пула	string($date-time)
poolState	Стан пула	string [ created, active, inactive, finished, invalid ]
workPeriod	Періодичність роботи	string [ daily, weekly, monthly ]
workTime	Строк роботи, у місяцях	integer
workCount	Кількість запусків	integer
doneTotalCount	Кількість спрацювань	integer
workEndDate	Дата закінчення роботи	string($date) [YYYY-MM-DD], YYYY - рік (1920 - 2099), MM - місяць (01 - 12), DD - день (01-31)
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)
editUser	UserId користувача який відредагував	integer
firstStartDate	Дата першого запуску	string($date) [YYYY-MM-DD], YYYY - рік (1920 - 2099), MM - місяць (01 - 12), DD - день (01-31)
lastStartDate	Дата останнього запуску	string($date) [YYYY-MM-DD], YYYY - рік (1920 - 2099), MM - місяць (01 - 12), DD - день (01-31)
lastInnCount	Кількість інн	integer
lastDoneCount	Кількість спрацювань в останньому запуску	integer
lastWorkState	Стан роботи на даний момент	integer [ new, closed, done, wip, failed ]

Створення пула

post/pool

Запит на створення пула ("poolState": "created")

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

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

No parameters

Request body

{
"poolName": "Pool_test ",
"workPeriod": "daily",
"workEndDate": "2022-02-01",
"inns": [
"33546706"
],
"triggers": [
1
]
}

Response body
{
"poolID": 12,
"poolName": "Pool_test ",
"createDate": "2022-02-01 10:58:16",
"poolState": "created",
"workPeriod": "daily",
"workTime": 0,
"workCount": 0,
"doneTotalCount": 0,
"workEndDate": "2022-02-01",
"editDate": null,
"editUser": null,
"firstStartDate": "2022-02-01",
"lastStartDate": null,
"lastInnCount": 0,
"lastDoneCount": 0,
"lastWorkState": "new",
"inns": [
"33546706"
],
"triggers": [
1
]
}

Параметр	Назва	Формат

Параметр	Назва	Формат
PoolDto
poolID	Номер пула	integer
poolName	Назва пула	string maxLength: 150 minLength: 3
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)
poolState	Стан пула	string [ created, active, inactive, finished, invalid ]
workPeriod	Періодичність роботи	string [ daily, weekly, monthly ]
workTime	Строк роботи, у місяцях	integer
workCount	Кількість запусків	integer
doneTotalCount	Кількість спрацювань	integer
workEndDate	Дата закінчення роботи	string($date) [YYYY-MM-DD], YYYY - рік (1920 - 2099), MM - місяць (01 - 12), DD - день (01-31)
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)
editUser	UserId користувача який відредагував	integer
firstStartDate	Дата першого запуску	string($date) [YYYY-MM-DD], YYYY - рік (1920 - 2099), MM - місяць (01 - 12), DD - день (01-31)
lastStartDate	Дата останнього запуску	string($date) [YYYY-MM-DD], YYYY - рік (1920 - 2099), MM - місяць (01 - 12), DD - день (01-31)
lastInnCount	Кількість інн	integer
lastDoneCount	Кількість спрацювань в останньому запуску	integer
lastWorkState	Стан роботи на даний момент	string [ new, closed, done, wip, failed ]
inns	Список ІПН, що відслідковуються пулом	string
triggers	Список тригерів, що відслідковуються пулом	integer

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

GET/pool/{poolId}

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

Request https://secure.ubki.ua/m2/pool/{poolID}

Parameters

Параметр	Назва	Формат

Параметр	Назва	Формат
poolID	Номер пула	integer

Response body
{
"poolID": 12,
"poolName": "Pool_test ",
"createDate": "2022-02-01 10:58:16",
"poolState": "created",
"workPeriod": "daily",
"workTime": 0,
"workCount": 0,
"doneTotalCount": 0,
"workEndDate": "2022-02-01",
"editDate": null,
"editUser": null,
"firstStartDate": "2022-02-01",
"lastStartDate": null,
"lastInnCount": 0,
"lastDoneCount": 0,
"lastWorkState": "new",
"inns": [
"33546706"
],
"triggers": [
1
]
}

Опис відповіді Pool_Management Налаштування: пули ІПН/ЄДРПОУ, що моніторяться тригерами

Редагування пула

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

Request https://secure.ubki.ua/m2/{poolID}

Parameters

Параметр	Назва	Формат

Параметр	Назва	Формат
poolID	Номер пула	integer

Request body
New pool data ( в запиті дані які необхідно змінити)
{
"poolName": "Pool_test",
"workPeriod": "weekly",
"workEndDate": "2022-02-01",
"inns": [
"33546706",
"40075815"
],
"triggers": [
2
]
}

Response body

{
"poolID": 12,
"poolName": "Pool_test",
"createDate": "2022-02-01 10:58:16",
"poolState": "created",
"workPeriod": "weekly",
"workTime": 0,
"workCount": 0,
"doneTotalCount": 0,
"workEndDate": "2022-02-01",
"editDate": "2022-02-01 12:12:31",
"editUser": null,
"firstStartDate": "2022-02-01",
"lastStartDate": null,
"lastInnCount": 0,
"lastDoneCount": 0,
"lastWorkState": "new",
"inns": [
"33546706",
"40075815"
],
"triggers": [
2
]
}

Опис відповіді Pool_Management Налаштування: пули ІПН/ЄДРПОУ, що моніторяться тригерами

Редагування пула: додавання ІПН/ЄДРПОУ

Запит на додавання ІПН/ЄДРПОУ в пул без його зупинки.

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

Request https://secure.ubki.ua/m2/pool/{poolID}/add_inns

Parameters

Параметр	Назва	Формат

Параметр	Назва	Формат
poolID	Номер пула	integer

Request body

New pool inns ( в запиті дані які необхідно додати)
{
"inns": [
"25522107","41078439","40456297"
]
}

Response body

{
"poolID": 12,
"poolName": "Pool_test",
"createDate": "2022-02-01 10:58:16",
"poolState": "created",
"workPeriod": "weekly",
"workTime": 0,
"workCount": 0,
"doneTotalCount": 0,
"workEndDate": "2022-02-01",
"editDate": "2022-02-01 12:12:31",
"editUser": null,
"firstStartDate": "2022-02-01",
"lastStartDate": null,
"lastInnCount": 0,
"lastDoneCount": 0,
"lastWorkState": "new",
"inns": [
"33546706",
"40075815",
"25522107",
"41078439",
"40456297"
],
"triggers": [
2
]
}

Опис відповіді Pool_Management Налаштування: пули ІПН/ЄДРПОУ, що моніторяться тригерами

Специфікація

Pool_Management Налаштування: пули ІПН/ЄДРПОУ, що моніторяться тригерами

Analytics

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

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

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

GET /pool

Створення пула

post/pool

PoolDto

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

GET/pool/{poolId}

Редагування пула

Редагування пула: додавання ІПН/ЄДРПОУ

Запит на додавання ІПН/ЄДРПОУ в пул без його зупинки.

Редагування пула: видалення ІПН/ЄДРПОУ

Активація пула

Вимкнення пула

Копіювання пула

Видалення пула

Related content