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

GetDocflows (V2)

warning

Метод устарел и будет удален из API после 03 апреля 2027 года. Подробнее в истории изменений. Используйте актуальную версию метода — GetDocflows (V5).

Метод GetDocflows возвращает список документов с информацией о документообороте по их идентификаторам. Для каждого документа возвращаются данные, которые характеризуют его текущее состояние: информация о документообороте и метаданные.

POST /V2/GetDocflows

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

  • boxId — идентификатор ящика организации в формате GUID.

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

Тело запроса

Тело запроса должно содержать список структуру GetDocflowBatchRequest.

Коды ответа

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

Тело ответа

Тело ответа содержит список документов с информацией о документообороте, представленный структурой GetDocflowBatchResponse.

Метод добавляет в ответ всю информацию, относящуюся к цепочке документооборота, в том числе бинарные представления документов и подписей. Но метод имеет ограничение на суммарный размер всех бинарных представлений, хранящихся в поле GetDocflowBatchResponse.Documents.Docflow.DocumentAttachment.Attachment.Entity.Content.Data, — он не должен превышать 1048576 байт. Если при добавлении очередного бинарного представления суммарный размер превысит это значение, то оно не будет добавлено в ответ метода. Вы можете получить такое бинарное представление с помощью метода GetEntityContent (V4).

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

SDK
GetDocflowBatchResponse GetDocflowsV2(string authToken, string boxId, GetDocflowBatchRequest request);

Пример использования (C#)

Получение двух документов и вывод на консоль признака завершенности их документооборота.

var request = new GetDocflowBatchRequest
{
Requests =
{
new GetDocflowRequest
{
DocumentId = new DocumentId(messageId1, documentId1),
InjectEntityContent = true
},
new GetDocflowRequest
{
DocumentId = new DocumentId(messageId2, documentId2),
InjectEntityContent = false,
LastEventId = lastEventId
}
}
};
var response = api.GetDocflowsV2(token, boxId, request);
foreach (var doc in response.Documents)
Console.Out.WriteLine(doc.Docflow.IsFinished);

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

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

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