Отозвать заметку
/memory/{note_id}/revokeПередайте status=revoked и текущую version. Метод позволяет отозвать заметку. Он не позволяет подтвердить её.
Передайте ключ организации в заголовке Authorization: Bearer <ключ>.
Пример запроса
Используйте NK_BASE и NK_KEY из быстрого старта. Переменные в пути, например RUN_ID, замените значениями из ваших ответов API.
curl --fail-with-body -X POST "$NK_BASE/memory/$NOTE_ID/revoke" \
-H "Authorization: Bearer $NK_KEY" \
-H "Content-Type: application/json" \
--data-binary @request.jsonСохраните тело запроса в request.json. Его поля описаны ниже.
Параметры
| Параметр | Где / тип | Обязательный | Описание |
|---|---|---|---|
note_id | Путь строка | Да | Используйте идентификатор вашей организации. Идентификатор из ответа API. |
Тело запроса
application/json
versionцелое число · обязательное- Текущая версия заметки.
statusстрока · обязательное- Отзыв клиентом. Значения: "revoked".
Ответы и ошибки
200
Успешный ответ.
application/json
Поля ответа
note_idстрока · необязательное- Идентификатор заметки.
feedback_idстрока · необязательное- Решение, на основании которого предложена заметка.
bundle_idстрока · необязательное- Комплект, к которому относится заметка.
contentстрока · необязательное- Содержание.
kindстрока · необязательное- Тип заметки. Значения: "fact", "preference", "interpretation".
statusстрока · необязательное- Состояние заметки. Значения: "candidate", "confirmed", "revoked".
versionцелое число · необязательное- Версия заметки.
automatic_applicationда / нет · необязательное- Применяется ли заметка автоматически. Сейчас значение равно false.
created_atстрока · необязательное- Время создания.
actorстрока · необязательное- Автор интеграции.
401
Ключ не передан, неверен или отозван.
application/json
Поля ответа
detailобъект / массив: объект / строка · обязательное- Обычно объект с error. При ошибке проверки параметров возможен список нарушений.
Вложенные поля
errorстрока · обязательное- Машинный код ошибки. Используйте его в обработчике.
messageстрока · необязательное- Пояснение для человека. Текст может меняться.
fileстрока · необязательное- Проблемный файл, если ошибка относится к нему.
Массив элементов:
locмассив: строка / целое число · необязательное- Путь до неверного поля.
msgстрока · необязательное- Причина нарушения.
typeстрока · необязательное- Код нарушения.
inputобъект · необязательное- Переданное значение.
Текст ошибки, если сервер не вернул объект.
403
Доступ закрыт или действие не разрешено.
application/json
Поля ответа
detailобъект / массив: объект / строка · обязательное- Обычно объект с error. При ошибке проверки параметров возможен список нарушений.
Вложенные поля
errorстрока · обязательное- Машинный код ошибки. Используйте его в обработчике.
messageстрока · необязательное- Пояснение для человека. Текст может меняться.
fileстрока · необязательное- Проблемный файл, если ошибка относится к нему.
Массив элементов:
locмассив: строка / целое число · необязательное- Путь до неверного поля.
msgстрока · необязательное- Причина нарушения.
typeстрока · необязательное- Код нарушения.
inputобъект · необязательное- Переданное значение.
Текст ошибки, если сервер не вернул объект.
404
Объект не найден, результат ещё не опубликован либо дополнительный метод недоступен в подключении.
application/json
Поля ответа
detailобъект / массив: объект / строка · обязательное- Обычно объект с error. При ошибке проверки параметров возможен список нарушений.
Вложенные поля
errorстрока · обязательное- Машинный код ошибки. Используйте его в обработчике.
messageстрока · необязательное- Пояснение для человека. Текст может меняться.
fileстрока · необязательное- Проблемный файл, если ошибка относится к нему.
Массив элементов:
locмассив: строка / целое число · необязательное- Путь до неверного поля.
msgстрока · необязательное- Причина нарушения.
typeстрока · необязательное- Код нарушения.
inputобъект · необязательное- Переданное значение.
Текст ошибки, если сервер не вернул объект.
409
Конфликт версии или метки отправки. Возможная причина для отчёта: нет привязки к запрошенному разделу.
application/json
Поля ответа
detailобъект / массив: объект / строка · обязательное- Обычно объект с error. При ошибке проверки параметров возможен список нарушений.
Вложенные поля
errorстрока · обязательное- Машинный код ошибки. Используйте его в обработчике.
messageстрока · необязательное- Пояснение для человека. Текст может меняться.
fileстрока · необязательное- Проблемный файл, если ошибка относится к нему.
Массив элементов:
locмассив: строка / целое число · необязательное- Путь до неверного поля.
msgстрока · необязательное- Причина нарушения.
typeстрока · необязательное- Код нарушения.
inputобъект · необязательное- Переданное значение.
Текст ошибки, если сервер не вернул объект.
422
Ошибка валидации: detail содержит объект с кодом либо список нарушений.
application/json
Поля ответа
detailобъект / массив: объект / строка · обязательное- Обычно объект с error. При ошибке проверки параметров возможен список нарушений.
Вложенные поля
errorстрока · обязательное- Машинный код ошибки. Используйте его в обработчике.
messageстрока · необязательное- Пояснение для человека. Текст может меняться.
fileстрока · необязательное- Проблемный файл, если ошибка относится к нему.
Массив элементов:
locмассив: строка / целое число · необязательное- Путь до неверного поля.
msgстрока · необязательное- Причина нарушения.
typeстрока · необязательное- Код нарушения.
inputобъект · необязательное- Переданное значение.
Текст ошибки, если сервер не вернул объект.
Другой ответ
Ошибка входного сервера или сети может иметь текстовое/HTML-тело. Проверяйте HTTP-статус и Content-Type.