SearchDocflows (V4)

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

POST /V4/SearchDocflows
Query Parameters:

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

Request Headers:
Request Body:

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

Status Codes:

  • 200 OK – операция успешно завершена.

  • 400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры.

  • 401 Unauthorized – в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.

  • 402 Payment Required – у указанного ящика закончилась подписка на API.

  • 403 Forbidden – доступ к ящику с предоставленным авторизационным токеном запрещен.

  • 405 Method Not Allowed – используется неподходящий HTTP-метод.

  • 500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.

Response Body:

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

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

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

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

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

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

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

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

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

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

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

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

SearchDocflowsResponseV4 SearchDocflows(string authToken, string boxId, SearchDocflowsRequest request);

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

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

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

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

См. также

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

  • GetDocflowEvents (V3) — возвращает список событий, произошедших с документами

  • GetDocflowEvents (V4) — возвращает список событий, произошедших с документами

  • GetDocflows (V3) — возвращает список документов с информацией о документообороте по их идентификаторам

  • GetDocflows (V4) — возвращает список документов с информацией о документообороте по их идентификаторам

  • GetDocflowsByPacketId (V3) — возвращает список документов, находящихся в пакете

  • GetDocflowsByPacketId (V4) — возвращает список документов, находящихся в пакете

  • SearchDocflows (V3) — выполняет поиск документов по строке запроса

  • SearchDocflows (V4) — выполняет поиск документов по строке запроса

Предыдущие версии метода:
Устаревшие версии метода: