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

SearchDocflows (V3)

warning

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

Выполняет поиск документов по строке запроса.

POST /V3/SearchDocflows

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

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

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

Тело запроса

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

Коды ответа

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

Тело ответа

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

В ответе вернутся только те документы, к которым у пользователя есть доступ.

Метод разбивает строку запроса SearchDocflowsRequest.QueryString следующими способами:

  • Метод разбивает строку на токены по пробелам и разделительным символам. В ответ метода попадают документы, у которых хотя бы один из полученных токенов содержится в номере, дате, имени файла или других данных.
  • Если строка запроса имеет вид «ключ: значение», то метод разбивает строку в соответствии с форматом YAML. В ответ метода попадут документы, которые содержат указанную пару «ключ-значение» среди пользовательских данных, привязанных к документу.

Список документов Documents в ответе SearchDocflowsResponseV3 может содержать не больше 100 элементов. Поэтому:

  • Если найденных документов меньше 100, то метод вернет их полностью.

  • Если найденных документов больше 100, то в ответе Documents вернутся только первые 100 элементов.

    В этом случае получить весь список найденных документов можно постранично. Для этого вызывайте метод SearchDocflows с теми же параметрами запроса и с указанием параметра FirstIndex структуры запроса SearchDocflowsRequest до тех пор, пока список документов не будет вычитан полностью. В качестве параметра FirstIndex нужно указывать индект документа, с которого нужно начать очередную страницу.

При разработке интеграционного решения учитывайте, что в очередной странице может не быть ни одного документа.

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

Пример запроса с использованием C# SDK:

SearchDocflowsResponseV3 SearchDocflowsV3(string authToken, string boxId, SearchDocflowsRequest request);

Пример поиска документов по строке

Пример запроса с использованием C# SDK:

Постраничное получение документов, содержащих строку «Пример».

var request = new SearchDocflowsRequest { QueryString = "Пример" };
while (true)
{
var response = api.Docflow.SearchDocflowsV3(token, boxId, request);
Console.Out.WriteLine("Fetched {0} documents", response.Documents.Count);
if (!response.HaveMoreDocuments)
break;
request.FirstIndex += response.Documents.Count;
}

См. также

Инструкции:

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

  • GetDocflowEvents (V4) — возвращает список событий, произошедших с документами
  • GetDocflowEvents (V5) — возвращает список событий, произошедших с документами, корректно отображая данные для многотитульных документов
  • GetDocflows (V4) — возвращает список документов с информацией о документообороте по их идентификаторам
  • GetDocflows (V5) — возвращает список документов с информацией о документообороте по их идентификаторам, корректно отображая данные для многотитульных документов
  • GetDocflowsByPacketId (V4) — возвращает список документов, находящихся в пакете
  • GetDocflowsByPacketId (V5) — возвращает список документов, находящихся в пакете, корректно отображая данные для многотитульных документов
  • SearchDocflows (V4) — выполняет поиск документов по строке запроса
  • SearchDocflows (V5) — выполняет поиск документов по строке запроса, корректно отображая данные для многотитульных документов

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

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

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