DetectDocumentTitles

Метод возвращает возможные типы переданного документа.

POST /DetectDocumentTitles
Query Parameters:
 
  • boxId – идентификатор ящика
Body:

бинарное содержимое документа

GET /DetectDocumentTitles
Query Parameters:
 
  • boxId – идентификатор ящика
  • nameOnShelf – имя файла на «полке документов»
Request Headers:
 
Status Codes:
  • 200 OK – операция успешно завершена
  • 401 Unauthorized – в запросе отсутствует HTTP-заголовок Authorization, или в этом заголовке содержатся некорректные авторизационные данные
  • 403 Forbidden – доступ к ящику с предоставленным авторизационным токеном запрещен
  • 404 Not Found – не найден ящик по переданному boxId
  • 500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка

Метод можно использовать в двух случаях:

  • POST запрос с заполненным body
  • GET запрос с nameOnShelf параметром, если контент был загружен на полку через ShelfUpload

Тело ответа будет содержать структуру DetectTitleResponse с описанием типов документов:

message DetectTitleResponse {
    repeated DetectedDocumentTitle DocumentTitles = 1;
}

message DetectedDocumentTitle {
    required string TypeNamedId = 1;
    required string Function = 2;
    required string Version = 3;
    required int32 TitleIndex = 4;
    repeated Events.MetadataItem Metadata = 5;
}

Примечание

Метод будет пытаться детектировать только по тем типам документов, которые доступны в конкретной организации.