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

Delete

Отмечает указанный документ как удаленный.

POST /Delete

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

  • boxId — идентификатор ящика организации в формате GUID.
  • messageId — идентификатор сообщения.
  • documentId — идентификатор документа в сообщении. Необязательный параметр.

Заголовки запроса

Коды ответа

  • 200 — операция успешно завершена.
  • 400 — данные в запросе имеют неверный формат или отсутствуют обязательные параметры.
  • 401 — в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.
  • 402 — у указанного ящика закончилась подписка на API.
  • 403 — доступ к ящику с предоставленным авторизационным токеном запрещен.
  • 404 — не найдены документ или сообщение с указанным идентификатором.
  • 405 — используется неподходящий HTTP-метод.
  • 409 — документ или сообщение уже удалены.
  • 429 — превышено ограничение на количество запросов в единицу времени.
  • 500 — при обработке запроса возникла непредвиденная ошибка.

Для выполнения метода текущий пользователь должен иметь доступ ко всем удаляемым документам, иначе метод вернет ошибку 403 (Forbidden).

Метод может удалять не только сообщения Message, но и шаблоны Template. Для этого в качестве параметра messageId нужно передать идентификатор сообщения шаблона.

Если параметр documentId не задан, то будет удалено сообщение messageId. В этом случае все документы в нем будут помечены как удаленные. Если из сообщения удален последний документ, то и само сообщение или шаблон будет помечено как удаленное.

Примеры использования

Пример HTTP-запроса:

POST /Delete?boxId={{boxid}}&messageid={{messageid}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json

См. также

Инструкции:

Методы для работы с документами:

  • Delete — отмечает указанный документ как удаленный
  • GetContent — возвращает XSD-схему документа
  • GetDocument (V3) — возвращает данные документа по указанному идентификатору
  • GetDocumentActions — возвращает список действий, доступных текущему пользователю для указанного документа, шаблона или черновика
  • GetDocumentHistory — возвращает историю событий по указанному документу, шаблону или черновику
  • GetDocuments (V3) — возвращает список документов, соответствующих заданным параметрам
  • GetDocuments (V4) — возвращает список документов, соответствующих заданным параметрам
  • GetDocumentsByMessageId — возвращает список документов из указанного сообщения
  • GetDocumentTypes (V2) — возвращает список типов документов, доступных в ящике
  • GetDocumentTypes (V3) — возвращает список типов документов, доступных в ящике, и дату перехода на универсальные сообщения
  • MoveDocuments — перемещает документы в указанное подразделение организации
  • Restore — восстанавливает документ из удаленных

Оцените материал страницы

Нашли ошибку или столкнулись с проблемой?

СКБ Контурс 1988 года