DocuWare

Доступ к общим функциям DocuWare из потоков.

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

Услуга	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)

Контакт
Имя	DocuWare GmbH
URL	https://support.docuware.com
Адрес электронной почты	support@docuware.com

Метаданные соединителя
Publisher	DocuWare
Веб-сайт	https://start.docuware.com
Политика конфиденциальности	https://start.docuware.com/data-privacy
Категории	Содержимое и файлы; Продуктивность

DocuWare предоставляет мощный и обширный REST API. С помощью соединителя Power Automate в DocuWare пользователи теперь могут использовать многие из наиболее распространенных функций REST API DocuWare в Power Automate. Это позволяет пользователю более гибко создавать потоки, которые полностью соответствуют бизнес-потребностям, благодаря простой интеграции с DocuWare.

Предпосылки

Для продолжения вам потребуется следующее:

• Подписка DocuWare Cloud
• Учетная запись Microsoft Power Apps или Power Automate

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

Создание нового ключа API легко и можно сделать из DocuWare.

Выполните следующие действия, чтобы создать новый ключ API в DocuWare:

1. Войдите в учетную запись DocuWare, которую вы хотите использовать с Power Automate
2. В главном меню перейдите в раздел "Конфигурации"
3. На странице "Конфигурации" перейдите в раздел "Интеграция" и щелкните значок "Ключи API Power Automate"
   • Если значок "Ключи API Power Automate" не отображается, возможно, у пользователя нет правильных разрешений. Чтобы устранить эту проблему, обратитесь к администратору DocuWare.
4. Нажмите кнопку "Создать ключ API"
5. Заполните значения "Имя" и "Описание" (необязательно) и нажмите кнопку "Создать".
   • После нажатия клавиши Create может возникнуть небольшая задержка, так как процесс настройки создает ключ.
   • Кроме того, обязательно сохраните ключ API. Это будет ваша единственная возможность просмотреть полный ключ API. Если вы потеряете этот ключ, вам потребуется создать другой ключ.

На этом этапе у вас есть действительный ключ API, который можно использовать в Power Automate для создания подключения к DocuWare. Затем это подключение можно использовать с соединителем DocuWare Power Automate.

Начало работы с соединителем

При создании потоков можно легко создать подключение в Power Automate.

Выполните следующие действия, чтобы создать новое подключение в Power Automate:

1. Вход в Power Automate
2. Создание нового потока или открытие существующего потока
3. Добавление действия из соединителя DocuWare Power Automate в поток
   • Нажмите кнопку "+ Новый шаг", чтобы добавить новый шаг в поток
   • Когда отображается сообщение "Выбрать операцию", выберите "Все" в выборе категории, а затем введите "DocuWare" в поле поиска.
   • Выберите соединитель DocuWare и выберите из списка доступных действий.
4. При добавлении действия в поток вам будет предложено создать новое подключение.
5. Введите имя подключения ("Имя подключения") и ключ API (ключ API), полученный от DocuWare в предыдущем разделе, и нажмите кнопку "Создать".

На этом этапе все действия, добавленные из соединителя DocuWare, будут использовать это подключение. Дополнительные подключения можно создать, щелкнув "..." в правом верхнем углу действия и нажмите кнопку "+ Добавить новое подключение" в нижней части всплывающего меню.

Известные проблемы и ограничения

В настоящее время соединитель DocuWare Power Automate не поддерживается в новом конструкторе Power Automate Flow.

Распространенные ошибки и средства устранения неполадок

Коды ошибок HTTP:

• 400. Убедитесь, что в действии заполнены все обязательные поля. Некоторые поля являются обязательными и должны быть заполнены перед выполнением действия.
• 401. Убедитесь, что вы ввели правильный ключ API. Вы также можете проверить состояние ключа API на странице "Конфигурации" в разделе "Интеграции" —> "Ключи API Power Automate".
• 404. Убедитесь, что указанный документ и /или файловый шкаф существуют и к ним есть доступ. Если документ или файловый шкаф не существует, или у вас нет доступа к ним, вы получите ошибку 404.
• 500: это универсальная ошибка, которая может быть вызвана рядом различных проблем. Если вы получите эту ошибку, обратитесь в службу поддержки DocuWare для получения помощи.

Часто задаваемые вопросы

Лучшие практики

Ниже приведены некоторые рекомендации, которые мы рекомендуем использовать при использовании соединителя DocuWare Power Automate:

• Всегда используйте выделенного пользователя DocuWare для проверки подлинности с помощью соединителя DocuWare Power Automate. Это позволит легко отслеживать действия, выполняемые соединителем, и управлять ими.
• Начните с тестирования потока с помощью действия Get Organization. Это самое простое действие, предоставленное в соединителе DocuWare Power Automate, и позволит убедиться, что подключение работает правильно.

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:

По умолчанию	Параметры для создания подключения.	Все регионы	Недоступен для совместного использования

По умолчанию

Применимо: все регионы

Параметры для создания подключения.

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Имя	Тип	Description	Обязательно
Ключ API	securestring	Ключ API для доступа к DocuWare	True

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

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

Действия

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

Вывод списка документов в области документов

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

ListDocumentsInDocumentTray

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Область документов	DocumentTray	True	string	Выберите область документов для поиска.

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

Имя	Путь	Тип	Описание
Численность	Count	integer	Численность
Documents	Documents	array of object
Разделы	Documents.Sections	array of	Разделы
DocumentId	Documents.DocumentId	integer	DocumentId
IndexFields	Documents.IndexFields	object	IndexFields
DocumentTitle	Documents.DocumentTitle	string	DocumentTitle
FileCabinetId	Documents.FileCabinetId	string	FileCabinetId
TotalPages	Documents.TotalPages	integer	TotalPages
Размер файла	Documents.FileSize	integer	Размер файла
ContentType	Documents.ContentType	string	ContentType
VersionStatus	Documents.VersionStatus	string	VersionStatus
isCold	Documents.DocumentFlags.isCold	boolean	isCold
isDBRecord	Documents.DocumentFlags.isDBRecord	boolean	isDBRecord
isCheckedOut	Documents.DocumentFlags.isCheckedOut	boolean	isCheckedOut
isCopyRightProtected	Documents.DocumentFlags.isCopyRightProtected	boolean	isCopyRightProtected
isVoiceAvailable	Documents.DocumentFlags.isVoiceAvailable	boolean	isVoiceAvailable
hasAppendedDocuments	Documents.DocumentFlags.hasAppendedDocuments	boolean	hasAppendedDocuments
isProtected	Documents.DocumentFlags.isProtected	boolean	isProtected
isDeleted	Documents.DocumentFlags.isDeleted	boolean	isDeleted
isEmail	Documents.DocumentFlags.isEmail	boolean	isEmail

Добавление файла

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

AppendFile

Добавляет файл или раздел к существующему документу.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Панель файлов или область документов	FileCabinet	True	string	Выберите панель файлов или область документов с документом.
Идентификатор документа	DocID	True	string	Укажите идентификатор документа, к который нужно добавить.
Содержимое файла	file		file	Укажите содержимое файла для хранения.

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

Имя	Путь	Тип	Описание
SignatureStatus	SignatureStatus	array of string	SignatureStatus
SectionId	SectionId	string	SectionId
ContentType	ContentType	string	ContentType
HaveMorePages	HaveMorePages	boolean	HaveMorePages
PageCount	PageCount	integer	PageCount
Размер файла	FileSize	integer	Размер файла
OriginalFileName	OriginalFileName	string	OriginalFileName
ContentModified	ContentModified	string	ContentModified
HasTextAnnotation	HasTextAnnotation	boolean	HasTextAnnotation
ЗаметкиPreview	AnnotationsPreview	boolean	ЗаметкиPreview

Замена файла

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

ReplaceFile

Заменяет файл или раздел в существующем документе.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Панель файлов или область документов	FileCabinet	True	string	Выберите панель файлов или область документов с документом.
Идентификатор документа	DocumentID	True	integer	Укажите идентификатор документа, который нужно заменить.
Номер файла	FileNumber	True	integer	Укажите номер файла для замены.
Содержимое файла	file		file	Укажите содержимое файла для хранения.

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

Имя	Путь	Тип	Описание
SignatureStatus	SignatureStatus	array of string	SignatureStatus
SectionId	SectionId	string	SectionId
ContentType	ContentType	string	ContentType
HaveMorePages	HaveMorePages	boolean	HaveMorePages
PageCount	PageCount	integer	PageCount
Размер файла	FileSize	integer	Размер файла
OriginalFileName	OriginalFileName	string	OriginalFileName
ContentModified	ContentModified	string	ContentModified
HasTextAnnotation	HasTextAnnotation	boolean	HasTextAnnotation
ЗаметкиPreview	AnnotationsPreview	boolean	ЗаметкиPreview

Импорт в область документов

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

ImportToDocumentTray

Импортируйте новый документ в область документов.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Область документов	DocumentTray	True	string	Выберите область документов для импорта.
Диалоговое окно хранилища	StoreDialogId		string	Выберите диалоговое окно хранилища, используемое во время импорта.
Индексные данные	index		string	Укажите данные индекса для документа.
Содержимое файла	file		file	Укажите содержимое файла для импорта.

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

Имя	Путь	Тип	Описание
Разделы	Sections	array of object	Разделы
SignatureStatus	Sections.SignatureStatus	array of string	SignatureStatus
SectionId	Sections.SectionId	string	SectionId
ContentType	Sections.ContentType	string	ContentType
HaveMorePages	Sections.HaveMorePages	boolean	HaveMorePages
PageCount	Sections.PageCount	integer	PageCount
Размер файла	Sections.FileSize	integer	Размер файла
OriginalFileName	Sections.OriginalFileName	string	OriginalFileName
ContentModified	Sections.ContentModified	string	ContentModified
HasTextAnnotation	Sections.HasTextAnnotation	boolean	HasTextAnnotation
ЗаметкиPreview	Sections.AnnotationsPreview	boolean	ЗаметкиPreview
DocumentId	DocumentId	integer	DocumentId
IndexFields	IndexFields	object	IndexFields
DocumentTitle	DocumentTitle	string	DocumentTitle
FileCabinetId	FileCabinetId	string	FileCabinetId
TotalPages	TotalPages	integer	TotalPages
Размер файла	FileSize	integer	Размер файла
ContentType	ContentType	string	ContentType
VersionStatus	VersionStatus	string	VersionStatus
isCold	DocumentFlags.isCold	boolean	isCold
isDBRecord	DocumentFlags.isDBRecord	boolean	isDBRecord
isCheckedOut	DocumentFlags.isCheckedOut	boolean	isCheckedOut
isCopyRightProtected	DocumentFlags.isCopyRightProtected	boolean	isCopyRightProtected
isVoiceAvailable	DocumentFlags.isVoiceAvailable	boolean	isVoiceAvailable
hasAppendedDocuments	DocumentFlags.hasAppendedDocuments	boolean	hasAppendedDocuments
isProtected	DocumentFlags.isProtected	boolean	isProtected
isDeleted	DocumentFlags.isDeleted	boolean	isDeleted
isEmail	DocumentFlags.isEmail	boolean	isEmail

Обновление полей индекса

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

UpdateIndexFields

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Картотека	FileCabinetID	True	string	Выберите файловый кабинет с документом, чтобы обновить его.
Идентификатор документа	DocumentID	True	integer	Укажите идентификатор документа для обновления.
Имя	Name		string	Выберите или укажите поле индекса.
Ценность	Value		string	Укажите значение индекса.

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

Имя	Путь	Тип	Описание
Разделы	Sections	array of object	Разделы
SignatureStatus	Sections.SignatureStatus	array of string	SignatureStatus
SectionId	Sections.SectionId	string	SectionId
ContentType	Sections.ContentType	string	ContentType
HaveMorePages	Sections.HaveMorePages	boolean	HaveMorePages
PageCount	Sections.PageCount	integer	PageCount
Размер файла	Sections.FileSize	integer	Размер файла
OriginalFileName	Sections.OriginalFileName	string	OriginalFileName
ContentModified	Sections.ContentModified	string	ContentModified
HasTextAnnotation	Sections.HasTextAnnotation	boolean	HasTextAnnotation
ЗаметкиPreview	Sections.AnnotationsPreview	boolean	ЗаметкиPreview
DocumentId	DocumentId	integer	DocumentId
IndexFields	IndexFields	object	IndexFields
DocumentTitle	DocumentTitle	string	DocumentTitle
FileCabinetId	FileCabinetId	string	FileCabinetId
TotalPages	TotalPages	integer	TotalPages
Размер файла	FileSize	integer	Размер файла
ContentType	ContentType	string	ContentType
VersionStatus	VersionStatus	string	VersionStatus
isCold	DocumentFlags.isCold	boolean	isCold
isDBRecord	DocumentFlags.isDBRecord	boolean	isDBRecord
isCheckedOut	DocumentFlags.isCheckedOut	boolean	isCheckedOut
isCopyRightProtected	DocumentFlags.isCopyRightProtected	boolean	isCopyRightProtected
isVoiceAvailable	DocumentFlags.isVoiceAvailable	boolean	isVoiceAvailable
hasAppendedDocuments	DocumentFlags.hasAppendedDocuments	boolean	hasAppendedDocuments
isProtected	DocumentFlags.isProtected	boolean	isProtected
isDeleted	DocumentFlags.isDeleted	boolean	isDeleted
isEmail	DocumentFlags.isEmail	boolean	isEmail

Передача документов

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

TransferDocument

Перемещает один или несколько документов из одного шкафа или области документов в другой.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Целевой файловый шкаф или область документов	DestinationFileCabinetID	True	string	Выберите целевой файловый шкаф или область документов.
Диалоговое окно хранилища	StoreDialogID		string	Выберите диалоговое окно хранилища для индексирования перемещаемых документов.
Исходный шкаф файлов или область документов	SourceFileCabinetId	True	string	Выберите исходный шкаф файлов или область документов.
Идентификатор	DocumentId		integer	Укажите идентификатор документа.
Имя	Name		string	Выберите или укажите имя поля.
Ценность	Value		string	Укажите значение поля.
Сохранение источника	KeepSource		boolean	Выберите, следует ли удалять исходные документы.
Заполнение Intellix	FillIntellix		boolean	Выберите, следует ли использовать интеллектуальную индексирование при хранении.

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

Имя	Путь	Тип	Описание
Численность	Count	integer	Численность
Documents	Documents	array of object	Documents
Разделы	Documents.Sections	array of object	Разделы
SignatureStatus	Documents.Sections.SignatureStatus	array of string	SignatureStatus
SectionId	Documents.Sections.SectionId	string	SectionId
ContentType	Documents.Sections.ContentType	string	ContentType
HaveMorePages	Documents.Sections.HaveMorePages	boolean	HaveMorePages
PageCount	Documents.Sections.PageCount	integer	PageCount
Размер файла	Documents.Sections.FileSize	integer	Размер файла
OriginalFileName	Documents.Sections.OriginalFileName	string	OriginalFileName
ContentModified	Documents.Sections.ContentModified	string	ContentModified
HasTextAnnotation	Documents.Sections.HasTextAnnotation	boolean	HasTextAnnotation
ЗаметкиPreview	Documents.Sections.AnnotationsPreview	boolean	ЗаметкиPreview
DocumentId	Documents.DocumentId	integer	DocumentId
IndexFields	Documents.IndexFields	object	IndexFields
DocumentTitle	Documents.DocumentTitle	string	DocumentTitle
FileCabinetId	Documents.FileCabinetId	string	FileCabinetId
TotalPages	Documents.TotalPages	integer	TotalPages
Размер файла	Documents.FileSize	integer	Размер файла
ContentType	Documents.ContentType	string	ContentType
VersionStatus	Documents.VersionStatus	string	VersionStatus
isCold	Documents.DocumentFlags.isCold	boolean	isCold
isDBRecord	Documents.DocumentFlags.isDBRecord	boolean	isDBRecord
isCheckedOut	Documents.DocumentFlags.isCheckedOut	boolean	isCheckedOut
isCopyRightProtected	Documents.DocumentFlags.isCopyRightProtected	boolean	isCopyRightProtected
isVoiceAvailable	Documents.DocumentFlags.isVoiceAvailable	boolean	isVoiceAvailable
hasAppendedDocuments	Documents.DocumentFlags.hasAppendedDocuments	boolean	hasAppendedDocuments
isProtected	Documents.DocumentFlags.isProtected	boolean	isProtected
isDeleted	Documents.DocumentFlags.isDeleted	boolean	isDeleted
isEmail	Documents.DocumentFlags.isEmail	boolean	isEmail

Поиск в шкафу файлов

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

SearchForDocumentsInFileCabinet

Найдите файловый шкаф для документов, соответствующих указанным критериям.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Картотека	FileCabinet	True	string	Выберите файловый кабинет для поиска.
Диалоговое окно поиска	SearchDialogId	True	string	Выберите диалоговое окно поиска, используемое для поиска.
Поисковый запрос	SearchQuery	True

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

Имя	Путь	Тип	Описание
Численность	Count	integer	Численность
Documents	Documents	array of object	Documents
Разделы	Documents.Sections	array of	Разделы
DocumentId	Documents.DocumentId	integer	DocumentId
IndexFields	Documents.IndexFields	object	IndexFields
DocumentTitle	Documents.DocumentTitle	string	DocumentTitle
FileCabinetId	Documents.FileCabinetId	string	FileCabinetId
TotalPages	Documents.TotalPages	integer	TotalPages
Размер файла	Documents.FileSize	integer	Размер файла
ContentType	Documents.ContentType	string	ContentType
VersionStatus	Documents.VersionStatus	string	VersionStatus
isCold	Documents.DocumentFlags.isCold	boolean	isCold
isDBRecord	Documents.DocumentFlags.isDBRecord	boolean	isDBRecord
isCheckedOut	Documents.DocumentFlags.isCheckedOut	boolean	isCheckedOut
isCopyRightProtected	Documents.DocumentFlags.isCopyRightProtected	boolean	isCopyRightProtected
isVoiceAvailable	Documents.DocumentFlags.isVoiceAvailable	boolean	isVoiceAvailable
hasAppendedDocuments	Documents.DocumentFlags.hasAppendedDocuments	boolean	hasAppendedDocuments
isProtected	Documents.DocumentFlags.isProtected	boolean	isProtected
isDeleted	Documents.DocumentFlags.isDeleted	boolean	isDeleted
isEmail	Documents.DocumentFlags.isEmail	boolean	isEmail

Получение диалогов

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

GetDialogs

Возвращает список диалоговых окон для файлового шкафа или области документов.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Панель файлов или область документов	FileCabinet	True	string	Выберите панель файлов или область документов, чтобы получить диалоговые окна.
Тип диалогового окна	DialogType		string	Выберите тип возвращаемых диалогов.

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

Имя	Путь	Тип	Описание
Dialogs	Dialogs	array of object	Dialogs
Имя	Dialogs.Name	string	Имя
Гид	Dialogs.Guid	string	Гид
Цвет	Dialogs.Color	string	Цвет
IsDefault	Dialogs.IsDefault	boolean	IsDefault
Тип	Dialogs.Type	string	Тип
FileCabinetId	Dialogs.FileCabinetId	string	FileCabinetId

Получение меток

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

GetStamps

Возвращает список меток для шкафа файла или области документов.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Панель файлов или область документов	FileCabinet	True	string	Выберите шкаф файлов или область документов, чтобы получить метки.

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

Имя	Путь	Тип	Описание
Марки	Stamps	array of object	Марки
Идентификатор	Stamps.Id	string	Идентификатор
Имя	Stamps.Name	string	Имя
Отображаемое имя	Stamps.DisplayName	string	Отображаемое имя
Цвет	Stamps.Color	string	Цвет
Signature	Stamps.Signature	string	Signature
PasswordProtected	Stamps.PasswordProtected	boolean	PasswordProtected
Перезаписать	Stamps.Overwrite	boolean	Перезаписать
Тип	Stamps.Type	string	Тип
FileCabinetId	Stamps.FileCabinetId	string	FileCabinetId

Получение организации

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

GetOrganization

Получите имя организации.

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

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

Получение полей диалогового окна

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

GetDialogFields

Возвращает поля для диалогового окна

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Картотека	FileCabinet	True	string	Выбор шкафа файлов
Dialog	DialogId	True	string	Выберите диалоговое окно, чтобы получить поля.

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

Имя	Путь	Тип	Описание
Fields	Fields	array of object	Fields
DBFieldName	Fields.DBFieldName	string	DBFieldName
DWFieldType	Fields.DWFieldType	string	DWFieldType
Отображаемое имя	Fields.DisplayName	string	Отображаемое имя
ReadOnly	Fields.ReadOnly	boolean	ReadOnly
Видимо	Fields.Visible	boolean	Видимо

Получение полей метки

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

GetStampFields

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Панель файлов или область документов	FileCabinet	True	string	Выберите шкаф файлов или область документов с требуемой меткой.
Штемпель	Stamp	True	string	Выберите метку, чтобы получить его поля.

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

Имя	Путь	Тип	Описание
Fields	Fields	array of object	Fields
Идентификатор	Fields.Id	string	Идентификатор
Этикетка	Fields.Label	string	Этикетка
Отображаемое имя	Fields.DisplayName	string	Отображаемое имя

Получение полей шкафа файлов

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

GetFileCabinetFields

Возвращает список полей для шкафа файлов.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Картотека	FileCabinet	True	string	Выберите файловый кабинет, чтобы получить поля.
Тип поля	FieldType		string	Выберите тип возвращаемых полей.

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

Имя	Путь	Тип	Описание
Fields	Fields	array of object	Fields
TableFieldColumns	Fields.TableFieldColumns	array of object	TableFieldColumns
DBFieldName	Fields.TableFieldColumns.DBFieldName	string	DBFieldName
DWFieldType	Fields.TableFieldColumns.DWFieldType	string	DWFieldType
Отображаемое имя	Fields.TableFieldColumns.DisplayName	string	Отображаемое имя
DropLeadingBlanks	Fields.TableFieldColumns.DropLeadingBlanks	boolean	DropLeadingBlanks
DropLeadingZero	Fields.TableFieldColumns.DropLeadingZero	boolean	DropLeadingZero
FieldInfoText	Fields.TableFieldColumns.FieldInfoText	string	FieldInfoText
FixedEntry	Fields.TableFieldColumns.FixedEntry	string	FixedEntry
Length	Fields.TableFieldColumns.Length	integer	Length
NotEmpty	Fields.TableFieldColumns.NotEmpty	boolean	NotEmpty
Точность	Fields.TableFieldColumns.Precision	integer	Точность
Scope	Fields.TableFieldColumns.Scope	string	Scope
UsedAsDocumentName	Fields.UsedAsDocumentName	boolean	UsedAsDocumentName
DBFieldName	Fields.DBFieldName	string	DBFieldName
DWFieldType	Fields.DWFieldType	string	DWFieldType
Отображаемое имя	Fields.DisplayName	string	Отображаемое имя
DropLeadingBlanks	Fields.DropLeadingBlanks	boolean	DropLeadingBlanks
DropLeadingZero	Fields.DropLeadingZero	boolean	DropLeadingZero
FieldInfoText	Fields.FieldInfoText	string	FieldInfoText
FixedEntry	Fields.FixedEntry	string	FixedEntry
Length	Fields.Length	integer	Length
NotEmpty	Fields.NotEmpty	boolean	NotEmpty
Точность	Fields.Precision	integer	Точность
Scope	Fields.Scope	string	Scope

Получение сведений о документе

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

GetDocumentInformation

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Панель файлов или область документов	FileCabinetID	True	string	Выберите панель файлов или область документов с документом.
Идентификатор документа	DocumentID	True	integer	Укажите идентификатор документа, для которого требуется информация.

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

Имя	Путь	Тип	Описание
Разделы	Sections	array of object	Разделы
SignatureStatus	Sections.SignatureStatus	array of string	SignatureStatus
SectionId	Sections.SectionId	string	SectionId
ContentType	Sections.ContentType	string	ContentType
HaveMorePages	Sections.HaveMorePages	boolean	HaveMorePages
PageCount	Sections.PageCount	integer	PageCount
Размер файла	Sections.FileSize	integer	Размер файла
OriginalFileName	Sections.OriginalFileName	string	OriginalFileName
ContentModified	Sections.ContentModified	string	ContentModified
HasTextAnnotation	Sections.HasTextAnnotation	boolean	HasTextAnnotation
ЗаметкиPreview	Sections.AnnotationsPreview	boolean	ЗаметкиPreview
DocumentId	DocumentId	integer	DocumentId
IndexFields	IndexFields	object	IndexFields
DocumentTitle	DocumentTitle	string	DocumentTitle
FileCabinetId	FileCabinetId	string	FileCabinetId
TotalPages	TotalPages	integer	TotalPages
Размер файла	FileSize	integer	Размер файла
ContentType	ContentType	string	ContentType
VersionStatus	VersionStatus	string	VersionStatus
isCold	DocumentFlags.isCold	boolean	isCold
isDBRecord	DocumentFlags.isDBRecord	boolean	isDBRecord
isCheckedOut	DocumentFlags.isCheckedOut	boolean	isCheckedOut
isCopyRightProtected	DocumentFlags.isCopyRightProtected	boolean	isCopyRightProtected
isVoiceAvailable	DocumentFlags.isVoiceAvailable	boolean	isVoiceAvailable
hasAppendedDocuments	DocumentFlags.hasAppendedDocuments	boolean	hasAppendedDocuments
isProtected	DocumentFlags.isProtected	boolean	isProtected
isDeleted	DocumentFlags.isDeleted	boolean	isDeleted
isEmail	DocumentFlags.isEmail	boolean	isEmail

Получение шкафов файлов и области документов

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

GetFileCabinets

Возвращает список шкафов файлов и /или области документов.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Тип шкафа файлов	FileCabinetType	True	string	Выберите нужные типы.

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

Имя	Путь	Тип	Описание
FileCabinets	FileCabinets	array of object	FileCabinets
Имя	FileCabinets.Name	string	Имя
Гид	FileCabinets.Guid	string	Гид
Цвет	FileCabinets.Color	string	Цвет
IsTray	FileCabinets.IsTray	boolean	IsTray

Размещение метки

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

PlaceAStamp

Помещает метку в документ.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Панель файлов или область документов	FileCabinetID	True	string	Выберите панель файлов или область документов с документом.
Идентификатор документа	DocumentID	True	integer	Укажите идентификатор документа, который требуется наметить.
Номер файла	FileNumber	True	integer	Укажите файл или раздел, содержащий метку страницы.
Номер страницы	PageNumber	True	integer	Укажите номер страницы для размещения метки.
Уровень	Layer	True	integer	Укажите слой документов, чтобы поместить метку на [1-5]
Горизонтальное положение (положение X)	PositionX		number	[Необязательно] Позиция с левого края страницы в мм.
Вертикальная позиция (позиция Y)	PositionY		number	[Необязательно] Позиция от верхнего края страницы в мм.
Штемпель	StampId	True	string	Выберите или укажите используемую метку.
Пароль	Password		string	Укажите пароль для метки (при необходимости).
Имя	Name		string	Укажите имя поля.
Ценность	Value		string	Укажите значение поля.

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

Имя	Путь	Тип	Описание
User	Created.User	string	User
Time	Created.Time	string	Time
Тип	Type	string	Тип
Цвет	Color	string	Цвет
Вращение	Rotation	integer	Вращение
Transparent	Transparent	boolean	Transparent
StrokeWidth	StrokeWidth	integer	StrokeWidth
Гид	Guid	string	Гид

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

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

DownloadDocument

Загружает документ из файлового шкафа или области документов.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Панель файлов или область документов	FileCabinetID	True	string	Выберите панель файлов или область документов с документом.
Идентификатор документа	DocumentId	True	integer	Укажите идентификатор документа, который требуется скачать.
Формат документа	DocumentFormat	True	string	Выберите формат скачаемого документа.

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

Тело

Тело

binary

Скачивание файла

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

DownloadFile

Скачивает файл или раздел документа, хранящегося в шкафу файлов или области документов.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Панель файлов или область документов	FileCabinetID	True	string	Выберите панель файлов или область документов с документом.
Идентификатор документа	DocumentId	True	integer	Укажите идентификатор документа с файлом, который требуется скачать.
Номер файла	FileNumber	True	string	Укажите номер файла, который требуется скачать.
Формат документа	DocumentFormat	True	string	Выберите формат скачаемого документа.

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

Тело

Тело

binary

Удаление документа

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

DeleteDocument

Удаляет документ из файлового шкафа или области документов.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Панель файлов или область документов	FileCabinetID	True	string	Выберите панель файлов или область документов с документом.
Идентификатор документа	DocumentID	True	integer	Укажите идентификатор документа, который требуется удалить.

Удаление файла

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

DeleteFile

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Панель файлов или область документов	FileCabinet	True	string	Выберите панель файлов или область документов с документом.
Идентификатор документа	DocumentID	True	integer	Укажите идентификатор документа для удаления.
Номер файла	FileNumber	True	integer	Укажите номер файла для удаления.

Хранение в шкафу файлов

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

StoreToFileCabinet

Хранит новый документ в файловый шкаф.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Картотека	FileCabinet	True	string	Выберите файловый шкаф для хранения.
Диалоговое окно хранилища	StoreDialogId	True	string	Выберите диалоговое окно хранилища, используемое для хранения.
Индексные данные	index		string	Укажите данные индекса для документа.
Содержимое файла	file		file	Укажите содержимое файла для хранения.

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

Имя	Путь	Тип	Описание
Разделы	Sections	array of object	Разделы
SignatureStatus	Sections.SignatureStatus	array of string	SignatureStatus
SectionId	Sections.SectionId	string	SectionId
ContentType	Sections.ContentType	string	ContentType
HaveMorePages	Sections.HaveMorePages	boolean	HaveMorePages
PageCount	Sections.PageCount	integer	PageCount
Размер файла	Sections.FileSize	integer	Размер файла
OriginalFileName	Sections.OriginalFileName	string	OriginalFileName
ContentModified	Sections.ContentModified	string	ContentModified
HasTextAnnotation	Sections.HasTextAnnotation	boolean	HasTextAnnotation
ЗаметкиPreview	Sections.AnnotationsPreview	boolean	ЗаметкиPreview
DocumentId	DocumentId	integer	DocumentId
IndexFields	IndexFields	object	IndexFields
DocumentTitle	DocumentTitle	string	DocumentTitle
FileCabinetId	FileCabinetId	string	FileCabinetId
TotalPages	TotalPages	integer	TotalPages
Размер файла	FileSize	integer	Размер файла
ContentType	ContentType	string	ContentType
VersionStatus	VersionStatus	string	VersionStatus
isCold	DocumentFlags.isCold	boolean	isCold
isDBRecord	DocumentFlags.isDBRecord	boolean	isDBRecord
isCheckedOut	DocumentFlags.isCheckedOut	boolean	isCheckedOut
isCopyRightProtected	DocumentFlags.isCopyRightProtected	boolean	isCopyRightProtected
isVoiceAvailable	DocumentFlags.isVoiceAvailable	boolean	isVoiceAvailable
hasAppendedDocuments	DocumentFlags.hasAppendedDocuments	boolean	hasAppendedDocuments
isProtected	DocumentFlags.isProtected	boolean	isProtected
isDeleted	DocumentFlags.isDeleted	boolean	isDeleted
isEmail	DocumentFlags.isEmail	boolean	isEmail

Определения

бинарный

Это базовый тип данных binary.