Load Kafka Migration Structure
Этот API endpoint облегчает загрузку структуры миграции Kafka с поддержкой различных форматов вывода, включая JSON и TXT. Опционально позволяет фильтровать бизнес-объекты участвующие в миграции на основе предоставленных кодов бизнес объектов (БО).
Запрос (Request):
POST /kafka_migration/settings/load-json-in-structure?migrationType=IN_MIGRATION&outputFormat=JSON
Content-Type: application/json
API-TOKEN/TOKEN: your_token
{
"boCodesToSkip": ["Person", "BO1"],
"boCodesToAdd": []
}
- Метод: POST
- URL: /kafka_migration/settings/load-json-in-structure
- Параметры (Params):
- migrationType (Обязателен): Тип миграции IN_MIGRATION или OUT_MIGRATION
- outputFormat (Не обязателен): Формат получаемого файла TXT или JSON, по умолчанию TXT
- Тело запроса (Не обязателен): Это объект фильтр для кодов бизнес-объектов (БО) участвующих в миграции со следующими полями:
- boCodesToAdd: Список кодов БО которые нужно добавить, остальные БО будут пропущены.
- boCodesToSkip: Список кодов БО которые нужно пропустить, остальные БО будут добавлены.
- Вы можете указать либо boCodesToAdd, либо boCodesToSkip, не оба одновременно.
- Headers:
Content-Type: application/json API-TOKEN/TOKEN: your_token
- Как получить API_TOKEN или TOKEN?
Ответ (Response):
Успешным ответом будет следующее содержимое с кодом состояния 200, если параметер outputFormat = TXT
------------------------------------------------------------------------------------------------------------------------
Миграция одной инстанции БО: Департамент с кодом Department
{
"id" : "Идентификатор системы MyBPM",
"boCode" : "Department",
"fields" : [ {
"code" : "name",
"apiValue" : "Имя : INPUT_TEXT"
} ],
"boFields" : [ {
"fieldCode" : "header",
"toBoCode" : "Person",
"apiValue" : "Руководитель : BO"
}, {
"fieldCode" : "person",
"toBoCode" : "Person",
"apiValue" : "Пользователи : BO"
}, {
"fieldCode" : "parent",
"toBoCode" : "Department",
"apiValue" : "Родительское подразделение : BO"
} ]
}
Если outputFormat = JSON, будет следующее содержимое с типом ответа application/json
[
{
"id": "Идентификатор системы MyBPM",
"boCode": "Department",
"fields": [
{
"code": "name",
"apiValue": "Имя : INPUT_TEXT"
}
],
"boFields": [
{
"fieldCode": "header",
"toBoCode": "Person",
"apiValue": "Руководитель : BO"
},
{
"fieldCode": "person",
"toBoCode": "Person",
"apiValue": "Пользователи : BO"
},
{
"fieldCode": "parent",
"toBoCode": "Department",
"apiValue": "Родительское подразделение : BO"
}
]
},
{
"id": "Идентификатор системы MyBPM",
"boCode": "PersonGroup",
"fields": [
{
"code": "name",
"apiValue": "Имя : INPUT_TEXT"
}
],
"boFields": [
{
"fieldCode": "users",
"toBoCode": "Person",
"apiValue": "Пользователи : BO"
},
{
"fieldCode": "header",
"toBoCode": "Person",
"apiValue": "Руководитель : BO"
}
]
}
]
Ошибки
В случае ошибок тело ответа будет содержать сообщение об ошибке вместе с соответствующим кодом состояния HTTP.