Redque (предварительная версия)

Доступ к системе Redque и управление ими.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга	Class	Регионы
Copilot Studio	Премия	Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD)
Логические приложения	Стандарт	Все регионы Logic Apps , кроме следующих: — Регионы Azure для государственных организаций — Регионы Azure Для Китая - Министерство обороны США (DoD)
Power Apps	Премия	Все регионы Power Apps , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD)
Power Automate	Премия	Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD)

Контакт
Имя	Redque s.r.o.
URL	https://redque.com
Адрес электронной почты	info@redque.com

Метаданные соединителя
Publisher	Redque s.r.o.
Веб-сайт	https://redque.cz/en/
Политика конфиденциальности	https://redque.cz/policy.html
Категории	Искусственный интеллект; Финансировать

Ограничения регулирования

Имя	Вызовы	Период обновления
Вызовы API для каждого подключения	100	60 секунд

Действия

Блокировка документа	Блокировка (открывается) документа, препятствующего другим пользователям изменять его.
Возврат всех перечислений	Возвращает список всех перечислений.
Возврат документа издателю для исправлений	Возвращает документ издателю для исправлений, указанных по адресу электронной почты.
Возврат к конфигурации отправителя	Получение текущей конфигурации для возврата к действию отправителя.
Возврат перечисления	Возвращает определенную перечисление.
Возвращаемый маркер	Возвращает текущий маркер регистрации или ничего, если маркер не активен.
Добавление разрешений	Добавляет разрешения пользователю.
Извлечение документа	Запрашивает извлечение документа. После извлечения документа оно запланировано на удаление.
Изменение пароля	Изменяет пароль пользователя.
Изменение пароля пользователя	Изменяет пароль для указанного пользователя. Требуется разрешение на управление пользователями.
Изображение для данной страницы	Возвращает изображение для данной страницы.
Обновление данных папки	Обновляет данные папок.
Обновление документа	Обновляет документ.
Обновление конкретной перечисления	Обновляет определенную перечисление.
Обновление конфигурации отправителя	Обновления возвращаются в конфигурацию отправителя.
Обновление пользователя	Частично обновляет указанного пользователя.
Отправка документа и планирование его обработки	Отправляет документ и планирует его обработку.
Поиск папки	Находит папку по идентификатору.
Поиск пользователя	Находит пользователя.
Получение извлеченного документа	Извлеченный документ помечается для удаления и удаляется в течение нескольких часов после доступа. Это дает пользователям время повторного получения результата при сбое.
Получение метаданных документа	Возвращает метаданные документа.
Предоставление доступа к документу указанному пользователю	Предоставляет доступ к документу указанному пользователю.
Разблокировать заблокированный документ	Разблокирует заблокированный (закрывает) документ, чтобы другие пользователи могли изменять его содержимое.
Сведения о лицензии	Возвращает сведения о лицензии.
Скачать папку	Загружает все документы в папку в виде одного архива.
Скачивание файла документа	Загружает файл документа.
Создание маркера	Создает новый маркер регистрации.
Создание перечисления	Обратите внимание, что ключ перечисления создается автоматически, и ключи значений должны содержать только строчные буквы, прописные буквы, цифры, подчеркивание, дефис
Создание пользователя	Создает нового пользователя.
Создать папку	Создает новую папку.
Удаление доступа к документу для указанного пользователя	Удаляет доступ к документу для указанного пользователя.
Удаление папки	Удаляет существующую папку.
Удаление пользователя	Удаляет пользователя.
Удаление разрешений	Отменяет разрешения пользователя.
Удаление существующего документа	Удаляет существующий документ.
Удаляет маркер	Удаляет маркер регистрации.
Удаляет перечисление с определенным идентификатором	Удаляет определенную перечисление.
Фильтрация документов	Возвращает список документов на основе параметров.
Фильтрация пользователей	Возвращает список пользователей по критериям.

Блокировка документа

Идентификатор операции:: LockDocument

Блокировка (открывается) документа, препятствующего другим пользователям изменять его.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	documentId	True	string	Идентификатор документа

Возврат всех перечислений

Идентификатор операции:: GetAllEnums

Возвращает список всех перечислений.

Возвращаемое значение

response: array of ApiEnum

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

Идентификатор операции:: ReturnDocument

Возвращает документ издателю для исправлений, указанных по адресу электронной почты.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	documentId	True	string	Идентификатор документа
дополнительныеdocuments	additionalDocuments		array of string
recipientEmail	recipientEmail		string
причина	reason		string
запрошенныйByUserId	requestedByUserId		string

Возврат к конфигурации отправителя

Идентификатор операции:: ReturnDocumentConfiguration

Получение текущей конфигурации для возврата к действию отправителя.

Возврат перечисления

Идентификатор операции:: GetEnum

Возвращает определенную перечисление.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор перечисления	id	True	string	Идентификатор перечисления

Возвращаемое значение

Перечисление данных для типа поля

Тело: ApiEnum

Возвращаемый маркер

Идентификатор операции:: GetRegisterToken

Возвращает текущий маркер регистрации или ничего, если маркер не активен.

Возвращаемое значение

Значение универсального ответа

Тело: StringApiValue

Добавление разрешений

Идентификатор операции:: AddUserPermissions

Добавляет разрешения пользователю.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пользователя	userId	True	string	ID пользователя
permissions	permissions		array of string	Доступ к данным

Извлечение документа

Идентификатор операции:: ExtractDocument

Запрашивает извлечение документа. После извлечения документа оно запланировано на удаление.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	externalDocumentId		string	Идентификатор документа (необязательно— идентификатор внешнего документа)
Файл	file		file	Файл

Изменение пароля

Идентификатор операции:: ChangePassword

Изменяет пароль пользователя.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пользователя	userId	True	string	ID пользователя
body	body		string	Пароль пользователя

Изменение пароля пользователя

Идентификатор операции:: ForceUserPasswordChange

Изменяет пароль для указанного пользователя. Требуется разрешение на управление пользователями.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пользователя	userId	True	string	ID пользователя
пароль	password		string	Пароль пользователя
accountId	accountId		string	Идентификатор учетной записи пользователя
ключ активации	activationkey		string	Ключ активации пользователя

Изображение для данной страницы

Идентификатор операции:: GetImage

Возвращает изображение для данной страницы.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	documentId	True	string	Идентификатор документа
Индекс страницы	pageIndex	True	integer	Индекс страницы
Preview	isPreview		boolean	Значение true, если изображение с уменьшенным размером должно быть возвращено.

Возвращаемое значение

response: uri

Обновление данных папки

Идентификатор операции:: UpdateContainerData

Обновляет данные папок.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор папки	folderId	True	string	Идентификатор папки
folderId	folderId		string	Идентификатор документа.
ownerId	ownerId		string	Идентификатор владельца контейнера
создано	created		date-time	Время создания контейнера
metadata	metadata		object	Все заголовки, подключенные к контейнеру

Обновление документа

Идентификатор операции:: UpdateDocuments

Обновляет документ.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	documentId	True	string	Идентификатор документа
documentId	documentId		string
value	value		string
value	value		string
value	value		string
value	value		string
value	value		string
value	value		string
value	value		string
value	value		boolean
value	value		boolean
value	value		string
value	value		string
Операция	operation		string
key	key		string
сообщение	message		string
isWarning	isWarning		boolean
wordIds	wordIds		array of integer
value	value		string
Операция	operation		string
key	key		string
сообщение	message		string
isWarning	isWarning		boolean
wordIds	wordIds		array of integer
userId	userId		string
userId	userId		string
государство	state		string	Состояние документа
value	value		string
Операция	operation		string
value	value		string
Операция	operation		string

Возвращаемое значение

Данные ответа о состоянии. Используется в качестве ответа, когда запрос не возвращает данные.

Тело: RedQueStatus

Обновление конкретной перечисления

Идентификатор операции:: UpdateEnum

Обновляет определенную перечисление.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор перечисления	id	True	string	Идентификатор перечисления
id	id		string	Идентификатор перечисления
имя	name		string	Понятное имя перечисления
values	values		object	Список значений перечисления
isEditable	isEditable		boolean	Указывает, можно ли изменить перечисление

Обновление конфигурации отправителя

Идентификатор операции:: StoreReturnDocumentConfiguration

Обновления возвращаются в конфигурацию отправителя.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
шаблон	template		string
субъект	subject		string

Обновление пользователя

Идентификатор операции:: UpdateUser

Частично обновляет указанного пользователя.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пользователя	userId	True	string	Идентификатор пользователя
Имя	firstName		string	Имя пользователя
lastName	lastName		string	Фамилия пользователя

Отправка документа и планирование его обработки

Идентификатор операции:: UploadDocumentAsync

Отправляет документ и планирует его обработку.

Параметры

Имя	Ключ	Тип	Описание
Файл	File	file	Файл
Внешний идентификатор документа	DocumentId	string	Идентификатор внешнего документа
Идентификатор папки	FolderId	string	Идентификатор папки
Date	Date	date-time	Date
Заказ	Ordinal	integer	Порядок, используемый для хранения документов, передаваемых параллельно
Документирование вложения	IsAttachment	boolean	Значение True, если документ является вложением
Класс Document	DocumentClass	string	Класс Document

Возвращаемое значение

Результат отправки файла

Тело: ApiUploadResponse

Поиск папки

Идентификатор операции:: GetFolder

Находит папку по идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор папки	folderId	True	string	Идентификатор папки
С элементами	withMembers		boolean	Значение True, если документ с элементами

Возвращаемое значение

Метаданные контейнера с метаданными документов внутри контейнера

Тело: ApiFolderWithMembers

Поиск пользователя

Идентификатор операции:: GetUser

Находит пользователя.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пользователя	userId	True	string	ID пользователя

Возвращаемое значение

Сведения о пользователе

Тело: ApiUser

Получение извлеченного документа

Идентификатор операции:: GetExtractDocument

Извлеченный документ помечается для удаления и удаляется в течение нескольких часов после доступа. Это дает пользователям время повторного получения результата при сбое.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	id	True	string	Идентификатор документа (предоставленный RedQue или external)

Получение метаданных документа

Идентификатор операции:: GetDocument

Возвращает метаданные документа.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	documentId	True	string	Идентификатор документа
Является ли идентификатор документа внешним идентификатором?	isExternalId		boolean	Является ли идентификатор документа внешним идентификатором?

Возвращаемое значение

Тело: ApiDocument

Предоставление доступа к документу указанному пользователю

Идентификатор операции:: GrantDocumentAccess

Предоставляет доступ к документу указанному пользователю.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	documentId	True	string	Идентификатор документа
Идентификатор пользователя	userId	True	string	Идентификатор пользователя
documentId	documentId		string	Идентификатор документа
userId	userId		string	Идентификатор пользователя
сообщение	message		string

Разблокировать заблокированный документ

Идентификатор операции:: UnlockDocumentAsync

Разблокирует заблокированный (закрывает) документ, чтобы другие пользователи могли изменять его содержимое.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	documentId	True	string	Идентификатор документа

Сведения о лицензии

Идентификатор операции:: GetLicenseInfo

Возвращает сведения о лицензии.

Возвращаемое значение

Тело: MLicense

Скачать папку

Идентификатор операции:: DownloadFolderArchived

Загружает все документы в папку в виде одного архива.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор папки	folderId	True	string	Идентификатор папки

Скачивание файла документа

Идентификатор операции:: DownloadFileAsync

Загружает файл документа.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	documentId	True	string	Идентификатор документа

Создание маркера

Идентификатор операции:: GenerateRegistrationToken

Создает новый маркер регистрации.

Возвращаемое значение

Значение универсального ответа

Тело: StringApiValue

Создание перечисления

Идентификатор операции:: CreateEnum

Обратите внимание, что ключ перечисления создается автоматически, и ключи значений должны содержать только строчные буквы, прописные буквы, цифры, подчеркивание, дефис

Параметры

Имя	Ключ	Тип	Описание
id	id	string	Идентификатор перечисления
имя	name	string	Понятное имя перечисления
values	values	object	Список значений перечисления
isEditable	isEditable	boolean	Указывает, можно ли изменить перечисление

Возвращаемое значение

Значение универсального ответа

Тело: StringApiValue

Создание пользователя

Идентификатор операции:: CreateUser

Создает нового пользователя.

Параметры

Имя	Ключ	Тип	Описание
Имя	firstName	string	Имя пользователя
lastName	lastName	string	Фамилия пользователя
пароль	password	string	Пароль учетной записи
электронная почта	email	string	Электронная почта (имя входа) пользователя

Создать папку

Идентификатор операции:: CreateFolder

Создает новую папку.

Возвращаемое значение

Результат создания контейнера

Тело: ApiFolderCreationResult

Удаление доступа к документу для указанного пользователя

Идентификатор операции:: RemoveDocumentAccess

Удаляет доступ к документу для указанного пользователя.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	documentId	True	string	Идентификатор документа
Идентификатор пользователя	userId	True	string	Идентификатор пользователя

Удаление папки

Идентификатор операции:: DeleteFolder

Удаляет существующую папку.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор папки	folderId	True	string	Идентификатор папки

Удаление пользователя

Идентификатор операции:: DeleteUser

Удаляет пользователя.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пользователя	userId	True	string	Идентификатор пользователя

Удаление разрешений

Идентификатор операции:: RemoveUserPermissions

Отменяет разрешения пользователя.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пользователя	userId	True	string	ID пользователя
permissions	permissions		array of string	Доступ к данным

Удаление существующего документа

Идентификатор операции:: DeleteDocument

Удаляет существующий документ.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	documentId	True	string	Идентификатор документа

Удаляет маркер

Идентификатор операции:: DisableRegistrationToken

Удаляет маркер регистрации.

Удаляет перечисление с определенным идентификатором

Идентификатор операции:: DeleteEnum

Удаляет определенную перечисление.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Ключ перечисления	id	True	string	Идентификатор и ключ перечисления

Фильтрация документов

Идентификатор операции:: ListAllDocuments

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

Параметры

Имя	Ключ	Тип	Описание
текст	text	string	Текст поиска, используемый для общего поиска
value	value	string
values	values	string	Состояние документа
values	values	string	Состояние документа
value	value	string
value	value	boolean
values	values	string
values	values	array of string
от / из / с (context-dependent)	from	date-time
Кому	to	date-time
столбцов	fields	object	Фильтры полей
skip	skip	integer	Сколько элементов следует пропустить с начала списка. Разрешает разбиение на страницы.
take	take	integer	Максимальное количество возвращаемых элементов списка
поле	field	string	Список свойств, по которым можно отсортировать результаты
направление	direction	string	Направление сортировки значений списка
scopes	scopes	string	Область документа, которая фильтрует части документа.

Возвращаемое значение

Результат поиска

Тело: ApiDocumentApiListResult

Фильтрация пользователей

Идентификатор операции:: ListOfUsers

Возвращает список пользователей по критериям.

Параметры

Имя	Ключ	Тип	Описание
текст	text	string	Текст поиска, используемый для общего поиска
value	value	string
skip	skip	integer	Сколько элементов следует пропустить с начала списка. Разрешает разбиение на страницы.
take	take	integer	Максимальное количество возвращаемых элементов списка
поле	field	string	Перечисление для объявления параметров сортировки пользователя
направление	direction	string	Направление сортировки значений списка

Возвращаемое значение

Результат поиска

Тело: ApiUserApiListResult

Определения

ApiApproval

Имя	Путь	Тип	Описание
Утверждающий	approver	ApiUser	Сведения о пользователе
approvalStepTime	approvalStepTime	date-time	Время назначения текущему утверждающего.
утверждениеState	approvalState	ApprovalState	Состояние документа
delegatedTo	delegatedTo	ApiUser	Сведения о пользователе
заметка	note	string	Примечание утверждающего

ApiApprovalReminder

Имя	Путь	Тип	Описание
fromUser	fromUser	ApiUser	Сведения о пользователе
toUser	toUser	ApiUser	Сведения о пользователе
sentTime	sentTime	date-time	Время отправки
заметка	note	string	Примечание о срочности

ApiDocument

Имя	Путь	Тип	Описание
documentId	documentId	string	Идентификатор документа
externalDocumentId	externalDocumentId	string	Идентификатор внешнего документа
folderId	folderId	string	Идентификатор контейнера документа
contentHash	contentHash	string	Хэш содержимого
pageCount	pageCount	integer	Общее количество страниц в документе — 1. Это число может не совпадать с количеством страниц, так как если документ содержит слишком много страниц, некоторые из них могут быть пропущены из-за причин производительности.
fileName	fileName	string	Имя файла документа
owner	owner	ApiUser	Сведения о пользователе
государство	state	DocumentState	Состояние документа
ошибка	error	string	Код ошибки документа
isImagesGenerated	isImagesGenerated	boolean	Были созданы изображения
isReturned	isReturned	boolean	Значение True, если документы были возвращены отправителю.
returnReason	returnReason	string	Причина возврата.
время создания	creationTime	date-time	Дата создания
size	size	integer	Размер документа в КБ
Тип контента	contentType	string	Тип контента
source	source	DocumentSource
источникИнформация	sourceInfo	string	Исходные сведения (общий адрес электронной почты)
извлечение Времени	extractionTime	date-time	Дата классификации
model	model	string	Тип этого документа
isAttachment	isAttachment	boolean	Указывает, является ли документ вложением
isValidated	isValidated	boolean	Индикатор проверки документа
isEdited	isEdited	boolean	Индикатор, если этот документ был изменен (по крайней мере одно поле, примечание или тег были изменены)
заметка	note	string	Настраиваемая заметка пользователя
столбцов	fields	object	Список извлеченных полей
items	items	array of object	Список извлеченных элементов
items	items	object
pages	pages	array of ApiPage	Список всех страниц, входящих в извлечение.
pluginResults	pluginResults	array of ApiPluginResult	Общие результаты
isPostProcessCompleted	isPostProcessCompleted	boolean	Индикатор завершения последующей обработки
isPrevalidated	isPrevalidated	boolean	Имеет ли документ некоторые скрипты предварительной подготовки pp
lastOpenTime	lastOpenTime	date-time	Дата последнего открытия
lastOpenUserId	lastOpenUserId	string	Идентификатор пользователя, который последний раз открыл этот документ
IsLocked	isLocked	boolean	Определяет, заблокирован ли документ или нет
validationTime	validationTime	date-time	Время проверки документа
version	version	integer	Номер версии, добавим с каждым обновлением
утверждениеState	approvalState	ApprovalState	Состояние документа
currentApproverId	currentApproverId	string	Идентификатор пользователя, который должен утвердить этот документ
lastApprovalStepTime	lastApprovalStepTime	date-time	Время назначения текущему утверждающего
isCurrentApproverNotificationSent	isCurrentApproverNotificationSent	boolean	Уведомление было отправлено текущему утверждающего
утверждениеHistory	approvalHistory	array of ApiApproval	Журнал утверждений
утверждениеReminderHistory	approvalReminderHistory	array of ApiApprovalReminder	Утверждение журнала
авторизованныеUserIds	authorizedUserIds	array of string	Пользователи, авторизованные для доступа к документу
дубликатыDocIds	duplicateDocIds	array of string	Повторяющиеся идентификаторы документов (на основе значений полей)
approvedBy	approvedBy	ApiUser	Сведения о пользователе
validatedBy	validatedBy	ApiUser	Сведения о пользователе

ApiDocumentApiListResult

Результат поиска

Имя	Путь	Тип	Описание
list	list	array of ApiDocument	Список всех найденных значений
hasMore	hasMore	boolean	Значение True, если поиск может возвращать дополнительные значения
offset	offset	integer	Значение смещения (число пропущенных значений)

ApiEnum

Перечисление данных для типа поля

Имя	Путь	Тип	Описание
id	id	string	Идентификатор перечисления
имя	name	string	Понятное имя перечисления
values	values	object	Список значений перечисления
isEditable	isEditable	boolean	Указывает, можно ли изменить перечисление

ApiFolderCreationResult

Результат создания контейнера

Имя	Путь	Тип	Описание
folderId	folderId	string	Идентификатор контейнера

ApiFolderWithMembers

Метаданные контейнера с метаданными документов внутри контейнера

Имя	Путь	Тип	Описание
folderId	folderId	string	Идентификатор документа.
ownerId	ownerId	string	Идентификатор владельца контейнера
создано	created	date-time	Время создания контейнера
metadata	metadata	object	Все заголовки, подключенные к контейнеру
члены	members	array of ApiDocument	Список всех элементов контейнера

ApiItemCell

Имя	Путь	Тип	Описание
value	value	string	Значение ячейки
modifiedByPostProcessing	modifiedByPostProcessing	boolean	Указывает, было ли изменено это значение после обработки
pluginResults	pluginResults	array of ApiPluginResult	Результаты из подключаемых модулей

ApiItemColumn

Определяет столбец таблицы элементов.

Имя	Путь	Тип	Описание
поле	field	string	Поле
Ширина	width	double	Высота строки.

ApiItemRow

Определяет строку таблицы элементов.

Имя	Путь	Тип	Описание
height	height	double	Высота строки.
Клетки	cells	array of ApiItemCell	Список всех ячеек в этом столбце. Число всегда должно быть равно количеству столбцов.

ApiItemTable

Таблица элементов

Имя	Путь	Тип	Описание
pageIndex	pageIndex	integer	Индекс страницы, к которой принадлежит таблица.
offset	offset	Offset	Определяет двухмерное смещение с координатами X и Y.
columns	columns	array of ApiItemColumn	Список определений столбцов.
Строк	rows	array of ApiItemRow	Список определений строк и ячеек в каждой строке.

ApiPage

Страница документа

Имя	Путь	Тип	Описание
index	index	integer	Индекс страницы документа. Индексировано от 1.
Ширина	width	integer	Ширина страницы в пикселях.
height	height	integer	Высота страницы в пикселях.
вращение	rotation	double	Поворот страницы в градусах.
words	words	array of ApiWord	Список всех слов, присутствующих на странице.
itemTable	itemTable	ApiItemTable	Таблица элементов

ApiPluginResult

Имя	Путь	Тип	Описание
имя подключаемого модуля	pluginName	string	Возвращает или задает имя скрипта, который проверил этот документ
resultCode	resultCode	PostProcessResult	Результат после обработки
value	value	string	Возвращает или задает коллекцию локализованных сообщений
extraInformationRequired	extraInformationRequired	boolean	Возвращает или задает, требуется ли дополнительная информация
extraInformationMessage	extraInformationMessage	string	Возвращает или задает сообщение о дополнительных требованиях к информации

ApiUploadResponse

Результат отправки файла

Имя	Путь	Тип	Описание
documentId	documentId	string	Идентификатор документа
folderId	folderId	string	Идентификатор папки

ApiUser

Сведения о пользователе

Имя	Путь	Тип	Описание
id	id	string	Идентификатор пользователя
Имя	firstName	string	Имя пользователя
lastName	lastName	string	Фамилия пользователя
электронная почта	email	string	Электронная почта пользователя

ApiUserApiListResult

Результат поиска

Имя	Путь	Тип	Описание
list	list	array of ApiUser	Список всех найденных значений
hasMore	hasMore	boolean	Значение True, если поиск может возвращать дополнительные значения
offset	offset	integer	Значение смещения (число пропущенных значений)

ApiWord

Имя	Путь	Тип	Описание
wordId	wordId	integer	Идентификатор слова, уникальный для одного документа
pageIndex	pageIndex	integer	Индекс страницы отображается слово
текст	text	string	Текст слова
locX	locX	integer	X-координата слова
locY	locY	integer	Координата Y слова
Ширина	width	integer	Ширина Word
height	height	integer	Высота Word

УтверждениеState

Состояние документа

: string

DocumentSource

: string

DocumentState

Состояние документа

: string

LicenseTimePeriod

Период времени для лицензий

: string

MLicense

Имя	Путь	Тип	Описание
responseCode	responseCode	ResponseCode
responseMessage	responseMessage	string
validFrom	validFrom	date-time
validTo	validTo	date-time
nextPeriod	nextPeriod	date-time
usageLimit	usageLimit	integer
usageLimitPeriod	usageLimitPeriod	LicenseTimePeriod	Период времени для лицензий
isTrial	isTrial	boolean
usageCount	usageCount	integer

Смещение

Определяет двухмерное смещение с координатами X и Y.

Имя	Путь	Тип	Описание
x	x	double	Смещение в координате X.
и	y	double	Смещение в координате Y.

PostProcessResult

Результат после обработки

: string

RedQueStatus

Данные ответа о состоянии. Используется в качестве ответа, когда запрос не возвращает данные.

Имя	Путь	Тип	Описание
код состояния	statusCode	integer	Код состояния
сообщение	message	string	Message

КодОтвета

: string

StringApiValue

Значение универсального ответа

Имя	Путь	Тип	Описание
value	value	string	Ценность

УРИ

: uri