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

MoveDocuments

Перемещает документы в указанное подразделение организации.

POST /MoveDocuments

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

Тело запроса

Тело запроса должно содержать информацию для перемещения документов между подразделениями, представленную структурой DocumentsMoveOperation.

Коды ответа

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

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

Метод работает по следующим правилам:

  • Одновременно можно переместить до 1000 документов. Если количество документов в запросе превышает 1000, метод вернет ошибку 400 (Bad Request).
  • Документы из закрытого пакета документов нельзя перемещать отдельно от всего пакета. Если в запросе переданы не все документы из закрытого пакета, метод вернет ошибку 400 (Bad Request).
  • Если в запросе содержатся неверные идентификаторы, метод вернет ошибку 400 (Bad Request). Все перечисленные в запросе документы не будут перемещены.
  • Если документы из запроса уже находятся в указанном подразделении, то никаких изменений не произойдет, а запрос завершится успешно.

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

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

POST /MoveDocuments HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Content-Type: application/json; charset=utf-8
Accept: application/json

Пример тела запроса:

{
"BoxId": "09ae254c-5cd0-4082-84de-7ccb46d86f82",
"ToDepartmentId": "022882f3-f29e-4611-8fa5-93385df7ac0f",
"DocumentIds": [
{
"MessageId": "a73ca2e3-3d5c-4207-886c-9b854c179e15",
"EntityId": "d084afd4-ec41-4fb6-9b5b-cf3e3ac5bef7"
},
{
"MessageId": "a23dac5c-9c6a-4b20-91ed-69b3a7ce6158",
"EntityId": "1ada67c0-aa8b-4f31-af8e-53660275f1b3"
},
{
"MessageId": "d94982e8-7eb9-4993-8c52-41c14e3fc3a8 ",
"EntityId": "05ea290d-9aa1-4291-a87b-d30be9ccf5b7"
}
]
}

См. также

Инструкции:

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

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

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

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

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