SearchDocflows (V2)
Метод устарел и будет удален из API после 03 апреля 2027 года. Подробнее в истории изменений. Используйте актуальную версию метода — SearchDocflows (V5).
Метод SearchDocflows производит поиск документа по строке запроса.
POST /V2/SearchDocflows
Параметры запроса
boxId— идентификатор ящика организации в формате GUID.
Заголовки запроса
Authorization— данные, необходимые для авторизации.
Тело запроса
Тело запроса должно содержать структуру SearchDocflowsRequest.
Коды ответа
200— операция успешно завершена.400— данные в запросе имеют неверный формат или отсутствуют обязательные параметры.401— в запросе отсутствует HTTP-заголовокAuthorizationили в этом заголовке содержатся некорректные авторизационные данные.402— у организации с указанным идентификаторомboxIdзакончилась подписка на API.403— доступ к ящику с предоставленным авторизационным токеном запрещен.405— используется неподходящий HTTP-метод.500— при обработке запроса возникла непредвиденная ошибка.
Тело ответа
Тело ответа содержит список документов, представленный структурой SearchDocflowsResponse.
В ответе вернутся только те документы, к которым у пользователя есть доступ.
Метод разбивает строку запроса SearchDocflowsRequest.QueryString следующими способами:
- Метод разбивает строку на токены по пробелам и разделительным символам. В ответ метода попадают документы, у которых хотя бы один из полученных токенов содержится в номере, дате, имени файла или других данных.
- Если строка запроса имеет вид «ключ: значение», то метод разбивает строку в соответствии с форматом YAML. В ответ метода попадут документы, которые содержат указанную пару «ключ-значение» среди пользовательских данных, привязанных к документу.
Список документов в ответе может содержать не больше 100 элементов. Если документов больше, их можно получить постранично. Для получения очередной страницы передайте в поле запроса SearchDocflowsRequest.FirstIndex индекс документа, с которого нужно начать выгрузку.
При разработке интеграционного решения учитывайте, что в очередной странице может не быть ни одного документа.
SDK
SearchDocflowsResponse SearchDocflowsV2(string authToken, string boxId, SearchDocflowsRequest request);
Пример использования (C#)
Постраничное получение документов, содержащих строку «Пример».
var request = new SearchDocflowsRequest { QueryString = "Пример" };
while (true)
{
var response = api.SearchDocflowsV2(token, boxId, request);
Console.Out.WriteLine("Fetched {0} documents", response.Documents.Count);
if (!response.HaveMoreDocuments)
break;
request.FirstIndex += response.Documents.Count;
}