Перейти к основному содержимому

Исправить расхождения индекса

POST /api/v1/knowledge-integrity/journal/{scanId}/remediate​

Повторно проверяет расхождения и в фоне восстанавливает недостающие записи индекса или удаляет подтверждённые лишние записи.

URL​

https://app.helpfy.ai/api/v1/knowledge-integrity/journal/{scanId}/remediate

Адрес своей установки подставьте вместо https://app.helpfy.ai. Идентификаторы в фигурных скобках замените значениями из ответов API.

Заголовки​

ЗаголовокЗначение
AuthorizationBasic <base64(email:api_key)>
Acceptapplication/json

Для JSON-тела передайте Content-Type: application/json.

Подробнее — авторизация API.

Параметры запроса​

Параметры пути​

ПараметрТипОбязательныйОписание
scanIdстрокаДаИдентификатор проверки.

Тело запроса (application/json)​

ПолеТипОбязательноОписание
issue_typesмассив: MISSING_IN_MYSQL, MISSING_IN_POSTGRESНетТипы расхождений для повторной проверки и исправления. По умолчанию проверяются оба поддерживаемых типа.

Пример запроса​

curl --request POST 'https://app.helpfy.ai/api/v1/knowledge-integrity/journal/11111111-1111-4111-8111-111111111111/remediate' \
--user 'user@example.com:api_key' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-binary @- <<'JSON'
{
"issue_types": [
"MISSING_IN_MYSQL"
]
}
JSON

Ответы​

HTTPОписание
201Успешный ответ
Пример ответа — HTTP 201

Сокращённый пример; показаны клиентские поля. Значения условные.

{
"message": "Integrity remediation queued",
"remediation_id": "1dc964ef-9e17-4933-9ddc-ad1894460500"
}