InfoShare
InfoShare предназначен для использования в компаниях, стремящихся оптимизировать способ управления цифровыми документами, информацией, привязками и процессами.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | 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) |
| Контакт | |
|---|---|
| Имя | Поддержка Kendox |
| URL | https://kendox.com/en/service/support-services |
| Адрес электронной почты | support@kendox.com |
| Метаданные соединителя | |
|---|---|
| Publisher | Kendox AG |
| Website | https://www.kendox.com/en |
| Политика конфиденциальности | https://www.kendox.com/en/about-us/data-protection |
| Категории | Сотрудничество; Содержимое и файлы |
Соединитель InfoShare Kendox
Kendox InfoShare предоставляет мощный и очень обширный REST API. С помощью этого API можно создавать документы и процессы в InfoShare и управлять ими. Вместе с соединителем Kendox InfoShare Power Automate можно оптимизировать процессы содержимого в широко распространенном ландшафте приложений, что позволяет избежать информационных силосов.
Pre-requisites
Для продолжения вам потребуется следующее:
- Лицензия, доступная sales365@kendox.comчерез этот соединитель.
- Kendox InfoShare с конечными точками службы WCF, доступными в Интернете.
- Учетные данные для входа в Kendox InfoShare.
Поддерживаемые операции
Соединитель поддерживает следующие операции:
General
-
Logon: вход на сервер InfoShare Server -
Logon with hashed password: вход на сервер InfoShare Server -
Logoff: вход из InfoShare Server -
Get documents and processes selection: получение документов и процессов, выбранных на мобильном веб-клиенте с помощью пользовательского действия кнопки
Документ
-
Create document (deprecated): создание документа в InfoShare, устаревшей версии -
Create document (V2): создание документа в InfoShare, рекомендуемая версия -
Update document (deprecated): обновите документ в InfoShare, устаревшей версии -
Update document (V2): обновите документ в InfoShare, рекомендуемую версию -
Get document properties: получение свойств документа из InfoShare -
Get file content: получение содержимого файла из InfoShare -
Get file content converted: преобразует содержимое файла в другой формат (e.g. tiff в pdf). Получение содержимого файла, включая заметки и наложения -
Get document: возвращает сведения о документе (структура) из InfoShare -
Merge PDF documents: слияние двух или нескольких PDF-документов с целевым документом
Процедура
-
Create process: создание и запуск процесса -
Update process (deprecated): обновление процесса в InfoShare, устаревшая версия -
Update process (V2): обновление процесса в InfoShare, рекомендуемая версия -
Close an open process: закройте процесс в InfoShare -
Close task and continue process: закрытие задачи процесса в InfoShare -
Close current task and assign user to next task: закройте задачу процесса и назначьте пользователя следующей задаче в InfoShare -
Get process: возвращает список сведений о процессе (структура) из InfoShare -
Get process properties: получение свойств процесса из InfoShare
Искать
-
Document Search (deprecated): поиск документов в InfoShare, устаревшая версия -
Document Search (V2): поиск документов в InfoShare, рекомендуемая версия -
List processes (deprecated): получение списка процессов в InfoShare, замененное действием поиска процесса -
Process search: поиск процессов в InfoShare
Пользовательские таблицы
-
Create a user table: создает таблицу пользователя -
Get rows from a user table: получает некоторые строки из пользовательской таблицы -
Insert rows into a user table: вставка строк в таблицу пользователя -
Update a row in a user table: обновление строки в пользовательской таблице -
Delete user table rows: удаляет некоторые строки из пользовательской таблицы
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| По умолчанию | Параметры для создания подключения. | Все регионы | Недоступен для совместного использования |
По умолчанию
Применимо: все регионы
Параметры для создания подключения.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Ключ API | securestring | Ключ API для этого API | True |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Logoff |
Logoff |
| Logon |
Logon |
| Вставка строк в таблицу пользователя |
Импорт строк таблицы в пользовательную таблицу |
| Вход с хэшированных паролем |
Вход с хэшированных паролем |
| Закройте текущую задачу и назначьте пользователя следующей задаче |
Закройте текущую задачу и назначьте пользователя следующей задаче |
| Закрытие задачи и продолжение процесса |
Закрытие задачи и продолжение процесса |
| Закрытие открытого процесса |
Закрытие открытого процесса |
| Обновление документа (версия 2) |
Обновление документа (версия 2) |
| Обновление документа (не рекомендуется) [DEPRECATED] |
Обновление документа (не рекомендуется) |
| Обновление строки в пользовательской таблице |
Обновление строки в пользовательской таблице |
| Поиск документов (версия 2) |
Поиск документов (версия 2) |
| Поиск документов (не рекомендуется) [DEPRECATED] |
Поиск документов (не рекомендуется) |
| Поиск процесса |
Поиск процесса |
| Получение документа |
Получение документа |
| Получение документов и процессов |
Получение документов и процессов, выбранных на мобильном веб-клиенте с помощью пользовательского действия кнопки |
| Получение преобразованного содержимого файла |
Преобразование содержимого файла в другой формат. Добавление заметки или наложения в содержимое файла |
| Получение процесса |
Получить процесс |
| Получение свойств документа |
Получение свойств документа |
| Получение свойств процесса |
Получение свойств процесса |
| Получение строк из таблицы пользователя |
Получение строк из таблицы пользователя |
| Получить содержимое файла |
Получить содержимое файла |
| Процесс обновления (версия 2) |
Процесс обновления (версия 2) |
| Процесс обновления (не рекомендуется) [DEPRECATED] |
Процесс обновления (не рекомендуется) |
| Процессы списка (не рекомендуется) [DEPRECATED] |
Процессы перечисления (не рекомендуется) |
| Слияние PDF-документов |
Объединение двух или нескольких PDF-документов в одном документе |
| Создание документа (версия 2) |
Создание документа (версия 2) |
| Создание документа (не рекомендуется) [DEPRECATED] |
Создание документа (не рекомендуется) |
| Создание процесса |
Создание процесса |
| Создание таблицы пользователя |
Создание таблицы пользователя |
| Удаление строк таблицы пользователей |
Удаление строк таблицы пользователей |
Logoff
Logoff
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL-адрес api архива (например: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Идентификатор подключения для идентификации подключения |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
LogoffResult
|
LogoffResult | string |
Результат выхода |
Logon
Logon
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL-адрес api архива (например: https://documentarchive.ch/sdk/wcfJSON) |
|
Имя пользователя
|
Username | True | string |
Имя пользователя для входа |
|
Пароль
|
Password | True | string |
Пароль |
|
Имя клиента
|
Tenantname | string |
Имя клиента для входа в систему |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
ConnectionId
|
connectionId | string |
Содержит идентификатор подключения при успешном входе в систему |
|
ConnectionTimeoutSeconds
|
connectionTimeoutSeconds | integer |
Время ожидания подключения |
|
IsApplicationLicence
|
isApplicationLicence | string |
Тип лицензии приложения |
|
IsConcurrentLicence
|
isConcurrentLicence | string |
Одновременный тип лицензии |
|
IsNamedLicence
|
isNamedLicence | string |
Тип лицензии с именем |
|
IsVerificationCodeNeeded
|
isVerificationCodeNeeded | string |
Требуется ли код проверки |
|
VariantTwoWayAuthenticationType
|
possibleTwoWayAuthenticationType | string |
Возможный двумя способами проверки подлинности (None, Mail, SMS) |
|
TwoWayAuthenticationTargetMail
|
twoWayAuthenticationTargetMail | string |
Маскированные почтовые адреса, в которых twoWayAuthentication будет отправлять почту в |
Вставка строк в таблицу пользователя
Импорт строк таблицы в пользовательную таблицу
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL-адрес api архива (например: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Идентификатор подключения для идентификации подключения |
|
UserTable
|
UserTable | True | string |
Имя таблицы пользователя |
|
Ценности
|
Values | True | string |
Список значений строк и столбцов для вставки (например, [Джон; Самка; Нью-йорк], [Питер; Сбор; Берн]) |
|
DeleteAllValues
|
DeleteAllValues | boolean |
Определяет, следует ли удалять все значения в UserTable (по умолчанию = false) |
|
|
FirstRowContainsColumnHeaders
|
FirstRowContainsColumnHeaders | boolean |
Определяет, содержит ли первая строка параметра значений заголовки столбцов (по умолчанию = false) |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Таблица пользователей
|
userTable | string |
Имя таблицы пользователя |
|
Вставленные строки
|
insertedRows | integer |
Количество вставленных строк |
Вход с хэшированных паролем
Вход с хэшированных паролем
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL-адрес api архива (например: https://documentarchive.ch/sdk/wcfJSON) |
|
Имя пользователя
|
userName | True | string |
Имя пользователя для входа |
|
Хэшированные пароли
|
passwordHashed | True | string |
Пароль пользователя для входа (Хэш в кодировке Base64) |
|
Имя клиента
|
tenantName | string |
Имя клиента для входа в систему |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
ConnectionId
|
LogonResult.ConnectionId | string |
Идентификатор подключения для идентификации подключения |
|
ConnectionTimeoutSeconds
|
LogonResult.ConnectionTimeoutSeconds | integer |
Время ожидания подключения в секундах |
|
IsApplicationLicence
|
LogonResult.IsApplicationLicence | boolean |
Тип лицензии приложения |
|
IsConcurrentLicence
|
LogonResult.IsConcurrentLicence | boolean |
Одновременный тип лицензии |
|
IsNamedLicence
|
LogonResult.IsNamedLicence | boolean |
Тип лицензии с именем |
|
IsVerificationCodeNeeded
|
LogonResult.IsVerificationCodeNeeded | boolean |
Требуется ли код проверки |
|
JWTToken
|
LogonResult.JWTToken | string |
Токен JWT для этого подключения |
|
VariantTwoWayAuthenticationType
|
LogonResult.PossibleTwoWayAuthenticationType | string |
Возможный двумя способами проверки подлинности (None, Mail, SMS) |
|
TwoWayAuthenticationTargetMail
|
LogonResult.TwoWayAuthenticationTargetMail | string |
Маскированные почтовые адреса, в которых twoWayAuthentication будет отправлять почту в |
Закройте текущую задачу и назначьте пользователя следующей задаче
Закройте текущую задачу и назначьте пользователя следующей задаче
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL-адрес api архива (например: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Идентификатор подключения для идентификации подключения |
|
ProcessId
|
ProcessId | True | string |
Идентификатор процесса (GUID) |
|
TaskId
|
TaskId | string |
Идентификатор задачи (GUID) |
|
|
Комментарий
|
Comment | string |
Комментарий |
|
|
AssignUserLoginNames
|
AssignUserLoginNames | True | string |
AssignUserLoginNames |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Действие
|
action | string |
Текст действия для пользователя. Отображается пользователю |
|
assignedUserIds
|
assignedUserIds | array of string |
assignedUserIds |
|
comments
|
comments | array of object |
comments |
|
Date
|
comments.date | string |
Дата комментария |
|
Идентификатор
|
comments.id | string |
Идентификатор комментария |
|
Текст
|
comments.text | string |
Определяемый пользователем комментарий |
|
UserId
|
comments.userId | string |
Идентификатор пользователя, который задал комментарий |
|
ЗавершеноDate
|
completedDate | string |
Дата завершения. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
CompletedUserIds
|
CompletedUserIds | array of string |
CompletedUserIds |
|
CreatedDate
|
createdDate | string |
Дата создания. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
CreatorId
|
creatorId | string |
Идентификатор пользователя создателя |
|
Description
|
description | string |
Описание задания |
|
Дата выполнения
|
dueDate | string |
Дата выполнения задачи. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
ПредполагаемыеUserIds
|
intendedUserIds | array of string |
ПредполагаемыеUserIds |
|
Напоминание
|
reminderDate | string |
Дата напоминания. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
ТребуетсяAllRecipients
|
requiresAllRecipients | boolean |
Определяет, должны ли все получатели закрыть эту задачу |
|
ShowCloseTaskDialog
|
showCloseTaskDialog | boolean |
Показать диалоговое окно закрытия задачи в конце задачи |
|
Состояние
|
statusEnum | string |
Состояние состояния задачи (Open, InProcess, Complete, PreparedToComplete, Error) |
|
TaskTemplateId
|
taskTemplateId | string |
Идентификатор шаблона задачи |
Закрытие задачи и продолжение процесса
Закрытие задачи и продолжение процесса
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL-адрес api архива (например: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
connectionId | True | string |
Идентификатор подключения для идентификации подключения |
|
ProcessId
|
processId | True | string |
Идентификатор процесса (GUID) |
|
Комментарий
|
comment | string |
Комментарий для добавления |
|
|
TaskId
|
taskId | string |
Идентификатор задачи |
|
|
AssignUsers
|
assignUsers | True | boolean |
Назначение пользователям. Если задано значение "Нет", назначьте пользователя с процессом обновления действия |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Действие
|
action | string |
Текст действия для пользователя. Отображается пользователю |
|
AssignedUserIds
|
assignedUserIds | string |
Список назначенных идентификаторов пользователей |
|
comments
|
comments | array of object |
comments |
|
Date
|
comments.date | string |
Дата комментария |
|
Идентификатор
|
comments.id | string |
Идентификатор комментария |
|
Текст
|
comments.text | string |
Определяемый пользователем комментарий |
|
UserId
|
comments.userId | string |
Идентификатор пользователя |
|
ЗавершеноDate
|
completedDate | string |
Дата завершения. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
CompletedUserIds
|
completedUserIds | string |
Список всех завершенных идентификаторов пользователей |
|
CreatedDate
|
createdDate | string |
Дата создания. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
CreatorId
|
creatorId | string |
Идентификатор пользователя создателя |
|
Description
|
description | string |
Описание задания |
|
Дата выполнения
|
dueDate | string |
Дата выполнения задачи. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
IntendedUserIds
|
intendedUserIds | string |
Предполагаемые пользователи для этой задачи |
|
Напоминание
|
reminderDate | string |
Дата напоминания. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
ТребуетсяAllRecipients
|
requiresAllRecipients | boolean |
Определяет, должны ли все получатели закрыть эту задачу |
|
ShowCloseTaskDialog
|
showCloseTaskDialog | boolean |
Показать диалоговое окно закрытия задачи в конце задачи |
|
Состояние
|
statusEnum | string |
Состояние состояния задачи (Open, InProcess, Complete, PreparedToComplete, Error) |
|
TaskTemplateId
|
taskTemplateId | string |
Идентификатор шаблона задачи |
Закрытие открытого процесса
Закрытие открытого процесса
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL-адрес api архива (например: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
connectionId | True | string |
Идентификатор подключения для идентификации подключения |
|
ProcessId
|
processId | True | string |
Идентификатор процесса (GUID) |
|
Комментарий
|
comment | string |
Комментарий для добавления |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
AccessRightsEnumList
|
CloseProcessResult.AccessRightsEnumList | array of string |
accessRightsEnumList |
|
CheckOutStateEnum
|
CloseProcessResult.CheckOutStateEnum | string |
Проверьте состояние документа (NotCheckedOut, CheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
CloseProcessResult.CheckOutUserId | string |
Идентификатор пользователя, для которого извлечен процесс |
|
Comments
|
CloseProcessResult.Comments | array of object |
Comments |
|
Date
|
CloseProcessResult.Comments.Date | string |
Дата комментария |
|
Идентификатор
|
CloseProcessResult.Comments.Id | string |
Идентификатор комментария |
|
Текст
|
CloseProcessResult.Comments.Text | string |
Определяемый пользователем комментарий |
|
UserId
|
CloseProcessResult.Comments.UserId | string |
Идентификатор пользователя |
|
ЗавершеноDate
|
CloseProcessResult.CompletedDate | string |
Дата завершения процесса. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
Завершенныеtasks
|
CloseProcessResult.CompletedTasks | array of object |
Завершенныеtasks |
|
Действие
|
CloseProcessResult.CompletedTasks.Action | string |
Текст действия для пользователя |
|
AssignedUserIds
|
CloseProcessResult.CompletedTasks.AssignedUserIds | array of |
AssignedUserIds |
|
Comments
|
CloseProcessResult.CompletedTasks.Comments | array of object |
Comments |
|
Date
|
CloseProcessResult.CompletedTasks.Comments.Date | string |
Дата комментария |
|
Идентификатор
|
CloseProcessResult.CompletedTasks.Comments.Id | string |
Идентификатор комментария |
|
Текст
|
CloseProcessResult.CompletedTasks.Comments.Text | string |
Определяемый пользователем комментарий |
|
UserId
|
CloseProcessResult.CompletedTasks.Comments.UserId | string |
Идентификатор пользователя, который задал комментарий |
|
ЗавершеноDate
|
CloseProcessResult.CompletedTasks.CompletedDate | string |
Дата завершения завершенной задачи. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
CompletedUserIds
|
CloseProcessResult.CompletedTasks.CompletedUserIds | array of string |
CompletedUserIds |
|
CreatedDate
|
CloseProcessResult.CompletedTasks.CreatedDate | string |
Дата создания завершенной задачи. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
CreatorId
|
CloseProcessResult.CompletedTasks.CreatorId | string |
Идентификатор пользователя создателя завершенной задачи |
|
Description
|
CloseProcessResult.CompletedTasks.Description | string |
Описание задачи завершенной задачи |
|
Дата выполнения
|
CloseProcessResult.CompletedTasks.DueDate | string |
Дата выполнения задачи. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
Идентификатор
|
CloseProcessResult.CompletedTasks.Id | string |
Идентификатор задачи |
|
IntendedUserIds
|
CloseProcessResult.CompletedTasks.IntendedUserIds | array of |
IntendedUserIds |
|
Напоминание
|
CloseProcessResult.CompletedTasks.ReminderDate | string |
Дата напоминания о завершенной задаче. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
ТребуетсяAllRecipients
|
CloseProcessResult.CompletedTasks.RequiresAllRecipients | boolean |
Определяет, должны ли все получатели закрыть эту задачу |
|
ShowCloseTaskDialog
|
CloseProcessResult.CompletedTasks.ShowCloseTaskDialog | boolean |
Показать диалоговое окно закрытия задачи в конце задачи |
|
StatusEnum
|
CloseProcessResult.CompletedTasks.StatusEnum | string |
Состояние задачи (Open, InProcess, Complete, PreparedToComplete, Error) |
|
TaskTemplateId
|
CloseProcessResult.CompletedTasks.TaskTemplateId | string |
Идентификатор шаблона задачи |
|
CreatedDate
|
CloseProcessResult.CreatedDate | string |
Дата создания формата даты процесса: гггг-ММ-ддTHH:mm:ss |
|
Действие
|
CloseProcessResult.CurrentTask.Action | string |
Текст действия для пользователя |
|
AssignedUserIds
|
CloseProcessResult.CurrentTask.AssignedUserIds | array of string |
AssignedUserIds |
|
Comments
|
CloseProcessResult.CurrentTask.Comments | array of object |
Comments |
|
Date
|
CloseProcessResult.CurrentTask.Comments.Date | string |
Дата комментария |
|
Идентификатор
|
CloseProcessResult.CurrentTask.Comments.Id | string |
Идентификатор комментария |
|
Текст
|
CloseProcessResult.CurrentTask.Comments.Text | string |
Определяемый пользователем комментарий |
|
UserId
|
CloseProcessResult.CurrentTask.Comments.UserId | string |
Идентификатор пользователя, который задал комментарий |
|
ЗавершеноDate
|
CloseProcessResult.CurrentTask.CompletedDate | string |
Дата завершения текущей задачи. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
CompletedUserIds
|
CloseProcessResult.CurrentTask.CompletedUserIds | array of string |
CompletedUserIds |
|
CreatedDate
|
CloseProcessResult.CurrentTask.CreatedDate | string |
Дата создания текущей задачи. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
CreatorId
|
CloseProcessResult.CurrentTask.CreatorId | string |
Идентификатор пользователя создателя текущей задачи |
|
Description
|
CloseProcessResult.CurrentTask.Description | string |
Описание задачи текущей задачи |
|
Дата выполнения
|
CloseProcessResult.CurrentTask.DueDate | string |
Дата выполнения текущей задачи. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
Идентификатор
|
CloseProcessResult.CurrentTask.Id | string |
Идентификатор текущей задачи |
|
IntendedUserIds
|
CloseProcessResult.CurrentTask.IntendedUserIds | array of string |
IntendedUserIds |
|
Напоминание
|
CloseProcessResult.CurrentTask.ReminderDate | string |
Дата напоминания текущей задачи. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
ТребуетсяAllRecipients
|
CloseProcessResult.CurrentTask.RequiresAllRecipients | boolean |
Определяет, должны ли все получатели закрыть текущую задачу. |
|
ShowCloseTaskDialog
|
CloseProcessResult.CurrentTask.ShowCloseTaskDialog | boolean |
Показать диалоговое окно закрытия задачи в текущей задаче |
|
StatusEnum
|
CloseProcessResult.CurrentTask.StatusEnum | string |
Состояние текущей задачи (Open, InProcess, Complete, PreparedToComplete, Error) |
|
TaskTemplateId
|
CloseProcessResult.CurrentTask.TaskTemplateId | string |
Идентификатор шаблона задачи текущей задачи |
|
CustomProperties
|
CloseProcessResult.CustomProperties | array of object |
CustomProperties |
|
CustomPropertyTypeEnum
|
CloseProcessResult.CustomProperties.CustomPropertyTypeEnum | string |
Значение перечисления типа пользовательского свойства (String, Date, Number) |
|
Имя
|
CloseProcessResult.CustomProperties.Name | string |
Имя настраиваемого свойства |
|
Ценность
|
CloseProcessResult.CustomProperties.Value | string |
Значение настраиваемого свойства |
|
DocumentIds
|
CloseProcessResult.DocumentIds | array of string |
DocumentIds |
|
Дата выполнения
|
CloseProcessResult.DueDate | string |
Дата выполнения процесса. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
Идентификатор
|
CloseProcessResult.Id | string |
Идентификатор процесса |
|
Ценности
|
CloseProcessResult.Name.Values | array of object |
Ценности |
|
Культура
|
CloseProcessResult.Name.Values.Culture | string |
Язык и региональные параметры, в которых указан текст (de, en, fr, ...) |
|
Текст
|
CloseProcessResult.Name.Values.Text | string |
Имя процесса |
|
PluginStream
|
CloseProcessResult.PluginStream | array of |
PluginStream |
|
PriorityEnum
|
CloseProcessResult.PriorityEnum | string |
Приоритет процесса (высокий, обычный, низкий) |
|
ProcessTemplateId
|
CloseProcessResult.ProcessTemplateId | string |
Идентификатор шаблона процесса |
|
Свойства
|
CloseProcessResult.Properties | array of object |
Свойства |
|
GlobalValues
|
CloseProcessResult.Properties.GlobalValues | array of object |
GlobalValues |
|
Ценности
|
CloseProcessResult.Properties.GlobalValues.Values | array of object |
Ценности |
|
Культура
|
CloseProcessResult.Properties.GlobalValues.Values.Culture | string |
Культура |
|
Текст
|
CloseProcessResult.Properties.GlobalValues.Values.Text | string |
Текст |
|
PropertyTypeId
|
CloseProcessResult.Properties.PropertyTypeId | string |
Идентификатор типа поля индекса |
|
Ценности
|
CloseProcessResult.Properties.Values | array of string |
Ценности |
|
ProtectionDomainId
|
CloseProcessResult.ProtectionDomainId | string |
Идентификатор домена защиты процесса |
|
SessionCount
|
CloseProcessResult.SessionCount | integer |
Количество сеансов |
|
StatusEnum
|
CloseProcessResult.StatusEnum | string |
Состояние процесса (Open, InProcess, Complete, PreparedToComplete, Error) |
Обновление документа (версия 2)
Обновление документа (версия 2)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL-адрес api архива (например: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Идентификатор подключения для идентификации подключения |
|
DocumentTitle
|
DocumentTitle | string |
Название документа |
|
|
DocumentProperties
|
DocumentProperties | string |
Формат обновления свойств документа: Firstname=Peter|Lastname=Muller|InvoiceNo=4711; 4712; 4713 |
|
|
RemoveDocumentProperties
|
RemoveDocumentProperties | string |
Список разделенных точками с запятой имен свойств или идентификаторов для удаления из документа, например FistName; b9cfbdf7-f6fb-4179-91c8-d9681fb680dd; Отделы" |
|
|
Культура
|
Culture | string |
Язык и региональные параметры, в которых указан текст (de, en, fr, ...). Default = de |
|
|
DocumentId
|
DocumentId | True | string |
Идентификатор документа |
|
ProtectionDomain
|
ProtectionDomain | string |
Имя или идентификатор protectionDomain |
|
|
Блог
|
Blog | string |
Добавление записи текста блога в документе |
|
|
UploadMethod
|
UploadMethod | string |
Метод, используемый при отправке документа в InfoShare. Default = UploadFileBytesLarge |
|
|
FileContent
|
FileContent | string |
Строка содержимого файла base64 |
|
|
ForceUndoCheckout
|
ForceUndoCheckout | boolean |
Отмена выхода документа. Default = false |
|
|
ChunkSize
|
ChunkSize | integer |
Размер блока отправки файла, используемого с методами отправки UploadStreamChunks и UploadFileBytesLarge, 262144 |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
абоннементы
|
abonnements | array of object |
Абоннементы |
|
OnContentChange
|
abonnements.onContentChange | boolean |
Абононмент активен при изменениях файлов |
|
OnDelete
|
abonnements.onDelete | boolean |
Абонннмент активен при удалении |
|
OnMetadataChange
|
abonnements.onMetadataChange | boolean |
Абононмент активен при изменениях индекса |
|
UserId
|
abonnements.userId | string |
Идентификатор пользователя для этого объекта abonnnement |
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
Список перечисления прав доступа |
|
postItAnnotations
|
annotationManager.postItAnnotations | array of object |
postItAnnotations |
|
CreatedDate
|
annotationManager.postItAnnotations.createdDate | string |
Дата создания из публикации заметки |
|
CreatorId
|
annotationManager.postItAnnotations.creatorId | string |
Идентификатор пользователя создателя из публикации заметки |
|
IsItalic
|
annotationManager.postItAnnotations.fontInfo.isItalic | boolean |
Является курсивом шрифта из публикации заметки |
|
IsStrikeOut
|
annotationManager.postItAnnotations.fontInfo.isStrikeOut | boolean |
Вычеркивает шрифт из публикации заметки |
|
IsUnderline
|
annotationManager.postItAnnotations.fontInfo.isUnderline | boolean |
Является ли шрифт подчеркиванием из публикации заметки |
|
Имя
|
annotationManager.postItAnnotations.fontInfo.name | string |
Имя шрифта из публикации заметки. Default = Arial |
|
Подача
|
annotationManager.postItAnnotations.fontInfo.pitch | integer |
Шаг шрифта из публикации заметки |
|
Size
|
annotationManager.postItAnnotations.fontInfo.size | integer |
Размер шрифта из публикации заметки. Пример: размер:12 — 12000. Вам нужен фактор 1000 |
|
Weight
|
annotationManager.postItAnnotations.fontInfo.weight | integer |
Вес шрифта из публикации заметки |
|
Идентификатор
|
annotationManager.postItAnnotations.id | string |
Заметка о публикации идентификатора |
|
ИзменениеDate
|
annotationManager.postItAnnotations.modifiedDate | string |
Дата изменения из публикации заметки. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
PageNumber
|
annotationManager.postItAnnotations.pageNumber | integer |
Количество страниц из публикации заметки |
|
SecurityLevelEnum
|
annotationManager.postItAnnotations.securityLevelEnum | string |
Уровень безопасности для публикации заметки (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Default = PubliclyAvailable |
|
Выбор
|
annotationManager.postItAnnotations.selectable | boolean |
Определяет, можно ли выбрать запись заметки пользователем. |
|
Текст
|
annotationManager.postItAnnotations.text | string |
Определяемый пользователем текст для публикации заметки |
|
X
|
annotationManager.postItAnnotations.x | integer |
Координата X в пикселях на дюйм для 7200 DPI записи заметки |
|
У
|
annotationManager.postItAnnotations.y | integer |
Координата Y в пикселях на дюйм для 7200 DPI публикации заметки |
|
прямоугольникиAnnotations
|
annotationManager.rectangleAnnotations | array of object |
прямоугольникиAnnotations |
|
Цвет
|
annotationManager.rectangleAnnotations.color | integer |
Цвет прямоугольника (32-разрядное значение ARGB) из заметки прямоугольника: черный: -16777216 белый: -1 красный: -65536 зеленый: -16744448 синий: -16776961 |
|
ColorHexCode
|
annotationManager.rectangleAnnotations.colorHexCode | string |
Цвет прямоугольника (шестнадцатеричный код RGB) из заметки прямоугольника. Пример: черный: #000000 белый: #FFFFFF красный: #FF0000 зеленый: #008000 синий: #0000FF |
|
CreatedDate
|
annotationManager.rectangleAnnotations.createdDate | string |
Дата создания из заметки прямоугольника. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
creatorId
|
annotationManager.rectangleAnnotations.creatorId | string |
Идентификатор создателя заметки прямоугольника |
|
Высота
|
annotationManager.rectangleAnnotations.height | integer |
Высота прямоугольника в пикселях на дюйм для 7200 DPI |
|
Идентификатор
|
annotationManager.rectangleAnnotations.Id | string |
Идентификатор заметки прямоугольника |
|
ИзменениеDate
|
annotationManager.rectangleAnnotations.modifiedDate | string |
Дата изменения из заметки прямоугольника. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
PageNumber
|
annotationManager.rectangleAnnotations.pageNumber | integer |
Число страниц из заметки прямоугольника |
|
SecurityLevelEnum
|
annotationManager.rectangleAnnotations.securityLevelEnum | string |
Уровень безопасности для заметки прямоугольника (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Default = PubliclyAvailable |
|
Выбор
|
annotationManager.rectangleAnnotations.selectable | boolean |
Определяет, можно ли выбрать заметку прямоугольника пользователем |
|
Transparent
|
annotationManager.rectangleAnnotations.transparent | boolean |
Прямоугольник должен быть прозрачным (выделение) |
|
Ширина
|
annotationManager.rectangleAnnotations.width | integer |
Ширина прямоугольника в пикселях на дюйм для 7200 DPI |
|
X
|
annotationManager.rectangleAnnotations.x | integer |
Координата X в пикселях на дюйм для 7200 DPI из заметки прямоугольника |
|
У
|
annotationManager.rectangleAnnotations.y | integer |
Координата Y в пикселях на дюйм для 7200 DPI из заметки прямоугольника |
|
textAnnotations
|
annotationManager.textAnnotations | array of object |
Текстовые заметки |
|
BackgroundColor
|
annotationManager.textAnnotations.backgroundColor | integer |
Цвет фона (32-разрядное значение ARGB) из текстовой заметки. Пример: черный: -16777216 белый: -1 красный: -65536 зеленый: -16744448 синий: -16776961 |
|
BackgroundColorHexCode
|
annotationManager.textAnnotations.backgroundColorHexCode | string |
Цвет фона (шестнадцатеричный код RGB) из текстовой заметки. Пример: черный: #000000 белый: #FFFFFF красный: #FF0000 зеленый: #008000 синий: #0000FF |
|
CreatedDate
|
annotationManager.textAnnotations.createdDate | string |
дата создания из текстовой заметки. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
CreatorId
|
annotationManager.textAnnotations.creatorId | string |
Идентификатор пользователя создателя из текстовой заметки |
|
IsItalic
|
annotationManager.textAnnotations.fontInfo.isItalic | boolean |
Является курсивом шрифта из текстовой заметки |
|
IsStrikeOut
|
annotationManager.textAnnotations.fontInfo.isStrikeOut | boolean |
Вычеркивает шрифт из текстовой заметки |
|
IsUnderline
|
annotationManager.textAnnotations.fontInfo.isUnderline | boolean |
Подчеркивание шрифта из текстовой заметки |
|
Имя
|
annotationManager.textAnnotations.fontInfo.name | string |
Имя шрифта из текстовой заметки. Default = Arial |
|
Подача
|
annotationManager.textAnnotations.fontInfo.pitch | integer |
Шаг шрифта из текстовой заметки |
|
Size
|
annotationManager.textAnnotations.fontInfo.size | integer |
Размер шрифта из текстовой заметки. Пример: размер:12 — 12000. Вам нужен фактор 1000 |
|
Weight
|
annotationManager.textAnnotations.fontInfo.weight | integer |
Вес шрифта из текстовой заметки |
|
ForegroundColor
|
annotationManager.textAnnotations.foregroundColor | integer |
Цвет переднего плана (32-разрядное значение ARGB) из текстовой заметки. Пример: черный: -16777216 белый: -1 красный: -65536 зеленый: -16744448 синий: -16776961 |
|
ForegroundColorHexCode
|
annotationManager.textAnnotations.foregroundColorHexCode | string |
Цвет переднего плана (шестнадцатеричный код RGB) из текстовой заметки. Пример: черный: #000000 белый: #FFFFFF красный: #FF0000 зеленый: #008000 синий: #0000FF |
|
Высота
|
annotationManager.textAnnotations.height | integer |
Высота текста в пикселях на дюйм для 7200 DPI из текстовой заметки |
|
Идентификатор
|
annotationManager.textAnnotations.id | string |
Идентификатор текстовой заметки |
|
ИзменениеDate
|
annotationManager.textAnnotations.modifiedDate | string |
Дата изменения из текстовой заметки. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
PageNumber
|
annotationManager.textAnnotations.pageNumber | integer |
Количество страниц из текстовой заметки |
|
Вращение
|
annotationManager.textAnnotations.rotation | integer |
Поворот в градусах из текстовой заметки |
|
SecurityLevelEnum
|
annotationManager.textAnnotations.securityLevelEnum | string |
Уровень безопасности для текстовой заметки (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Default = PubliclyAvailable |
|
Выбор
|
annotationManager.textAnnotations.selectable | boolean |
Определяет, можно ли выбрать текстовую заметку пользователем |
|
Текст
|
annotationManager.textAnnotations.text | string |
Определяемый пользователем текст заметки |
|
Transparent
|
annotationManager.textAnnotations.transparent | boolean |
Текстовая заметка должна быть прозрачной |
|
Ширина
|
annotationManager.textAnnotations.width | integer |
Ширина текста в пикселях на дюйм для 7200 DPI из текстовой заметки |
|
X
|
annotationManager.textAnnotations.x | integer |
Координата X в пикселях на дюйм для 7200 DPI из текстовой заметки |
|
У
|
annotationManager.textAnnotations.y | integer |
Координата Y в пикселях на дюйм для 7200 DPI из текстовой заметки |
|
блоги
|
blogs | array of object |
блоги |
|
CreatedDate
|
blogs.createdDate | string |
Дата создания блога. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
CreatorId
|
blogs.creatorId | string |
Идентификатор пользователя блога о создании пользователя |
|
Идентификатор
|
blogs.id | string |
Идентификатор блога |
|
Текст
|
blogs.text | string |
Текст элемента блога |
|
CheckOutStateEnum
|
checkOutStateEnum | string |
Проверьте состояние документа (NotCheckedOut, CheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
checkOutUserId | string |
Идентификатор пользователя, для которого извлечен документ |
|
documentData
|
documentData | array of object |
Данные документа |
|
Идентификатор
|
documentData.id | string |
Идентификатор данных документа |
|
Имя
|
documentData.name | string |
Имя данных документа |
|
Представления
|
documentData.renditions | array of |
Представления |
|
HasOverlay
|
hasOverlay | boolean |
Определяет, должен ли документ отображаться с наложением |
|
Идентификатор
|
id | string |
Идентификатор документа |
|
ImportTemplateId
|
importTemplateId | string |
Идентификатор шаблона импорта для этого документа |
|
InfoStoreId
|
infoStoreId | string |
Идентификатор хранилища сведений |
|
CheckOutLifeCycleStateId
|
lifeCycleManager.checkOutLifeCycleStateId | string |
Состояние жизненного цикла проверки |
|
LifeCycleEndDate
|
lifeCycleManager.lifeCycleEndDate | string |
Вычисляемая дата окончания жизненного цикла. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
LifeCycleStartDate
|
lifeCycleManager.lifeCycleStartDate | string |
Дата начала жизненного цикла. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
LifeCycleStateId
|
lifeCycleManager.lifeCycleStateId | string |
Идентификатор состояния LifeCycle |
|
NextAutomaticLifeCycleStateId
|
lifeCycleManager.nextAutomaticLifeCycleStateId | string |
Следующее состояние жизненного цикла |
|
nextLifeCycleStates
|
lifeCycleManager.nextLifeCycleStates | array of string |
Состояния следующего жизненного цикла |
|
lifeCycleProtections
|
lifeCycleManager.lifeCycleProtections | array of object |
lifeCycleProtections |
|
DeleteAfterExpiration
|
lifeCycleManager.lifeCycleProtections.deleteAfterExpiration | boolean |
Разрешить удалить документ после истечения срока действия защиты |
|
Идентификатор
|
lifeCycleManager.lifeCycleProtections.id | string |
Идентификатор защиты состояния жизненного цикла |
|
ProtectAnnotationChange
|
lifeCycleManager.lifeCycleProtections.protectAnnotationChange | boolean |
Защита от изменений примечаний |
|
ProtectCheckOut
|
lifeCycleManager.lifeCycleProtections.protectCheckOut | boolean |
Защита от извлечений |
|
ProtectContentChange
|
lifeCycleManager.lifeCycleProtections.protectContentChange | boolean |
Защита от изменения содержимого |
|
ProtectDelete
|
lifeCycleManager.lifeCycleProtections.protectDelete | boolean |
Защита от удаления |
|
ProtectPropertyChange
|
lifeCycleManager.lifeCycleProtections.protectPropertyChange | boolean |
Защита от изменений свойств |
|
ProtectProtectionDomainChange
|
lifeCycleManager.lifeCycleProtections.protectProtectionDomainChange | boolean |
Защита от изменений безопасности |
|
ProtectionDurationTicks
|
lifeCycleManager.lifeCycleProtections.protectionDurationTicks | integer |
Длительность защиты |
|
LifeCycleId
|
lifeCycleManager.lifeCycleId | string |
Идентификатор LifeCycle |
|
MainFileLength
|
mainFileLength | integer |
Размер основного файла |
|
Имя
|
name | string |
Имя документа |
|
PageCount
|
pageCount | integer |
Количество страниц основного файла |
|
properties
|
properties | array of object |
Свойства |
|
globalValues
|
properties.globalValues | array of object |
Глобальные значения |
|
values
|
properties.globalValues.values | array of object |
values |
|
Культура
|
properties.globalValues.values.culture | string |
Язык и региональные параметры глобального значения |
|
текст
|
properties.globalValues.values.text | string |
Текст глобального значения |
|
ИмяСвойства
|
properties.propertyName | string |
Имя свойства |
|
PropertyTypeId
|
properties.propertyTypeId | string |
Идентификатор типа поля индекса |
|
values
|
properties.values | array of string |
Значения типа свойства |
|
ProtectionDomainId
|
protectionDomainId | string |
Идентификатор домена защиты |
|
Напоминания
|
reminders | array of object |
Напоминания |
|
Description
|
reminders.description | string |
Описание напоминания |
|
Интервал
|
reminders.interval | integer |
Интервал в днях между напоминаниями |
|
ProcessTemplateId
|
reminders.processTemplateId | string |
Идентификатор шаблона процесса для этого напоминания |
|
Напоминание
|
reminders.reminderDate | string |
Дата напоминания. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
ReminderId
|
reminders.reminderId | string |
Идентификатор напоминания |
|
subjectIds
|
reminders.subjectIds | array of |
subjectIds |
|
UseUserFromProcessTemplate
|
reminders.useUserFromProcessTemplate | boolean |
Определяет, будет ли использоваться определение пользователя из шаблона процесса. |
|
ПодписьProfileId
|
signingProfileId | string |
Идентификатор профиля подписи |
|
VersionId
|
versionId | string |
Идентификатор версии документа |
Обновление документа (не рекомендуется) [DEPRECATED]
Обновление документа (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL-адрес api архива (например: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Идентификатор подключения для идентификации подключения |
|
DocumentId
|
DocumentId | True | string |
Идентификатор документа |
|
DocumentTitle
|
DocumentTitle | string |
Название документа |
|
|
DocumentProperties
|
DocumentProperties | string |
Формат обновления свойств документа: Firstname=Peter|Lastname=Muller|InvoiceNo=4711; 4712; 4713 |
|
|
Культура
|
Culture | string |
Язык и региональные параметры, в которых указан текст (de, en, fr, ...). Default = de |
|
|
FileContent
|
FileContent | string |
Строка содержимого файла base64 |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
абоннементы
|
abonnements | array of object |
абоннементы |
|
OnContentChange
|
abonnements.onContentChange | boolean |
Абононмент активен при изменениях файлов |
|
OnDelete
|
abonnements.onDelete | boolean |
Абонннмент активен при удалении |
|
OnMetadataChange
|
abonnements.onMetadataChange | boolean |
Абононмент активен при изменениях индекса |
|
UserId
|
abonnements.userId | string |
Идентификатор пользователя для этого объекта abonnnement |
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
accessRightsEnumList |
|
postItAnnotations
|
annotationManager.postItAnnotations | array of object |
postItAnnotations |
|
CreatedDate
|
annotationManager.postItAnnotations.createdDate | string |
Дата создания из публикации заметки |
|
CreatorId
|
annotationManager.postItAnnotations.creatorId | string |
Идентификатор пользователя создателя из публикации заметки |
|
IsItalic
|
annotationManager.postItAnnotations.fontInfo.isItalic | boolean |
Является курсивом шрифта из публикации заметки |
|
IsStrikeOut
|
annotationManager.postItAnnotations.fontInfo.isStrikeOut | boolean |
Вычеркивает шрифт из публикации заметки |
|
IsUnderline
|
annotationManager.postItAnnotations.fontInfo.isUnderline | boolean |
Является ли шрифт подчеркиванием из публикации заметки |
|
Имя
|
annotationManager.postItAnnotations.fontInfo.name | string |
Имя шрифта из публикации заметки. Default = Arial |
|
Подача
|
annotationManager.postItAnnotations.fontInfo.pitch | integer |
Шаг шрифта из публикации заметки |
|
Size
|
annotationManager.postItAnnotations.fontInfo.size | integer |
Размер шрифта из публикации заметки. Пример: размер:12 — 12000. Вам нужен фактор 1000 |
|
Weight
|
annotationManager.postItAnnotations.fontInfo.weight | integer |
Вес шрифта из публикации заметки |
|
Идентификатор
|
annotationManager.postItAnnotations.id | string |
Идентификатор публикации заметки |
|
ИзменениеDate
|
annotationManager.postItAnnotations.modifiedDate | string |
Дата изменения из публикации заметки. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
PageNumber
|
annotationManager.postItAnnotations.pageNumber | integer |
Количество страниц из публикации заметки |
|
SecurityLevelEnum
|
annotationManager.postItAnnotations.securityLevelEnum | string |
Уровень безопасности для публикации заметки (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Default = PubliclyAvailable |
|
Выбор
|
annotationManager.postItAnnotations.selectable | boolean |
Определяет, можно ли выбрать запись заметки пользователем. |
|
Текст
|
annotationManager.postItAnnotations.text | string |
Определяемый пользователем текст для публикации заметки |
|
X
|
annotationManager.postItAnnotations.x | integer |
Координата X в пикселях на дюйм для 7200 DPI записи заметки |
|
У
|
annotationManager.postItAnnotations.y | integer |
Координата Y в пикселях на дюйм для 7200 DPI публикации заметки |
|
прямоугольникиAnnotations
|
annotationManager.rectangleAnnotations | array of object |
прямоугольникиAnnotations |
|
Цвет
|
annotationManager.rectangleAnnotations.color | integer |
Цвет прямоугольника (32-разрядное значение ARGB) из заметки прямоугольника: черный: -16777216 белый: -1 красный: -65536 зеленый: -16744448 синий: -16776961 |
|
ColorHexCode
|
annotationManager.rectangleAnnotations.colorHexCode | string |
Цвет прямоугольника (шестнадцатеричный код RGB) из заметки прямоугольника. Пример: черный: #000000 белый: #FFFFFF красный: #FF0000 зеленый: #008000 синий: #0000FF |
|
CreatedDate
|
annotationManager.rectangleAnnotations.createdDate | string |
Дата создания из заметки прямоугольника. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
creatorId
|
annotationManager.rectangleAnnotations.creatorId | string |
CreatorId |
|
Высота
|
annotationManager.rectangleAnnotations.height | integer |
Высота прямоугольника в пикселях на дюйм для 7200 DPI |
|
Идентификатор
|
annotationManager.rectangleAnnotations.Id | string |
Идентификатор заметки прямоугольника |
|
ИзменениеDate
|
annotationManager.rectangleAnnotations.modifiedDate | string |
Дата изменения из заметки прямоугольника. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
PageNumber
|
annotationManager.rectangleAnnotations.pageNumber | integer |
Число страниц из заметки прямоугольника |
|
SecurityLevelEnum
|
annotationManager.rectangleAnnotations.securityLevelEnum | string |
Уровень безопасности для заметки прямоугольника (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Default = PubliclyAvailable |
|
Выбор
|
annotationManager.rectangleAnnotations.selectable | boolean |
Определяет, можно ли выбрать заметку прямоугольника пользователем |
|
Transparent
|
annotationManager.rectangleAnnotations.transparent | boolean |
Прямоугольник должен быть прозрачным (выделение) |
|
Ширина
|
annotationManager.rectangleAnnotations.width | integer |
Ширина прямоугольника в пикселях на дюйм для 7200 DPI |
|
X
|
annotationManager.rectangleAnnotations.x | integer |
Координата X в пикселях на дюйм для 7200 DPI из заметки прямоугольника |
|
У
|
annotationManager.rectangleAnnotations.y | integer |
Координата Y в пикселях на дюйм для 7200 DPI из заметки прямоугольника |
|
textAnnotations
|
annotationManager.textAnnotations | array of object |
textAnnotations |
|
BackgroundColor
|
annotationManager.textAnnotations.backgroundColor | integer |
Цвет фона (32-разрядное значение ARGB) из текстовой заметки. Пример: черный: -16777216 белый: -1 красный: -65536 зеленый: -16744448 синий: -16776961 |
|
BackgroundColorHexCode
|
annotationManager.textAnnotations.backgroundColorHexCode | string |
Цвет фона (шестнадцатеричный код RGB) из текстовой заметки. Пример: черный: #000000 белый: #FFFFFF красный: #FF0000 зеленый: #008000 синий: #0000FF |
|
CreatedDate
|
annotationManager.textAnnotations.createdDate | string |
дата создания из текстовой заметки. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
CreatorId
|
annotationManager.textAnnotations.creatorId | string |
Идентификатор пользователя создателя из текстовой заметки |
|
IsItalic
|
annotationManager.textAnnotations.fontInfo.isItalic | boolean |
Является курсивом шрифта из текстовой заметки |
|
IsStrikeOut
|
annotationManager.textAnnotations.fontInfo.isStrikeOut | boolean |
Вычеркивает шрифт из текстовой заметки |
|
IsUnderline
|
annotationManager.textAnnotations.fontInfo.isUnderline | boolean |
Подчеркивание шрифта из текстовой заметки |
|
Имя
|
annotationManager.textAnnotations.fontInfo.name | string |
Имя шрифта из текстовой заметки. Default = Arial |
|
Подача
|
annotationManager.textAnnotations.fontInfo.pitch | integer |
Шаг шрифта из текстовой заметки |
|
Size
|
annotationManager.textAnnotations.fontInfo.size | integer |
Размер шрифта из текстовой заметки. Пример: размер:12 — 12000. Вам нужен фактор 1000 |
|
Weight
|
annotationManager.textAnnotations.fontInfo.weight | integer |
Вес шрифта из текстовой заметки |
|
ForegroundColor
|
annotationManager.textAnnotations.foregroundColor | integer |
Цвет переднего плана (32-разрядное значение ARGB) из текстовой заметки. Пример: черный: -16777216 белый: -1 красный: -65536 зеленый: -16744448 синий: -16776961 |
|
ForegroundColorHexCode
|
annotationManager.textAnnotations.foregroundColorHexCode | string |
Цвет переднего плана (шестнадцатеричный код RGB) из текстовой заметки. Пример: черный: #000000 белый: #FFFFFF красный: #FF0000 зеленый: #008000 синий: #0000FF |
|
Высота
|
annotationManager.textAnnotations.height | integer |
Высота текста в пикселях на дюйм для 7200 DPI из текстовой заметки |
|
Идентификатор
|
annotationManager.textAnnotations.id | string |
Идентификатор текстовой заметки |
|
ИзменениеDate
|
annotationManager.textAnnotations.modifiedDate | string |
Дата изменения из текстовой заметки. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
PageNumber
|
annotationManager.textAnnotations.pageNumber | integer |
Количество страниц из текстовой заметки |
|
Вращение
|
annotationManager.textAnnotations.rotation | integer |
Поворот в градусах из текстовой заметки |
|
SecurityLevelEnum
|
annotationManager.textAnnotations.securityLevelEnum | string |
Уровень безопасности для текстовой заметки (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Default = PubliclyAvailable |
|
Выбор
|
annotationManager.textAnnotations.selectable | boolean |
Определяет, можно ли выбрать текстовую заметку пользователем |
|
Текст
|
annotationManager.textAnnotations.text | string |
Определяемый пользователем текст заметки |
|
Transparent
|
annotationManager.textAnnotations.transparent | boolean |
Текстовая заметка должна быть прозрачной |
|
Ширина
|
annotationManager.textAnnotations.width | integer |
Ширина текста в пикселях на дюйм для 7200 DPI из текстовой заметки |
|
X
|
annotationManager.textAnnotations.x | integer |
Координата X в пикселях на дюйм для 7200 DPI из текстовой заметки |
|
У
|
annotationManager.textAnnotations.y | integer |
Координата Y в пикселях на дюйм для 7200 DPI из текстовой заметки |
|
блоги
|
blogs | array of object |
блоги |
|
CreatedDate
|
blogs.createdDate | string |
Дата создания блога. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
CreatorId
|
blogs.creatorId | string |
Идентификатор пользователя блога о создании пользователя |
|
Идентификатор
|
blogs.id | string |
Идентификатор блога |
|
Текст
|
blogs.text | string |
Текст элемента блога |
|
CheckOutStateEnum
|
checkOutStateEnum | string |
Проверьте состояние документа (NotCheckedOut, CheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
checkOutUserId | string |
Идентификатор пользователя, для которого извлечен документ |
|
documentData
|
documentData | array of object |
documentData |
|
Идентификатор
|
documentData.id | string |
Идентификатор данных документа |
|
Имя
|
documentData.name | string |
Имя данных документа |
|
Представления
|
documentData.renditions | array of |
Представления |
|
HasOverlay
|
hasOverlay | boolean |
Определяет, должен ли документ отображаться с наложением |
|
Идентификатор
|
id | string |
Идентификатор документа |
|
ImportTemplateId
|
importTemplateId | string |
Идентификатор шаблона импорта для этого документа |
|
InfoStoreId
|
infoStoreId | string |
Идентификатор хранилища сведений |
|
CheckOutLifeCycleStateId
|
lifeCycleManager.checkOutLifeCycleStateId | string |
Состояние жизненного цикла проверки |
|
LifeCycleEndDate
|
lifeCycleManager.lifeCycleEndDate | string |
Вычисляемая дата окончания жизненного цикла. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
LifeCycleStartDate
|
lifeCycleManager.lifeCycleStartDate | string |
Дата начала жизненного цикла. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
LifeCycleStateId
|
lifeCycleManager.lifeCycleStateId | string |
Идентификатор состояния LifeCycle |
|
NextAutomaticLifeCycleStateId
|
lifeCycleManager.nextAutomaticLifeCycleStateId | string |
Следующее состояние жизненного цикла |
|
nextLifeCycleStates
|
lifeCycleManager.nextLifeCycleStates | array of string |
nextLifeCycleStates |
|
lifeCycleProtections
|
lifeCycleManager.lifeCycleProtections | array of object |
lifeCycleProtections |
|
DeleteAfterExpiration
|
lifeCycleManager.lifeCycleProtections.deleteAfterExpiration | boolean |
Разрешить удалить документ после истечения срока действия защиты |
|
Идентификатор
|
lifeCycleManager.lifeCycleProtections.id | string |
Идентификатор защиты состояния жизненного цикла |
|
ProtectAnnotationChange
|
lifeCycleManager.lifeCycleProtections.protectAnnotationChange | boolean |
Защита от изменений примечаний |
|
ProtectCheckOut
|
lifeCycleManager.lifeCycleProtections.protectCheckOut | boolean |
Защита от извлечений |
|
ProtectContentChange
|
lifeCycleManager.lifeCycleProtections.protectContentChange | boolean |
Защита от изменения содержимого |
|
ProtectDelete
|
lifeCycleManager.lifeCycleProtections.protectDelete | boolean |
Защита от удаления |
|
ProtectPropertyChange
|
lifeCycleManager.lifeCycleProtections.protectPropertyChange | boolean |
Защита от изменений свойств |
|
ProtectProtectionDomainChange
|
lifeCycleManager.lifeCycleProtections.protectProtectionDomainChange | boolean |
Защита от изменений безопасности |
|
ProtectionDurationTicks
|
lifeCycleManager.lifeCycleProtections.protectionDurationTicks | integer |
Длительность защиты |
|
LifeCycleId
|
lifeCycleManager.lifeCycleId | string |
Идентификатор LifeCycle |
|
MainFileLength
|
mainFileLength | integer |
Размер основного файла |
|
Имя
|
name | string |
Имя документа |
|
PageCount
|
pageCount | integer |
Количество страниц основного файла |
|
properties
|
properties | array of object |
properties |
|
globalValues
|
properties.globalValues | array of object |
globalValues |
|
values
|
properties.globalValues.values | array of object |
values |
|
Культура
|
properties.globalValues.values.culture | string |
Культура |
|
текст
|
properties.globalValues.values.text | string |
Текст |
|
ИмяСвойства
|
properties.propertyName | string |
Имя свойства |
|
PropertyTypeId
|
properties.propertyTypeId | string |
Идентификатор типа поля индекса |
|
values
|
properties.values | array of string |
Значения PropertyType |
|
ProtectionDomainId
|
protectionDomainId | string |
Идентификатор домена защиты |
|
Напоминания
|
reminders | array of object |
Напоминания |
|
Description
|
reminders.description | string |
Описание напоминания |
|
Интервал
|
reminders.interval | integer |
Интервал в днях между напоминаниями |
|
ProcessTemplateId
|
reminders.processTemplateId | string |
Идентификатор шаблона процесса для этого напоминания |
|
Напоминание
|
reminders.reminderDate | string |
Дата напоминания. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
ReminderId
|
reminders.reminderId | string |
Идентификатор напоминания |
|
subjectIds
|
reminders.subjectIds | array of |
subjectIds |
|
UseUserFromProcessTemplate
|
reminders.useUserFromProcessTemplate | boolean |
Определяет, будет ли использоваться определение пользователя из шаблона процесса. |
|
ПодписьProfileId
|
signingProfileId | string |
Идентификатор профиля подписи |
|
VersionId
|
versionId | string |
Идентификатор версии документа |
Обновление строки в пользовательской таблице
Обновление строки в пользовательской таблице
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL-адрес api архива (например: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Идентификатор подключения для идентификации подключения |
|
Имя таблицы пользователя
|
UserTable | True | string |
Имя таблицы пользователя |
|
RowData
|
RowData | True | string |
Строка, содержащая данные строк для обновления, разделенные точкой с запятой, первый элемент должен быть InternalRecord_Id строки для обновления, "100" в следующем примере: 100; John; Самка; 2024-01-01; 2024-12-31 |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
userTableUpdateRowResult
|
userTableUpdateRowResult | integer |
userTableUpdateRowResult |
Поиск документов (версия 2)
Поиск документов (версия 2)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL-адрес api архива (например: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Идентификатор подключения для идентификации подключения |
|
Conditions
|
Conditions | string |
Формат условия поиска: [<PropertyName>|<СравнениеEnum>|<PropertyValue>|<RelationEnum>]. ComparisonEnums: "Equals,NotEquals,Greater,GreaterEquals,Less,LessEquals,Like,Contains,EqualsUndefined,In,None,Soundex,NotIn," RelationEnums:"And,Or". например: [Последняя проверка|Less|2021-12-31|And],[Firstname|Равно|Питер |And],[Дата|Между|2021-12-31; 2022-12-31|И] |
|
|
MaxSerchResults
|
MaxSerchResults | string |
Максимальное количество результатов поиска документов. По умолчанию = 100 |
|
|
ResultProperties
|
ResultProperties | string |
Список свойств результатов, разделенный запятыми. Может быть именем или идентификатором свойства, например "Name,Last check in,68b901cd-4d8f-11e6-aa6f-00ff04d7e62a" |
|
|
Культура
|
Culture | string |
Язык и региональные параметры, в которых указан текст (de, en, fr, ...). Default = de |
|
|
Хранилища
|
Stores | string |
Разделенный запятыми список InfoStores для поиска. Может храниться имя или идентификатор, например "Standard,9cd306e3-7e96-486c-8280-65d9f0239776" |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Документы
|
documents | array of object |
Результат поиска документов |
|
имя
|
documents.name | string |
Имя документа |
|
id
|
documents.id | string |
Идентификатор документа |
|
folderElementId
|
documents.folderElementId | string |
Идентификатор элемента Folder |
|
checkOutStateEnum
|
documents.checkOutStateEnum | string |
Проверка перечисления состояния |
|
hasSignature
|
documents.hasSignature | boolean |
Имеет сигнатуру |
|
hasBlog
|
documents.hasBlog | boolean |
Блог |
|
hasAnnotation
|
documents.hasAnnotation | boolean |
Имеет заметку |
|
hasLinks
|
documents.hasLinks | boolean |
Содержит ссылки |
|
properties
|
documents.properties | array of object |
Свойства |
|
propertyTypeId
|
documents.properties.propertyTypeId | string |
Идентификатор PropertyType |
|
values
|
documents.properties.values | array of string |
Значения типа свойства |
|
globalValues
|
documents.properties.globalValues | array of object |
Глобальные значения |
|
values
|
documents.properties.globalValues.values | array of object |
values |
|
Культура
|
documents.properties.globalValues.values.culture | string |
Региональные параметры и региональные параметры глобальных значений |
|
текст
|
documents.properties.globalValues.values.text | string |
Текст глобальных значений |
|
propertyTypeName
|
documents.properties.propertyTypeName | string |
Имя PropertyType |
|
propertyName
|
documents.properties.propertyName | string |
Название свойства |
|
hasTempAccess
|
documents.hasTempAccess | boolean |
Имеет временный доступ |
|
accessRightsEnumList
|
documents.accessRightsEnumList | array of string |
Список перечисления прав доступа |
|
mainFileLength
|
documents.mainFileLength | integer |
Длина основного файла |
|
versionId
|
documents.versionId | string |
Идентификатор версии |
|
hasReminders
|
documents.hasReminders | boolean |
Есть напоминания |
|
hasAbonnement
|
documents.hasAbonnement | boolean |
Имеет абоннемент |
|
hasOverlay
|
documents.hasOverlay | boolean |
Наложение Oas |
|
hasMore
|
hasMore | boolean |
Есть больше |
|
резюмеPoint
|
resumePoint | string |
Точка возобновления |
Поиск документов (не рекомендуется) [DEPRECATED]
Поиск документов (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL-адрес api архива (например: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Идентификатор подключения для идентификации подключения |
|
Conditions
|
Conditions | string |
Формат условия поиска: [<PropertyName>|<СравнениеEnum>|<PropertyValue>|<RelationEnum>]. ComparisonEnums: "Equals,NotEquals,GreaterEquals,Less,LessEquals,Like,Contains,EqualsUndefined,In,None,Soundex,NotIn" RelationEnums:"And,Or". например: [Последняя проверка|Less|2021-12-31|And],[Firstname|Равно|Питер |И] |
|
|
Культура
|
Culture | string |
Язык и региональные параметры (de,en,fr,...). Default = de |
|
|
FulltextWords
|
FulltextWords | string |
Слова для поиска с полным текстом |
|
|
FulltextWordRelation
|
FulltextWordRelation | string |
Отношение полнотекстового слова (AND, OR). Default = AND |
|
|
MaxSerchResults
|
MaxSerchResults | string |
Максимальное количество результатов поиска документов. По умолчанию = 100 |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Документы
|
documents | array of object |
Документы |
|
Абоннементы
|
documents.abonnements | string |
Список абонментов |
|
accessRightsEnumList
|
documents.accessRightsEnumList | array of string |
accessRightsEnumList |
|
AnnotationManager
|
documents.annotationManager | string |
Заметки для основного файла документа |
|
Blogs
|
documents.blogs | string |
Список всех элементов блога |
|
CheckOutState
|
documents.checkOutStateEnum | string |
Проверьте состояние документа (NotCheckedOut, CheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
documents.checkOutUserId | string |
Идентификатор пользователя, для которого извлечен документ |
|
DocumentData
|
documents.documentData | string |
Список данных документа |
|
HasOverlay
|
documents.hasOverlay | boolean |
Определяет, должен ли документ отображаться с наложением |
|
Идентификатор
|
documents.id | string |
Идентификатор документа |
|
ImportTemplateId
|
documents.importTemplateId | string |
Идентификатор шаблона импорта для этого документа |
|
InfoStoreId
|
documents.infoStoreId | string |
Идентификатор хранилища сведений |
|
LifeCycleManager
|
documents.lifeCycleManager | string |
Сведения о жизненном цикле |
|
MainFileLength
|
documents.mainFileLength | integer |
Размер основного файла |
|
Имя
|
documents.name | string |
Имя документа |
|
PageCount
|
documents.pageCount | integer |
Количество страниц основного файла |
|
properties
|
documents.properties | array of |
properties |
|
ProtectionDomainId
|
documents.protectionDomainId | string |
Идентификатор домена защиты |
|
Напоминания
|
documents.reminders | string |
Список всех напоминаний |
|
SessionCount
|
documents.sessionCount | integer |
Количество сеансов |
|
ПодписьProfileId
|
documents.signingProfileId | string |
Идентификатор профиля подписи |
|
VersionId
|
documents.versionId | string |
Идентификатор версии документа |
|
HasMore
|
hasMore | boolean |
Указывает, существует ли больше результатов или нет. Флаг имеет значение true, если доступны дополнительные результаты |
|
Возобновление работы
|
resumePoint | string |
Точка возобновления из предыдущей операции поиска. Задайте значение NULL для первой операции поиска |
Поиск процесса
Поиск процесса
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL-адрес api архива (например: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Идентификатор подключения для идентификации подключения |
|
Conditions
|
Conditions | string |
Формат условия поиска: [<PropertyName>|<СравнениеEnum>|<PropertyValue>|<RelationEnum>]. ComparisonEnums: "Equals,NotEquals,Greater,GreaterEquals,Less,LessEquals,Like,Contains,EqualsUndefined,In,None,Soundex,NotIn," RelationEnums:"And,Or". например: [Последняя проверка|Less|2021-12-31|And],[Firstname|Равно|Питер |And],[Дата|Между|2021-12-31; 2022-12-31|И] |
|
|
ResultProperties
|
ResultProperties | string |
Список свойств результатов, разделенный запятыми. Может быть именем или идентификатором свойства, например "Name,Last check in,68b901cd-4d8f-11e6-aa6f-00ff04d7e62a" |
|
|
MaxSerchResults
|
MaxSerchResults | string |
Максимальное количество результатов поиска документов. По умолчанию = 100 |
|
|
Культура
|
Culture | string |
Язык и региональные параметры, в которых указан текст (de, en, fr, ...). Default = de |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
processes
|
processes | array of object |
Результат поиска процесса |
|
values
|
processes.name.values | array of object |
Значения свойств |
|
Культура
|
processes.name.values.culture | string |
Язык и региональные параметры свойств |
|
текст
|
processes.name.values.text | string |
Текст свойства |
|
id
|
processes.id | string |
Идентификатор процесса |
|
folderElementId
|
processes.folderElementId | string |
Идентификатор элемента Folder |
|
checkOutStateEnum
|
processes.checkOutStateEnum | string |
Проверка перечисления состояния |
|
properties
|
processes.properties | array of object |
Свойства |
|
propertyTypeId
|
processes.properties.propertyTypeId | string |
Идентификатор PropertyType |
|
values
|
processes.properties.values | array of string |
Значения свойств |
|
globalValues
|
processes.properties.globalValues | array of object |
Глобальные значения |
|
values
|
processes.properties.globalValues.values | array of object |
values |
|
Культура
|
processes.properties.globalValues.values.culture | string |
Язык и региональные параметры глобального значения |
|
текст
|
processes.properties.globalValues.values.text | string |
Текст глобального значения |
|
propertyTypeName
|
processes.properties.propertyTypeName | string |
Имя PropertyType |
|
propertyName
|
processes.properties.propertyName | string |
Название свойства |
|
priorityEnum
|
processes.priorityEnum | string |
Перечисление приоритета |
|
statusEnum
|
processes.statusEnum | string |
Перечисление состояния |
|
dueDate
|
processes.dueDate | string |
Срок |
|
hasLinks
|
processes.hasLinks | boolean |
Содержит ссылки |
|
accessRightsEnumList
|
processes.accessRightsEnumList | array of string |
Список перечисления прав доступа |
|
hasMore
|
hasMore | boolean |
Есть больше |
|
резюмеPoint
|
resumePoint | string |
Точка возобновления |
Получение документа
Получение документа
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL-адрес api архива (например: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
connectionId | True | string |
Идентификатор подключения для идентификации подключения |
|
DocumentId
|
documentId | True | string |
Идентификатор документа |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Абоннементы
|
GetDocumentResult.Abonnements | array of object |
Абоннементы |
|
OnContentChange
|
GetDocumentResult.Abonnements.OnContentChange | boolean |
Абононмент активен при изменениях файлов |
|
OnDelete
|
GetDocumentResult.Abonnements.OnDelete | boolean |
Абонннмент активен при удалении |
|
OnMetadataChange
|
GetDocumentResult.Abonnements.OnMetadataChange | boolean |
Абононмент активен при изменениях индекса |
|
UserId
|
GetDocumentResult.Abonnements.UserId | string |
Идентификатор пользователя для этого объекта abonnnement |
|
AccessRightsEnumList
|
GetDocumentResult.AccessRightsEnumList | array of string |
accessRightsEnumList |
|
PostItAnnotations
|
GetDocumentResult.AnnotationManager.PostItAnnotations | array of object |
PostItAnnotations |
|
CreatedDate
|
GetDocumentResult.AnnotationManager.PostItAnnotations.CreatedDate | string |
Дата создания из публикации заметки |
|
CreatorId
|
GetDocumentResult.AnnotationManager.PostItAnnotations.CreatorId | string |
Идентификатор пользователя создателя из публикации заметки |
|
IsItalic
|
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.IsItalic | boolean |
Является курсивом шрифта из публикации заметки |
|
IsStrikeOut
|
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.IsStrikeOut | boolean |
Вычеркивает шрифт из публикации заметки |
|
IsUnderline
|
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.IsUnderline | boolean |
Является ли шрифт подчеркиванием из публикации заметки |
|
Имя
|
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.Name | string |
Имя шрифта из публикации заметки. Default = Arial |
|
Подача
|
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.Pitch | integer |
Шаг шрифта из публикации заметки |
|
Size
|
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.Size | integer |
Размер шрифта из публикации заметки. Пример: размер:12 — 12000. Вам нужен фактор 1000 |
|
Weight
|
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.Weight | integer |
Вес шрифта из публикации заметки |
|
Идентификатор
|
GetDocumentResult.AnnotationManager.PostItAnnotations.Id | string |
Идентификатор публикации заметки |
|
ИзменениеDate
|
GetDocumentResult.AnnotationManager.PostItAnnotations.ModifiedDate | string |
Дата изменения из публикации заметки. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
PageNumber
|
GetDocumentResult.AnnotationManager.PostItAnnotations.PageNumber | integer |
Количество страниц из публикации заметки |
|
SecurityLevelEnum
|
GetDocumentResult.AnnotationManager.PostItAnnotations.SecurityLevelEnum | string |
Уровень безопасности для публикации заметки (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Default = PubliclyAvailable |
|
Выбор
|
GetDocumentResult.AnnotationManager.PostItAnnotations.Selectable | boolean |
Определяет, можно ли выбрать запись заметки пользователем. |
|
Текст
|
GetDocumentResult.AnnotationManager.PostItAnnotations.Text | string |
Определяемый пользователем текст для публикации заметки |
|
X
|
GetDocumentResult.AnnotationManager.PostItAnnotations.X | integer |
Координата X в пикселях на дюйм для 7200 DPI записи заметки |
|
У
|
GetDocumentResult.AnnotationManager.PostItAnnotations.Y | integer |
Координата Y в пикселях на дюйм для 7200 DPI публикации заметки |
|
ПрямоугольникиAnnotations
|
GetDocumentResult.AnnotationManager.RectangleAnnotations | array of object |
ПрямоугольникиAnnotations |
|
Цвет
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.Color | integer |
Цвет прямоугольника (32-разрядное значение ARGB) из заметки прямоугольника. Пример: черный: -16777216 белый: -1 красный: -65536 зеленый: -16744448 синий: -16776961 |
|
ColorHexCode
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.ColorHexCode | string |
Цвет прямоугольника (шестнадцатеричный код RGB) из заметки прямоугольника. Пример: черный: #000000 белый: #FFFFFF красный: #FF0000 зеленый: #008000 синий: #0000FF |
|
CreatedDate
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.CreatedDate | string |
Дата создания из заметки прямоугольника. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
CreatorId
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.CreatorId | string |
CreatorId |
|
Высота
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.Height | integer |
Высота прямоугольника в пикселях на дюйм для 7200 DPI |
|
Идентификатор
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.Id | string |
Идентификатор заметки прямоугольника |
|
ИзменениеDate
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.ModifiedDate | string |
Дата изменения из заметки прямоугольника. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
PageNumber
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.PageNumber | integer |
Число страниц из заметки прямоугольника |
|
SecurityLevelEnum
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.SecurityLevelEnum | string |
Уровень безопасности для заметки прямоугольника (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Default = PubliclyAvailable |
|
Выбор
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.Selectable | boolean |
Определяет, можно ли выбрать заметку прямоугольника пользователем |
|
Transparent
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.Transparent | boolean |
Прямоугольник должен быть прозрачным (выделение) |
|
Ширина
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.Width | integer |
Ширина прямоугольника в пикселях на дюйм для 7200 DPI |
|
X
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.X | integer |
Координата X в пикселях на дюйм для 7200 DPI из заметки прямоугольника |
|
У
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.Y | integer |
Координата Y в пикселях на дюйм для 7200 DPI из заметки прямоугольника |
|
TextAnnotations
|
GetDocumentResult.AnnotationManager.TextAnnotations | array of object |
TextAnnotations |
|
BackgroundColor
|
GetDocumentResult.AnnotationManager.TextAnnotations.BackgroundColor | integer |
Цвет фона (32-разрядное значение ARGB) из текстовой заметки. Пример: черный: -16777216 белый: -1 красный: -65536 зеленый: -16744448 синий: -16776961 |
|
BackgroundColorHexCode
|
GetDocumentResult.AnnotationManager.TextAnnotations.BackgroundColorHexCode | string |
Цвет фона (шестнадцатеричный код RGB) из текстовой заметки. Пример: черный: #000000 белый: #FFFFFF красный: #FF0000 зеленый: #008000 синий: #0000FF |
|
CreatedDate
|
GetDocumentResult.AnnotationManager.TextAnnotations.CreatedDate | string |
дата создания из текстовой заметки. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
CreatorId
|
GetDocumentResult.AnnotationManager.TextAnnotations.CreatorId | string |
Идентификатор пользователя создателя из текстовой заметки |
|
IsItalic
|
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.IsItalic | boolean |
Является курсивом шрифта из текстовой заметки |
|
IsStrikeOut
|
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.IsStrikeOut | boolean |
Вычеркивает шрифт из текстовой заметки |
|
IsUnderline
|
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.IsUnderline | boolean |
Подчеркивание шрифта из текстовой заметки |
|
Имя
|
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.Name | string |
Имя шрифта из текстовой заметки. Default = Arial |
|
Подача
|
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.Pitch | integer |
Шаг шрифта из текстовой заметки |
|
Size
|
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.Size | integer |
Размер шрифта из текстовой заметки.. Пример: размер:12 — 12000. Вам нужен фактор 1000 |
|
Weight
|
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.Weight | integer |
Вес шрифта из текстовой заметки |
|
ForegroundColor
|
GetDocumentResult.AnnotationManager.TextAnnotations.ForegroundColor | integer |
Цвет переднего плана (32-разрядное значение ARGB) из текстовой заметки. Пример: черный: -16777216 белый: -1 красный: -65536 зеленый: -16744448 синий: -16776961 |
|
ForegroundColorHexCode
|
GetDocumentResult.AnnotationManager.TextAnnotations.ForegroundColorHexCode | string |
Цвет переднего плана (шестнадцатеричный код RGB) из текстовой заметки. Пример: черный: #000000 белый: #FFFFFF красный: #FF0000 зеленый: #008000 синий: #0000FF |
|
Высота
|
GetDocumentResult.AnnotationManager.TextAnnotations.Height | integer |
Высота текста в пикселях на дюйм для 7200 DPI из текстовой заметки |
|
Идентификатор
|
GetDocumentResult.AnnotationManager.TextAnnotations.Id | string |
Идентификатор текстовой заметки |
|
ИзменениеDate
|
GetDocumentResult.AnnotationManager.TextAnnotations.ModifiedDate | string |
Дата изменения из текстовой заметки. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
PageNumber
|
GetDocumentResult.AnnotationManager.TextAnnotations.PageNumber | integer |
Количество страниц из текстовой заметки |
|
Вращение
|
GetDocumentResult.AnnotationManager.TextAnnotations.Rotation | integer |
Поворот в градусах из текстовой заметки |
|
SecurityLevelEnum
|
GetDocumentResult.AnnotationManager.TextAnnotations.SecurityLevelEnum | string |
Уровень безопасности для текстовой заметки (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Default = PubliclyAvailable |
|
Выбор
|
GetDocumentResult.AnnotationManager.TextAnnotations.Selectable | boolean |
Определяет, можно ли выбрать текстовую заметку пользователем |
|
Текст
|
GetDocumentResult.AnnotationManager.TextAnnotations.Text | string |
Определяемый пользователем текст заметки |
|
Transparent
|
GetDocumentResult.AnnotationManager.TextAnnotations.Transparent | boolean |
Текстовая заметка должна быть прозрачной |
|
Ширина
|
GetDocumentResult.AnnotationManager.TextAnnotations.Width | integer |
Ширина текста в пикселях на дюйм для 7200 DPI из текстовой заметки |
|
X
|
GetDocumentResult.AnnotationManager.TextAnnotations.X | integer |
Координата X в пикселях на дюйм для 7200 DPI из текстовой заметки |
|
У
|
GetDocumentResult.AnnotationManager.TextAnnotations.Y | integer |
Координата Y в пикселях на дюйм для 7200 DPI из текстовой заметки |
|
Blogs
|
GetDocumentResult.Blogs | array of object |
Blogs |
|
CreatedDate
|
GetDocumentResult.Blogs.CreatedDate | string |
Дата создания блога. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
CreatorId
|
GetDocumentResult.Blogs.CreatorId | string |
Идентификатор пользователя блога о создании пользователя |
|
Идентификатор
|
GetDocumentResult.Blogs.Id | string |
Идентификатор блога |
|
Текст
|
GetDocumentResult.Blogs.Text | string |
Текст элемента блога |
|
CheckOutStateEnum
|
GetDocumentResult.CheckOutStateEnum | string |
Проверьте состояние документа (NotCheckedOut, CheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
GetDocumentResult.CheckOutUserId | string |
Идентификатор пользователя, для которого извлечен документ |
|
DocumentData
|
GetDocumentResult.DocumentData | array of object |
DocumentData |
|
Идентификатор
|
GetDocumentResult.DocumentData.Id | string |
Идентификатор представления документа |
|
Имя
|
GetDocumentResult.DocumentData.Name | string |
Имя документа представления |
|
Представления
|
GetDocumentResult.DocumentData.Renditions | array of object |
Представления |
|
ContentProtections
|
GetDocumentResult.DocumentData.Renditions.ContentProtections | array of |
ContentProtections |
|
Extension
|
GetDocumentResult.DocumentData.Renditions.Extension | string |
Extension |
|
Files
|
GetDocumentResult.DocumentData.Renditions.Files | array of object |
Files |
|
BlobPath
|
GetDocumentResult.DocumentData.Renditions.Files.BlobPath | string |
BlobPath |
|
BlobStoreId
|
GetDocumentResult.DocumentData.Renditions.Files.BlobStoreId | string |
BlobStoreId |
|
HashValue
|
GetDocumentResult.DocumentData.Renditions.HashValue | array of integer |
HashValue |
|
Идентификатор
|
GetDocumentResult.DocumentData.Renditions.Id | string |
Идентификатор |
|
PageCount
|
GetDocumentResult.DocumentData.Renditions.PageCount | integer |
PageCount |
|
Size
|
GetDocumentResult.DocumentData.Renditions.Size | integer |
Size |
|
HasOverlay
|
GetDocumentResult.HasOverlay | boolean |
Определяет, должен ли документ отображаться с наложением |
|
Идентификатор
|
GetDocumentResult.Id | string |
Идентификатор документа |
|
ImportTemplateId
|
GetDocumentResult.ImportTemplateId | string |
Идентификатор шаблона импорта для этого документа |
|
InfoStoreId
|
GetDocumentResult.InfoStoreId | string |
Идентификатор хранилища сведений |
|
CheckOutLifeCycleStateId
|
GetDocumentResult.LifeCycleManager.CheckOutLifeCycleStateId | string |
Состояние жизненного цикла проверки |
|
LifeCycleEndDate
|
GetDocumentResult.LifeCycleManager.LifeCycleEndDate | string |
Вычисляемая дата окончания жизненного цикла. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
LifeCycleStartDate
|
GetDocumentResult.LifeCycleManager.LifeCycleStartDate | string |
Дата начала жизненного цикла. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
LifeCycleStateId
|
GetDocumentResult.LifeCycleManager.LifeCycleStateId | string |
Идентификатор состояния LifeCycle |
|
NextAutomaticLifeCycleStateId
|
GetDocumentResult.LifeCycleManager.NextAutomaticLifeCycleStateId | string |
Следующее состояние жизненного цикла |
|
NextLifeCycleStates
|
GetDocumentResult.LifeCycleManager.NextLifeCycleStates | array of string |
NextLifeCycleStates |
|
LifeCycleProtections
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections | array of object |
LifeCycleProtections |
|
DeleteAfterExpiration
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.DeleteAfterExpiration | boolean |
Разрешить удалить документ после истечения срока действия защиты |
|
Идентификатор
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.Id | string |
Идентификатор защиты состояния жизненного цикла |
|
ProtectAnnotationChange
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectAnnotationChange | boolean |
Защита от изменений примечаний |
|
ProtectCheckOut
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectCheckOut | boolean |
Защита от извлечений |
|
ProtectContentChange
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectContentChange | boolean |
Защита от изменения содержимого |
|
ProtectDelete
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectDelete | boolean |
Защита от удаления |
|
ProtectPropertyChange
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectPropertyChange | boolean |
Защита от изменений свойств |
|
ProtectProtectionDomainChange
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectProtectionDomainChange | boolean |
Защита от изменений безопасности |
|
ProtectionDurationTicks
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectionDurationTicks | integer |
Длительность защиты |
|
LifeCycleId
|
GetDocumentResult.LifeCycleManager.LifeCycleId | string |
Идентификатор LifeCycle |
|
MainFileLength
|
GetDocumentResult.MainFileLength | integer |
Размер основного файла |
|
Имя
|
GetDocumentResult.Name | string |
Имя документа |
|
PageCount
|
GetDocumentResult.PageCount | integer |
Количество страниц основного файла |
|
Свойства
|
GetDocumentResult.Properties | array of object |
Свойства |
|
GlobalValues
|
GetDocumentResult.Properties.GlobalValues | array of object |
GlobalValues |
|
Ценности
|
GetDocumentResult.Properties.GlobalValues.Values | array of object |
Ценности |
|
Культура
|
GetDocumentResult.Properties.GlobalValues.Values.Culture | string |
Культура |
|
Текст
|
GetDocumentResult.Properties.GlobalValues.Values.Text | string |
Текст |
|
PropertyTypeId
|
GetDocumentResult.Properties.PropertyTypeId | string |
Идентификатор типа поля индекса |
|
Ценности
|
GetDocumentResult.Properties.Values | array of string |
Ценности |
|
ProtectionDomainId
|
GetDocumentResult.ProtectionDomainId | string |
Идентификатор домена защиты |
|
Напоминания
|
GetDocumentResult.Reminders | array of object |
Напоминания |
|
Description
|
GetDocumentResult.Reminders.Description | string |
Описание напоминания |
|
Интервал
|
GetDocumentResult.Reminders.Interval | integer |
Интервал в днях между напоминаниями |
|
ProcessTemplateId
|
GetDocumentResult.Reminders.ProcessTemplateId | string |
Идентификатор шаблона процесса для этого напоминания |
|
Напоминание
|
GetDocumentResult.Reminders.ReminderDate | string |
Дата напоминания. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
ReminderId
|
GetDocumentResult.Reminders.ReminderId | string |
Идентификатор напоминания |
|
SubjectIds
|
GetDocumentResult.Reminders.SubjectIds | array of |
subjectIds |
|
UseUserFromProcessTemplate
|
GetDocumentResult.Reminders.UseUserFromProcessTemplate | boolean |
Определяет, будет ли использоваться определение пользователя из шаблона процесса. |
|
SessionCount
|
GetDocumentResult.SessionCount | integer |
Количество сеансов |
|
ПодписьProfileId
|
GetDocumentResult.SigningProfileId | string |
Идентификатор профиля подписи |
|
VersionId
|
GetDocumentResult.VersionId | string |
Идентификатор версии документа |
Получение документов и процессов
Получение документов и процессов, выбранных на мобильном веб-клиенте с помощью пользовательского действия кнопки
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL-адрес api архива (например: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Идентификатор подключения для идентификации подключения |
|
SelectionId
|
SelectionId | True | string |
Идентификатор выбора выбранных документов и процессов в мобильном веб-клиенте с помощью пользовательского действия кнопки |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | string |
Идентификатор выделения |
|
id
|
parentObjectId.id | string |
Перечисление идентификатора родительского объекта в мобильном веб-клиенте |
|
objectId
|
parentObjectId.objectId | string |
Идентификатор объекта родительского объекта (Document, Process,...) |
|
objectTypeEnum
|
parentObjectId.objectTypeEnum | string |
ObjectTypeEnum родительского объекта, например Document, Process, ... |
|
objectIds
|
objectIds | array of object |
Выбранные документы и процессы в мобильном веб-клиенте |
|
id
|
objectIds.id | string |
Список идентификаторов мобильного веб-клиента |
|
objectId
|
objectIds.objectId | string |
Идентификатор объекта выбранного документа или процесса в мобильном веб-клиенте |
|
objectTypeEnum
|
objectIds.objectTypeEnum | string |
ObjectTypeEnum выбранного документа или процесса в мобильном веб-клиенте |
|
allObjectIds
|
allObjectIds | array of object |
Выбранные и неизбираемые документы и процессы в мобильном веб-клиенте |
|
id
|
allObjectIds.id | string |
Список идентификаторов мобильного веб-клиента |
|
objectId
|
allObjectIds.objectId | string |
Идентификатор объекта выбранного и неизбираемого документа или процесса в мобильном веб-клиенте |
|
objectTypeEnum
|
allObjectIds.objectTypeEnum | string |
ObjectTypeEnum выбранного и неизбираемого документа или процесса в мобильном веб-клиенте |
Получение преобразованного содержимого файла
Преобразование содержимого файла в другой формат. Добавление заметки или наложения в содержимое файла
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL-адрес api архива (например: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Идентификатор подключения для идентификации подключения |
|
DocumentId
|
DocumentId | True | string |
Идентификатор документа |
|
VersionId
|
VersionId | string |
Идентификатор версии (Guid)Id версии (Guid) (Guid) |
|
|
DocumentDataId
|
DocumentDataId | string |
Идентификатор данных документа (GUID) |
|
|
RenditionId
|
RenditionId | string |
Идентификатор представления документа (GUID) |
|
|
TargetFormat
|
TargetFormat | True | string |
Целевой формат (например, png;pdf; tif;...") |
|
AddAnnotations
|
AddAnnotatins | boolean |
Определяет, следует ли экспортировать документ с заметками. Default = да |
|
|
AddOverlay
|
AddOverlay | boolean |
Определяет, следует ли экспортировать документ с наложениями. Default = да |
Возвращаемое значение
Преобразованное содержимое файла
- Содержимое файла
- string
Получение процесса
Получить процесс
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL-адрес api архива (например: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
connectionId | True | string |
Идентификатор подключения для идентификации подключения |
|
ProcessId
|
processId | True | string |
Идентификатор процесса (GUID) |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
AccessRightsEnumList
|
GetProcessResult.AccessRightsEnumList | array of string |
accessRightsEnumList |
|
CheckOutStateEnum
|
GetProcessResult.CheckOutStateEnum | string |
Проверьте состояние документа (NotCheckedOut, CheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
GetProcessResult.CheckOutUserId | string |
Идентификатор пользователя, для которого извлечен процесс |
|
Comments
|
GetProcessResult.Comments | array of object |
Comments |
|
Date
|
GetProcessResult.Comments.Date | string |
Дата комментария |
|
Идентификатор
|
GetProcessResult.Comments.Id | string |
Идентификатор комментария |
|
Текст
|
GetProcessResult.Comments.Text | string |
Определяемый пользователем комментарий |
|
UserId
|
GetProcessResult.Comments.UserId | string |
Идентификатор пользователя, который задал комментарий |
|
ЗавершеноDate
|
GetProcessResult.CompletedDate | string |
Дата завершения процесса. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
Завершенныеtasks
|
GetProcessResult.CompletedTasks | array of object |
Завершенныеtasks |
|
Действие
|
GetProcessResult.CompletedTasks.Action | string |
Текст действия для пользователя. Отображается пользователю |
|
AssignedUserIds
|
GetProcessResult.CompletedTasks.AssignedUserIds | array of |
assignedUserIds |
|
Comments
|
GetProcessResult.CompletedTasks.Comments | array of object |
Comments |
|
Date
|
GetProcessResult.CompletedTasks.Comments.Date | string |
Дата комментария |
|
Идентификатор
|
GetProcessResult.CompletedTasks.Comments.Id | string |
Идентификатор комментария |
|
Текст
|
GetProcessResult.CompletedTasks.Comments.Text | string |
Определяемый пользователем комментарий |
|
UserId
|
GetProcessResult.CompletedTasks.Comments.UserId | string |
Идентификатор пользователя, который задал комментарий |
|
ЗавершеноDate
|
GetProcessResult.CompletedTasks.CompletedDate | string |
Дата завершения. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
CompletedUserIds
|
GetProcessResult.CompletedTasks.CompletedUserIds | array of string |
completedUserIds |
|
CreatedDate
|
GetProcessResult.CompletedTasks.CreatedDate | string |
Дата создания. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
CreatorId
|
GetProcessResult.CompletedTasks.CreatorId | string |
Идентификатор пользователя создателя |
|
Description
|
GetProcessResult.CompletedTasks.Description | string |
Описание задания |
|
Дата выполнения
|
GetProcessResult.CompletedTasks.DueDate | string |
Дата выполнения задачи. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
IntendedUserIds
|
GetProcessResult.CompletedTasks.IntendedUserIds | array of |
ПредполагаемыеUserIds |
|
Напоминание
|
GetProcessResult.CompletedTasks.ReminderDate | string |
Дата напоминания. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
ТребуетсяAllRecipients
|
GetProcessResult.CompletedTasks.RequiresAllRecipients | boolean |
Определяет, должны ли все получатели закрыть эту задачу |
|
ShowCloseTaskDialog
|
GetProcessResult.CompletedTasks.ShowCloseTaskDialog | boolean |
Показать диалоговое окно закрытия задачи в конце задачи |
|
Состояние
|
GetProcessResult.CompletedTasks.StatusEnum | string |
Состояние задачи (Open, InProcess, Complete, PreparedToComplete, Error) |
|
TaskTemplateId
|
GetProcessResult.CompletedTasks.TaskTemplateId | string |
Идентификатор шаблона задачи |
|
CreatedDate
|
GetProcessResult.CreatedDate | string |
Дата создания процесса. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
Действие
|
GetProcessResult.CurrentTask.Action | string |
Текст действия для пользователя. Отображается пользователю |
|
AssignedUserIds
|
GetProcessResult.CurrentTask.AssignedUserIds | array of string |
AssignedUserIds |
|
Comments
|
GetProcessResult.CurrentTask.Comments | array of string |
Comments |
|
ЗавершеноDate
|
GetProcessResult.CurrentTask.CompletedDate | string |
Дата завершения. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
CompletedUserIds
|
GetProcessResult.CurrentTask.CompletedUserIds | array of string |
CompletedUserIds |
|
CreatedDate
|
GetProcessResult.CurrentTask.CreatedDate | string |
Дата создания. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
CreatorId
|
GetProcessResult.CurrentTask.CreatorId | string |
Идентификатор пользователя создателя |
|
Description
|
GetProcessResult.CurrentTask.Description | string |
Описание задания |
|
Дата выполнения
|
GetProcessResult.CurrentTask.DueDate | string |
Дата выполнения задачи. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
Идентификатор
|
GetProcessResult.CurrentTask.Id | string |
Идентификатор задачи |
|
IntendedUserIds
|
GetProcessResult.CurrentTask.IntendedUserIds | array of string |
IntendedUserIds |
|
Напоминание
|
GetProcessResult.CurrentTask.ReminderDate | string |
Дата напоминания. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
ТребуетсяAllRecipients
|
GetProcessResult.CurrentTask.RequiresAllRecipients | boolean |
Определяет, должны ли все получатели закрыть эту задачу |
|
ShowCloseTaskDialog
|
GetProcessResult.CurrentTask.ShowCloseTaskDialog | boolean |
Показать диалоговое окно закрытия задачи в конце задачи |
|
StatusEnum
|
GetProcessResult.CurrentTask.StatusEnum | string |
Состояние задачи (Open, InProcess, Complete, PreparedToComplete, Error) |
|
TaskTemplateId
|
GetProcessResult.CurrentTask.TaskTemplateId | string |
Идентификатор шаблона задачи |
|
CustomProperties
|
GetProcessResult.CustomProperties | array of object |
CustomProperties |
|
CustomPropertyTypeEnum
|
GetProcessResult.CustomProperties.CustomPropertyTypeEnum | string |
Список типов данных пользовательского свойства (String, Date, Number) |
|
Имя
|
GetProcessResult.CustomProperties.Name | string |
Имя типа пользовательского свойства |
|
Ценность
|
GetProcessResult.CustomProperties.Value | string |
Значение типа пользовательского свойства |
|
DocumentIds
|
GetProcessResult.DocumentIds | array of string |
DocumentIds |
|
Дата выполнения
|
GetProcessResult.DueDate | string |
Дата выполнения процесса. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
Идентификатор
|
GetProcessResult.Id | string |
Идентификатор процесса |
|
Ценности
|
GetProcessResult.Name.Values | array of object |
Ценности |
|
Культура
|
GetProcessResult.Name.Values.Culture | string |
Язык и региональные параметры, в которых указан текст (de, en, fr, ...) |
|
Текст
|
GetProcessResult.Name.Values.Text | string |
Текст |
|
PluginStream
|
GetProcessResult.PluginStream | array of |
PluginStream |
|
PriorityEnum
|
GetProcessResult.PriorityEnum | string |
Приоритет процесса (высокий, обычный, низкий) |
|
ProcessTemplateId
|
GetProcessResult.ProcessTemplateId | string |
Идентификатор шаблона процесса |
|
Свойства
|
GetProcessResult.Properties | array of object |
Свойства |
|
GlobalValues
|
GetProcessResult.Properties.GlobalValues | array of object |
GlobalValues |
|
Ценности
|
GetProcessResult.Properties.GlobalValues.Values | array of object |
Ценности |
|
Культура
|
GetProcessResult.Properties.GlobalValues.Values.Culture | string |
Культура |
|
Текст
|
GetProcessResult.Properties.GlobalValues.Values.Text | string |
Текст |
|
PropertyTypeId
|
GetProcessResult.Properties.PropertyTypeId | string |
Идентификатор типа свойства |
|
Ценности
|
GetProcessResult.Properties.Values | array of string |
Ценности |
|
ProtectionDomainId
|
GetProcessResult.ProtectionDomainId | string |
Идентификатор домена защиты процесса |
|
SessionCount
|
GetProcessResult.SessionCount | integer |
Количество сеансов |
|
StatusEnum
|
GetProcessResult.StatusEnum | string |
Состояние процесса (Open, InProcess, Complete, PreparedToComplete, Error) |
Получение свойств документа
Получение свойств документа
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL-адрес api архива (например: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Идентификатор подключения для идентификации подключения |
|
DocumentId
|
DocumentId | True | string |
Идентификатор документа |
|
Культура
|
Culture | string |
Язык и региональные параметры, в которых задаются имена свойств (de, en, fr, ...). Default = de |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
|
array of object | ||
|
globalValues
|
globalValues | array of object |
globalValues |
|
values
|
globalValues.values | array of object |
values |
|
Культура
|
globalValues.values.culture | string |
Культура |
|
текст
|
globalValues.values.text | string |
Текст |
|
ИмяСвойства
|
propertyName | string |
Имя свойства |
|
PropertyTypeId
|
propertyTypeId | string |
Идентификатор типа поля индекса |
|
values
|
values | array of string |
values |
Получение свойств процесса
Получение свойств процесса
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL-адрес api архива (например: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Идентификатор подключения для идентификации подключения |
|
ProcessId
|
ProcessId | True | string |
Идентификатор процесса (GUID) |
|
Культура
|
Culture | string |
Язык и региональные параметры, в которых задаются имена свойств (de, en, fr, ...). Default = de |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
|
array of object | ||
|
ИмяСвойства
|
propertyName | string |
Имя свойства process |
|
PropertyTypeId
|
propertyTypeId | string |
Идентификатор типа свойства |
|
values
|
values | array of string |
values |
Получение строк из таблицы пользователя
Получение строк из таблицы пользователя
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL-адрес api архива (например: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Идентификатор подключения для идентификации подключения |
|
UserTable
|
UserTable | True | string |
Имя таблицы пользователя |
|
WhereClause
|
WhereClause | string |
Список sql, где элементы предложения. Формат: [<ColumnName>|<СравнениеEnum>|<PropertyValue>|<RelationEnum>]. ComparisonEnums: "Equals,NotEquals,Greater,GreaterEquals,Less,LessEquals,Like,NotLike" RelationEnums:"AND,OR" (например: [Firstname|Равно|Джон |AND],[Фамилия|Равно|Doe |AND]) |
|
|
OrderByClause
|
OrderByClause | string |
Список порядка SQL по элементам предложения (например: Firstname[ASC],City[DESC]) |
|
|
AddColumnHeaders
|
AddColumnHeaders | boolean |
Добавляет заголовки столбцов в качестве первой строки (по умолчанию = false) |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
UserTableGetRecordsResult
|
UserTableGetRecordsResult | array of array |
UserTableGetRecordsResult |
|
items
|
UserTableGetRecordsResult | array of string |
Получить содержимое файла
Получить содержимое файла
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL-адрес api архива (например: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Идентификатор подключения для идентификации подключения |
|
DocumentId
|
DocumentId | True | string |
Идентификатор документа |
|
VersionId
|
VersionId | string |
Идентификатор версии (GUID) |
|
|
DocumentDataId
|
DocumentDataId | string |
Идентификатор данных документа (GUID) |
|
|
RenditionId
|
RenditionId | string |
Идентификатор представления документа (GUID) |
|
|
IgnoreHashValidation
|
IgnoreHashValidation | boolean |
Игнорировать системную конфигурацию для проверки хэша. Default = да |
Возвращаемое значение
Содержимое файла
- Содержимое файла
- string
Процесс обновления (версия 2)
Процесс обновления (версия 2)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL-адрес api архива (например: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Идентификатор подключения для идентификации подключения |
|
ProcessId
|
ProcessId | True | string |
Идентификатор процесса (GUID) |
|
ProcessProperties
|
ProcessProperties | string |
Формат обновления свойств процесса: Firstname=Peter|Lastname=Muller|InvoiceNo=4711; 4712; 4713 |
|
|
RemoveProcessProperties
|
RemoveProcessProperties | string |
Список разделенных точками с запятой имен свойств или идентификаторов для удаления из процесса, например FistName; b9cfbdf7-f6fb-4179-91c8-d9681fb680dd; Отделы" |
|
|
CustomProperties
|
CustomProperties | string |
Пользовательские свойства. Формат: [<PropertyName>|<PropertyValue>|PropertyType] (например, [поставщик|Muster |String][InvoiceDate|2021-01-29T13:05:45 |Date][InvoiceNo|4711|Число]) |
|
|
Комментарий
|
Comment | string |
Добавление текста примечания процесса |
|
|
AssignUserLoginNames
|
AssignUserLoginNames | string |
Назначенные имена входа пользователей, разделенные точкой с запятой, например user1; user2 |
|
|
AddDocumentIds
|
AddDocumentIds | string |
Разделенный запятой список идентификаторов документов, добавляемых в процесс, например '1450c90e-2783-419b-b428-6ffa3b7cabe2; 0339a105-e06a-4af4-8fa2-d0b6b837fc16' |
|
|
RemoveDocumentIds
|
RemoveDocumentIds | string |
Разделенный запятой список идентификаторов документов для удаления из процесса, например 1450c90e-2783-419b-b428-6ffa3b7cabe2; 0339a105-e06a-4af4-8fa2-d0b6b837fc16' |
|
|
Дата выполнения
|
DueDate | string |
Дата выполнения процесса. Формат даты: гггг-ММ-ддTHH:mm:ss. Default = текущая дата |
|
|
Priority
|
Priority | string |
Приоритет процесса (например, низкий, обычный, высокий). Default = Normal |
|
|
Культура
|
Culture | string |
Язык и региональные параметры, в которых указан текст (de, en, fr, ...). Default = de |
|
|
ForceUndoCheckout
|
ForceUndoCheckout | boolean |
Принудительное отмена проверки при необходимости |
|
|
Область защиты
|
ProtectionDomain | string |
Идентификатор или имя домена защиты |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
values
|
name.values | array of object |
Значения свойств |
|
Культура
|
name.values.culture | string |
Язык и региональные параметры свойств |
|
текст
|
name.values.text | string |
Текст свойства |
|
values
|
description.values | array of object |
values |
|
Культура
|
description.values.culture | string |
Язык и региональные параметры свойств |
|
текст
|
description.values.text | string |
Текст свойства |
|
id
|
id | string |
Идентификатор процесса |
|
protectionDomainId
|
protectionDomainId | string |
Идентификатор домена защиты процесса |
|
processTemplateId
|
processTemplateId | string |
Идентификатор шаблона процесса |
|
properties
|
properties | array of object |
Свойства |
|
propertyTypeId
|
properties.propertyTypeId | string |
Идентификатор PropertyType |
|
values
|
properties.values | array of string |
Значения свойств |
|
globalValues
|
properties.globalValues | array of object |
Глобальные значения |
|
values
|
properties.globalValues.values | array of object |
values |
|
Культура
|
properties.globalValues.values.culture | string |
Язык и региональные параметры глобального значения |
|
текст
|
properties.globalValues.values.text | string |
Текст глобального значения |
|
propertyTypeName
|
properties.propertyTypeName | string |
Имя PropertyType |
|
propertyName
|
properties.propertyName | string |
Название свойства |
|
priorityEnum
|
priorityEnum | string |
Перечисление приоритета процесса |
|
pluginStream
|
pluginStream | string |
Обработка потока подключаемого модуля |
|
dueDate
|
dueDate | string |
Дата выполнения процесса |
|
дата создания
|
createdDate | string |
Дата создания процесса |
|
completedDate
|
completedDate | string |
Дата завершения процесса |
|
comments
|
comments | array of object |
Comments |
|
id
|
comments.id | string |
Идентификатор примечания процесса |
|
date
|
comments.date | string |
Дата комментария процесса |
|
userId
|
comments.userId | string |
Идентификатор пользователя примечания процесса |
|
текст
|
comments.text | string |
Текст примечания процесса |
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
Список перечисления прав доступа |
|
statusEnum
|
statusEnum | string |
Перечисление состояния |
|
customProperties
|
customProperties | array of object |
Пользовательские свойства |
|
имя
|
customProperties.name | string |
Имя настраиваемого свойства |
|
value
|
customProperties.value | string |
Значение настраиваемого свойства |
|
customPropertyTypeEnum
|
customProperties.customPropertyTypeEnum | string |
Перечисление типа пользовательского свойства |
|
id
|
currentTask.id | string |
Идентификатор текущей задачи |
|
действие
|
currentTask.action | string |
Текущее действие задачи |
|
creatorId
|
currentTask.creatorId | string |
Идентификатор создателя текущей задачи |
|
dueDate
|
currentTask.dueDate | string |
Текущая дата выполнения задачи |
|
дата создания
|
currentTask.createdDate | string |
Дата создания текущей задачи |
|
completedDate
|
currentTask.completedDate | string |
Текущая дата завершения задачи |
|
taskTemplateId
|
currentTask.taskTemplateId | string |
Идентификатор шаблона текущей задачи |
|
comments
|
currentTask.comments | array of |
Текущие комментарии к задачам |
|
напоминаниеDate
|
currentTask.reminderDate | string |
Текущая дата напоминания о задаче |
|
statusEnum
|
currentTask.statusEnum | string |
Перечисление текущей задачи |
|
описание
|
currentTask.description | string |
Текущее описание задачи |
|
требуетсяAllRecipients
|
currentTask.requiresAllRecipients | boolean |
Для текущей задачи требуются все получатели |
|
assignedUserIds
|
currentTask.assignedUserIds | array of string |
Идентификаторы назначенных пользователем текущих задач |
|
completedUserIds
|
currentTask.completedUserIds | array of string |
Идентификаторы пользователей, завершенные текущей задачей |
|
showCloseTaskDialog
|
currentTask.showCloseTaskDialog | boolean |
Диалоговое окно закрытия задачи текущей задачи |
|
ПредполагаемыеUserIds
|
currentTask.intendedUserIds | array of |
Текущие идентификаторы пользователей, предназначенные для текущей задачи |
|
values
|
currentTask.nameGlobal.values | array of object |
values |
|
Культура
|
currentTask.nameGlobal.values.culture | string |
Язык и региональные параметры глобального имени |
|
текст
|
currentTask.nameGlobal.values.text | string |
Текст глобального имени |
|
values
|
currentTask.descriptionGlobal.values | array of object |
values |
|
Культура
|
currentTask.descriptionGlobal.values.culture | string |
Язык и региональные параметры глобального описания |
|
текст
|
currentTask.descriptionGlobal.values.text | string |
Текст глобального описания |
|
assignedUserCCIds
|
currentTask.assignedUserCCIds | array of |
Назначенные идентификаторы пользователя Cc |
|
заместительrepresentations
|
currentTask.deputyRepresentations | array of |
Заместитель представления |
|
taskActionEnum
|
currentTask.taskActionEnum | string |
Перечисление действия задачи |
|
completedTasks
|
completedTasks | array of object |
Завершенные задачи |
|
id
|
completedTasks.id | string |
Идентификатор завершенной задачи |
|
действие
|
completedTasks.action | string |
Действие завершенной задачи |
|
creatorId
|
completedTasks.creatorId | string |
Идентификатор создателя завершенной задачи |
|
dueDate
|
completedTasks.dueDate | string |
Дата выполнения задачи |
|
дата создания
|
completedTasks.createdDate | string |
Дата создания задачи |
|
completedDate
|
completedTasks.completedDate | string |
Дата завершения задачи |
|
taskTemplateId
|
completedTasks.taskTemplateId | string |
Идентификатор шаблона задачи завершенной задачи |
|
comments
|
completedTasks.comments | array of |
Комментарии к завершенным задачам |
|
напоминаниеDate
|
completedTasks.reminderDate | string |
Дата напоминания о завершенной задаче |
|
statusEnum
|
completedTasks.statusEnum | string |
Перечисление состояния завершенной задачи |
|
описание
|
completedTasks.description | string |
описание |
|
требуетсяAllRecipients
|
completedTasks.requiresAllRecipients | boolean |
Завершенная задача требует всех получателей |
|
assignedUserIds
|
completedTasks.assignedUserIds | array of string |
Завершенные идентификаторы назначенных пользователем задач |
|
completedUserIds
|
completedTasks.completedUserIds | array of string |
Завершенная задача завершена идентификаторами пользователей |
|
showCloseTaskDialog
|
completedTasks.showCloseTaskDialog | boolean |
Диалоговое окно закрытия задачи завершенной задачи |
|
ПредполагаемыеUserIds
|
completedTasks.intendedUserIds | array of |
Завершенная задача предназначена для идентификаторов пользователей |
|
values
|
completedTasks.nameGlobal.values | array of object |
values |
|
Культура
|
completedTasks.nameGlobal.values.culture | string |
Язык и региональные параметры глобального имени |
|
текст
|
completedTasks.nameGlobal.values.text | string |
Текст глобального имени |
|
values
|
completedTasks.descriptionGlobal.values | array of object |
values |
|
Культура
|
completedTasks.descriptionGlobal.values.culture | string |
Язык и региональные параметры глобального описания |
|
текст
|
completedTasks.descriptionGlobal.values.text | string |
Текст глобального описания |
|
assignedUserCCIds
|
completedTasks.assignedUserCCIds | array of |
Завершенная задача, назначаемая пользователем идентификаторами cc |
|
заместительrepresentations
|
completedTasks.deputyRepresentations | array of |
Завершенные заместитель представления задачи |
|
taskActionEnum
|
completedTasks.taskActionEnum | string |
Перечисление действия задачи завершенной задачи |
|
documentIds
|
documentIds | array of string |
Идентификаторы завершенных документов задач |
|
checkOutStateEnum
|
checkOutStateEnum | string |
Завершенная задача извлекает перечисление состояния |
|
checkOutUserId
|
checkOutUserId | string |
Завершенная задача извлекает идентификатор пользователя |
|
sessionCount
|
sessionCount | integer |
Количество завершенных сеансов задач |
Процесс обновления (не рекомендуется) [DEPRECATED]
Процесс обновления (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL-адрес api архива (например: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Идентификатор подключения для идентификации подключения |
|
ProcessId
|
ProcessId | True | string |
Идентификатор процесса (GUID) |
|
AssignUserLoginNames
|
AssignUserLoginNames | string |
Назначьте имена входа пользователей текущей задаче. (например, peter.muster@kendox.com;megan.muster@kendox.com) |
|
|
ProcessProperties
|
ProcessProperties | string |
Формат обновления свойств процесса: Firstname=Peter|Lastname=Muller|InvoiceNo=4711; 4712; 4713 |
|
|
Пользовательские свойства
|
CustomProperties | string |
Пользовательские свойства. Формат: [<PropertyName>|<PropertyValue>|PropertyType] (например, [поставщик|Muster |String][InvoiceDate|2021-01-29T13:05:45 |Date][InvoiceNo|4711|Число]) |
|
|
Комментарий
|
Comment | string |
Комментарий |
|
|
Культура
|
Culture | string |
Язык и региональные параметры, в которых задаются имена свойств (de, en, fr, ...). Default = de |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
values
|
name.values | array of object |
values |
|
Культура
|
name.values.culture | string |
Культура |
|
текст
|
name.values.text | string |
текст |
|
values
|
description.values | array of object |
values |
|
Культура
|
description.values.culture | string |
Культура |
|
текст
|
description.values.text | string |
текст |
|
id
|
id | string |
id |
|
protectionDomainId
|
protectionDomainId | string |
protectionDomainId |
|
processTemplateId
|
processTemplateId | string |
processTemplateId |
|
properties
|
properties | array of object |
properties |
|
propertyTypeId
|
properties.propertyTypeId | string |
propertyTypeId |
|
values
|
properties.values | array of string |
values |
|
globalValues
|
properties.globalValues | array of object |
globalValues |
|
values
|
properties.globalValues.values | array of object |
values |
|
Культура
|
properties.globalValues.values.culture | string |
Культура |
|
текст
|
properties.globalValues.values.text | string |
текст |
|
propertyTypeName
|
properties.propertyTypeName | string |
propertyTypeName |
|
propertyName
|
properties.propertyName | string |
propertyName |
|
priorityEnum
|
priorityEnum | string |
priorityEnum |
|
pluginStream
|
pluginStream | string |
pluginStream |
|
dueDate
|
dueDate | string |
dueDate |
|
дата создания
|
createdDate | string |
дата создания |
|
completedDate
|
completedDate | string |
completedDate |
|
comments
|
comments | array of object |
comments |
|
id
|
comments.id | string |
id |
|
date
|
comments.date | string |
date |
|
userId
|
comments.userId | string |
userId |
|
текст
|
comments.text | string |
текст |
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
accessRightsEnumList |
|
statusEnum
|
statusEnum | string |
statusEnum |
|
customProperties
|
customProperties | array of object |
customProperties |
|
имя
|
customProperties.name | string |
имя |
|
value
|
customProperties.value | string |
value |
|
customPropertyTypeEnum
|
customProperties.customPropertyTypeEnum | string |
customPropertyTypeEnum |
|
id
|
currentTask.id | string |
id |
|
действие
|
currentTask.action | string |
действие |
|
creatorId
|
currentTask.creatorId | string |
creatorId |
|
dueDate
|
currentTask.dueDate | string |
dueDate |
|
дата создания
|
currentTask.createdDate | string |
дата создания |
|
completedDate
|
currentTask.completedDate | string |
completedDate |
|
taskTemplateId
|
currentTask.taskTemplateId | string |
taskTemplateId |
|
comments
|
currentTask.comments | array of |
comments |
|
напоминаниеDate
|
currentTask.reminderDate | string |
напоминаниеDate |
|
statusEnum
|
currentTask.statusEnum | string |
statusEnum |
|
описание
|
currentTask.description | string |
описание |
|
требуетсяAllRecipients
|
currentTask.requiresAllRecipients | boolean |
требуетсяAllRecipients |
|
assignedUserIds
|
currentTask.assignedUserIds | array of string |
assignedUserIds |
|
completedUserIds
|
currentTask.completedUserIds | array of string |
completedUserIds |
|
showCloseTaskDialog
|
currentTask.showCloseTaskDialog | boolean |
showCloseTaskDialog |
|
ПредполагаемыеUserIds
|
currentTask.intendedUserIds | array of |
ПредполагаемыеUserIds |
|
values
|
currentTask.nameGlobal.values | array of object |
values |
|
Культура
|
currentTask.nameGlobal.values.culture | string |
Культура |
|
текст
|
currentTask.nameGlobal.values.text | string |
текст |
|
values
|
currentTask.descriptionGlobal.values | array of object |
values |
|
Культура
|
currentTask.descriptionGlobal.values.culture | string |
Культура |
|
текст
|
currentTask.descriptionGlobal.values.text | string |
текст |
|
assignedUserCCIds
|
currentTask.assignedUserCCIds | array of |
assignedUserCCIds |
|
заместительrepresentations
|
currentTask.deputyRepresentations | array of |
заместительrepresentations |
|
taskActionEnum
|
currentTask.taskActionEnum | string |
taskActionEnum |
|
completedTasks
|
completedTasks | array of object |
completedTasks |
|
id
|
completedTasks.id | string |
id |
|
действие
|
completedTasks.action | string |
действие |
|
creatorId
|
completedTasks.creatorId | string |
creatorId |
|
dueDate
|
completedTasks.dueDate | string |
dueDate |
|
дата создания
|
completedTasks.createdDate | string |
дата создания |
|
completedDate
|
completedTasks.completedDate | string |
completedDate |
|
taskTemplateId
|
completedTasks.taskTemplateId | string |
taskTemplateId |
|
comments
|
completedTasks.comments | array of |
comments |
|
напоминаниеDate
|
completedTasks.reminderDate | string |
напоминаниеDate |
|
statusEnum
|
completedTasks.statusEnum | string |
statusEnum |
|
описание
|
completedTasks.description | string |
описание |
|
требуетсяAllRecipients
|
completedTasks.requiresAllRecipients | boolean |
требуетсяAllRecipients |
|
assignedUserIds
|
completedTasks.assignedUserIds | array of string |
assignedUserIds |
|
completedUserIds
|
completedTasks.completedUserIds | array of string |
completedUserIds |
|
showCloseTaskDialog
|
completedTasks.showCloseTaskDialog | boolean |
showCloseTaskDialog |
|
ПредполагаемыеUserIds
|
completedTasks.intendedUserIds | array of |
ПредполагаемыеUserIds |
|
values
|
completedTasks.nameGlobal.values | array of object |
values |
|
Культура
|
completedTasks.nameGlobal.values.culture | string |
Культура |
|
текст
|
completedTasks.nameGlobal.values.text | string |
текст |
|
values
|
completedTasks.descriptionGlobal.values | array of object |
values |
|
Культура
|
completedTasks.descriptionGlobal.values.culture | string |
Культура |
|
текст
|
completedTasks.descriptionGlobal.values.text | string |
текст |
|
assignedUserCCIds
|
completedTasks.assignedUserCCIds | array of |
assignedUserCCIds |
|
заместительrepresentations
|
completedTasks.deputyRepresentations | array of |
заместительrepresentations |
|
taskActionEnum
|
completedTasks.taskActionEnum | string |
taskActionEnum |
|
documentIds
|
documentIds | array of string |
documentIds |
|
checkOutStateEnum
|
checkOutStateEnum | string |
checkOutStateEnum |
|
checkOutUserId
|
checkOutUserId | string |
checkOutUserId |
|
sessionCount
|
sessionCount | integer |
sessionCount |
Процессы списка (не рекомендуется) [DEPRECATED]
Процессы перечисления (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL-адрес api архива (например: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Идентификатор подключения для идентификации подключения |
|
Приёмник
|
Receiver | string |
Имена получателей из процессов (например, john@sample.com|megan@sample.com). Пустой пользователь, вошедший в систему, будет взят в качестве получателя |
|
|
Состояние
|
Status | string |
Состояние процесса. Default = open |
|
|
IgnoreReceiver
|
IgnoreReceiver | boolean |
Если да, перечислены все процессы, неидентные получателем. Default = false |
|
|
MaxSerchResults
|
MaxSerchResults | string |
Максимальное количество результатов поиска процесса. По умолчанию = 100 |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
processes
|
processes | array of object |
processes |
|
accessRightsEnumList
|
processes.accessRightsEnumList | array of string |
accessRightsEnumList |
|
CheckOutStateEnum
|
processes.checkOutStateEnum | string |
Проверьте состояние процесса (NotCheckedOut, CheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
processes.checkOutUserId | string |
Идентификатор пользователя, для которого извлечен документ |
|
comments
|
processes.comments | array of object |
comments |
|
Date
|
processes.comments.date | string |
Дата комментария |
|
Идентификатор
|
processes.comments.id | string |
Идентификатор комментария |
|
Текст
|
processes.comments.text | string |
Определяемый пользователем комментарий |
|
UserId
|
processes.comments.userId | string |
Идентификатор пользователя, который задал комментарий |
|
ЗавершеноDate
|
processes.completedDate | string |
Дата завершения процесса. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
completedTasks
|
processes.completedTasks | array of object |
completedTasks |
|
Действие
|
processes.completedTasks.action | string |
Текст действия для пользователя. Отображается пользователю |
|
assignedUserIds
|
processes.completedTasks.assignedUserIds | array of |
assignedUserIds |
|
comments
|
processes.completedTasks.comments | array of object |
comments |
|
Date
|
processes.completedTasks.comments.date | string |
Дата комментария |
|
Идентификатор
|
processes.completedTasks.comments.id | string |
Идентификатор комментария |
|
Текст
|
processes.completedTasks.comments.text | string |
Определяемый пользователем комментарий |
|
UserId
|
processes.completedTasks.comments.userId | string |
Идентификатор пользователя, который задал комментарий |
|
ЗавершеноDate
|
processes.completedTasks.completedDate | string |
Дата завершения. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
completedUserIds
|
processes.completedTasks.completedUserIds | array of string |
completedUserIds |
|
CreatedDate
|
processes.completedTasks.createdDate | string |
Дата создания. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
CreatorId
|
processes.completedTasks.creatorId | string |
Идентификатор пользователя создателя |
|
Description
|
processes.completedTasks.description | string |
Описание задания |
|
Дата выполнения
|
processes.completedTasks.dueDate | string |
Дата выполнения задачи. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
ПредполагаемыеUserIds
|
processes.completedTasks.intendedUserIds | array of |
ПредполагаемыеUserIds |
|
Напоминание
|
processes.completedTasks.reminderDate | string |
Дата напоминания. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
ТребуетсяAllRecipients
|
processes.completedTasks.requiresAllRecipients | boolean |
Определяет, должны ли все получатели закрыть эту задачу |
|
ShowCloseTaskDialog
|
processes.completedTasks.showCloseTaskDialog | boolean |
Показать диалоговое окно закрытия задачи в конце задачи |
|
Состояние
|
processes.completedTasks.statusEnum | string |
Состояние задачи (Open, InProcess, Complete, PreparedToComplete, Error) |
|
TaskTemplateId
|
processes.completedTasks.taskTemplateId | string |
Идентификатор шаблона задачи |
|
CreatedDate
|
processes.createdDate | string |
Дата создания процесса. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
CurrentTask
|
processes.currentTask | string |
Текущая активная задача |
|
CustomProperties
|
processes.customProperties | string |
Список всех настраиваемых свойств |
|
DocumentIds
|
processes.documentIds | string |
Список всех присоединенных идентификаторов документа |
|
Дата выполнения
|
processes.dueDate | string |
Дата выполнения формата даты процесса: гггг-ММ-ддTHH:мм:сс |
|
FolderElementId
|
processes.folderElementId | string |
Идентификатор процесса в качестве элемента папки |
|
HasLinks
|
processes.hasLinks | boolean |
Пометка о том, имеет ли процесс ссылки |
|
Идентификатор
|
processes.id | string |
Идентификатор процесса |
|
values
|
processes.name.values | array of object |
values |
|
Культура
|
processes.name.values.culture | string |
Культура |
|
текст
|
processes.name.values.text | string |
текст |
|
PriorityEnum
|
processes.priorityEnum | string |
Приоритет процесса (высокий, обычный, низкий) |
|
PluginStream
|
processes.pluginStream | string |
Контейнер данных для подключаемых модулей |
|
ProcessTemplateId
|
processes.processTemplateId | string |
Идентификатор шаблона процесса |
|
properties
|
processes.properties | array of object |
properties |
|
propertyName
|
processes.properties.propertyName | string |
propertyName |
|
propertyTypeId
|
processes.properties.propertyTypeId | string |
propertyTypeId |
|
values
|
processes.properties.values | array of string |
values |
|
ProtectionDomainId
|
processes.protectionDomainId | string |
Идентификатор домена защиты процесса |
|
StatusEnum
|
processes.statusEnum | string |
Состояние процесса (Open, InProcess, Complete, PreparedToComplete, Error) |
|
HasMore
|
hasMore | boolean |
Указывает, существует ли больше результатов или нет. Флаг имеет значение true, если доступны дополнительные результаты |
|
Возобновление работы
|
resumePoint | string |
Точка возобновления из предыдущих операций поиска. Задайте значение NULL для первой операции поиска |
Слияние PDF-документов
Объединение двух или нескольких PDF-документов в одном документе
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL-адрес api архива (например: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Идентификатор подключения для идентификации подключения |
|
DocumentId
|
DocumentId | True | string |
Идентификатор первого PDF-документа, новая версия будет создана с новым объединенным содержимым |
|
DocumentIdToAppend
|
DocumentIdToAppend | True | string |
Идентификаторы документа, которые будут добавлены (объединены) в первую точку с запятой, т. е. '77b3c69d-7a9a-4083-9d75-83a5e6f3deca; 82514f19-057c-484f-8ee2-c21df811a928' |
|
ForceUndoCheckout
|
ForceUndoCheckout | boolean |
Отмените выход из первого PDF-документа по мере необходимости. Default = false |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
имя
|
name | string |
Имя документа |
|
id
|
id | string |
Идентификатор документа |
|
versionId
|
versionId | string |
Идентификатор версии документа |
|
currentVersionId
|
currentVersionId | string |
Документ с идентификатором текущей версии |
|
protectionDomainId
|
protectionDomainId | string |
Идентификатор домена защиты документов |
|
infoStoreId
|
infoStoreId | string |
Идентификатор InfoStore |
|
checkOutStateEnum
|
checkOutStateEnum | string |
Проверка перечисления состояния |
|
checkOutUserId
|
checkOutUserId | string |
Проверка идентификатора пользователя |
|
properties
|
properties | array of object |
Свойства |
|
propertyTypeId
|
properties.propertyTypeId | string |
Идентификатор PropertyType |
|
values
|
properties.values | array of string |
Значения PropertyType |
|
globalValues
|
properties.globalValues | array of object |
globalValues |
|
values
|
properties.globalValues.values | array of object |
values |
|
Культура
|
properties.globalValues.values.culture | string |
Региональные параметры и региональные параметры глобальных значений |
|
текст
|
properties.globalValues.values.text | string |
Текст глобальных значений |
|
propertyTypeName
|
properties.propertyTypeName | string |
Имя PropertyType |
|
propertyName
|
properties.propertyName | string |
Название свойства |
|
importTemplateId
|
importTemplateId | string |
Импорт идентификатора шаблона |
|
блоги
|
blogs | array of object |
Blogs |
|
дата создания
|
blogs.createdDate | string |
Дата создания блога |
|
creatorId
|
blogs.creatorId | string |
Идентификатор создателя блога |
|
текст
|
blogs.text | string |
Текст блога |
|
id
|
blogs.id | string |
Идентификатор блога |
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
Список перечисления прав доступа |
|
Напоминания
|
reminders | array of |
Напоминания |
|
pageCount
|
pageCount | integer |
Количество страниц |
|
mainFileLength
|
mainFileLength | integer |
Длина основного файла |
|
абоннементы
|
abonnements | array of |
Абоннементы |
|
textAnnotations
|
annotationManager.textAnnotations | array of |
Текстовые заметки |
|
прямоугольникиAnnotations
|
annotationManager.rectangleAnnotations | array of |
Заметки прямоугольника |
|
postItAnnotations
|
annotationManager.postItAnnotations | array of |
Заметки PostIt |
|
stampAnnotations
|
annotationManager.stampAnnotations | array of |
Заметки с метками |
|
documentData
|
documentData | array of object |
Данные документа |
|
id
|
documentData.id | string |
Идентификатор данных документа |
|
имя
|
documentData.name | string |
Имя данных документа |
|
Представления
|
documentData.renditions | array of object |
Представления |
|
id
|
documentData.renditions.id | string |
Идентификатор представления |
|
size
|
documentData.renditions.size | string |
Размер представления |
|
files
|
documentData.renditions.files | array of object |
Файлы представления |
|
BLOBStoreId
|
documentData.renditions.files.blobStoreId | string |
Идентификатор хранилища BLOB-объектов представления |
|
BLOBPath
|
documentData.renditions.files.blobPath | string |
Путь к blob-объекту представления |
|
pageCount
|
documentData.renditions.pageCount | string |
Число страниц представления |
|
Расширение
|
documentData.renditions.extension | string |
Расширение представления |
|
hashValue
|
documentData.renditions.hashValue | array of integer |
Хэш-значение представления |
|
contentProtections
|
documentData.renditions.contentProtections | array of |
Защита содержимого представления |
|
подписьProfileId
|
signingProfileId | string |
Идентификатор профиля подписи |
|
lifeCycleId
|
lifeCycleManager.lifeCycleId | string |
Идентификатор жизненного цикла |
|
lifeCycleStateId
|
lifeCycleManager.lifeCycleStateId | string |
Идентификатор состояния жизненного цикла |
|
lifeCycleStartDate
|
lifeCycleManager.lifeCycleStartDate | string |
Дата начала жизненного цикла |
|
lifeCycleEndDate
|
lifeCycleManager.lifeCycleEndDate | string |
Дата окончания жизненного цикла |
|
nextLifeCycleStates
|
lifeCycleManager.nextLifeCycleStates | array of |
Состояния следующего жизненного цикла |
|
checkOutLifeCycleStateId
|
lifeCycleManager.checkOutLifeCycleStateId | string |
Ознакомьтесь с идентификатором состояния жизненного цикла |
|
nextAutomaticLifeCycleStateId
|
lifeCycleManager.nextAutomaticLifeCycleStateId | string |
Следующий автоматический идентификатор состояния жизненного цикла |
|
lifeCycleProtections
|
lifeCycleManager.lifeCycleProtections | array of object |
Защита жизненного цикла |
|
id
|
lifeCycleManager.lifeCycleProtections.id | string |
Идентификатор защиты жизненного цикла |
|
protectionDurationTicks
|
lifeCycleManager.lifeCycleProtections.protectionDurationTicks | integer |
Срок действия защиты жизненного цикла |
|
protectCheckOut
|
lifeCycleManager.lifeCycleProtections.protectCheckOut | boolean |
Проверка защиты жизненного цикла |
|
protectContentChange
|
lifeCycleManager.lifeCycleProtections.protectContentChange | boolean |
Изменение содержимого защиты жизненного цикла |
|
protectPropertyChange
|
lifeCycleManager.lifeCycleProtections.protectPropertyChange | boolean |
Изменение свойства защиты жизненного цикла |
|
protectAnnotationChange
|
lifeCycleManager.lifeCycleProtections.protectAnnotationChange | boolean |
Изменение заметки защиты жизненного цикла |
|
protectProtectionDomainChange
|
lifeCycleManager.lifeCycleProtections.protectProtectionDomainChange | boolean |
Изменение домена защиты жизненного цикла |
|
protectDelete
|
lifeCycleManager.lifeCycleProtections.protectDelete | boolean |
Удаление защиты жизненного цикла |
|
deleteAfterExpiration
|
lifeCycleManager.lifeCycleProtections.deleteAfterExpiration | boolean |
Удаление защиты жизненного цикла после истечения срока действия |
|
hasOverlay
|
hasOverlay | boolean |
Наложение |
|
sessionCount
|
sessionCount | integer |
Количество сеансов |
|
hasSignature
|
hasSignature | boolean |
Имеет сигнатуру |
|
hasBlog
|
hasBlog | boolean |
Блог |
|
hasAnnotation
|
hasAnnotation | boolean |
Имеет заметку |
|
hasTempAccess
|
hasTempAccess | boolean |
Имеет временный доступ |
|
hasReminders
|
hasReminders | boolean |
Есть напоминания |
|
hasLinks
|
hasLinks | boolean |
Содержит ссылки |
|
hasAbonnement
|
hasAbonnement | boolean |
Имеет абоннемент |
Создание документа (версия 2)
Создание документа (версия 2)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL-адрес api архива (например: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Идентификатор подключения для идентификации подключения |
|
DocumentTitle
|
DocumentTitle | True | string |
Название документа (вкл. расширение) |
|
ImportTemplate
|
ImportTemplate | string |
Импорт имени шаблона или идентификатора, если пустые значения InfoStore и ProtectionDomain должны быть предоставлены. |
|
|
DocumentProperties
|
DocumentProperties | string |
Формат вставки свойств документа: Firstname=Peter|Lastname=Muller|InvoiceNo=4711; 4712; 4713 |
|
|
Блог
|
Blog | string |
Добавление записи текста блога в документе |
|
|
Культура
|
Culture | string |
Язык и региональные параметры, в которых задаются имена свойств (de, en, fr, ...). Default = de |
|
|
InfoStore
|
InfoStore | string |
Имя или идентификатор InfoStore необходимо указать, если ImportTemplate пуст |
|
|
LifeCycle
|
LifeCycle | string |
Имя или идентификатор LifeCycle |
|
|
ProtectionDomain
|
ProtectionDomain | string |
Имя или идентификатор protectionDomain необходимо указать, если ImportTemplate пуст |
|
|
UploadMethod
|
UploadMethod | string |
Метод, используемый при отправке документа в InfoShare. Default = UploadFileBytesLarge |
|
|
OriginalFileFormat
|
OriginalFileFormat | string |
Исходный формат файла для цели преобразования, например html. Преобразовано в pdf |
|
|
ChunkSize
|
ChunkSize | integer |
Размер блока отправки файла, используемого с методами отправки UploadStreamChunks и UploadFileBytesLarge, по умолчанию |
|
|
FileContent
|
FileContent | True | string |
Строка содержимого файла base64 |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
имя
|
name | string |
имя |
|
id
|
id | string |
Идентификатор документа |
|
versionId
|
versionId | string |
Идентификатор версии |
|
currentVersionId
|
currentVersionId | string |
Идентификатор текущей версии |
|
protectionDomainId
|
protectionDomainId | string |
Идентификатор домена защиты |
|
infoStoreId
|
infoStoreId | string |
Идентификатор InfoStore |
|
checkOutStateEnum
|
checkOutStateEnum | string |
Проверьте состояние документа (NotCheckedOut, CheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
checkOutUserId
|
checkOutUserId | string |
Извлечен идентификатор пользователя |
|
properties
|
properties | array of object |
Свойства |
|
propertyTypeId
|
properties.propertyTypeId | string |
Идентификатор PropertyType |
|
values
|
properties.values | array of string |
Значения PropertyType |
|
globalValues
|
properties.globalValues | array of object |
Глобальные значения |
|
values
|
properties.globalValues.values | array of object |
values |
|
Культура
|
properties.globalValues.values.culture | string |
Язык и региональные параметры глобального значения |
|
текст
|
properties.globalValues.values.text | string |
Текст глобального значения |
|
propertyTypeName
|
properties.propertyTypeName | string |
Имя PropertyType |
|
propertyName
|
properties.propertyName | string |
Название свойства |
|
importTemplateId
|
importTemplateId | string |
Импорт идентификатора шаблона |
|
блоги
|
blogs | array of object |
блоги |
|
дата создания
|
blogs.createdDate | string |
Дата создания блога |
|
creatorId
|
blogs.creatorId | string |
Идентификатор создателя блога |
|
текст
|
blogs.text | string |
Текст блога |
|
id
|
blogs.id | string |
Идентификатор блога |
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
accessRightsEnumList |
|
Напоминания
|
reminders | array of |
Напоминания |
|
pageCount
|
pageCount | integer |
Количество страниц |
|
mainFileLength
|
mainFileLength | integer |
Длина основного файла |
|
абоннементы
|
abonnements | array of |
Абоннементы |
|
textAnnotations
|
annotationManager.textAnnotations | array of |
Текст заметок |
|
прямоугольникиAnnotations
|
annotationManager.rectangleAnnotations | array of |
Прямоугольник примечаний |
|
postItAnnotations
|
annotationManager.postItAnnotations | array of |
Заметки опубликуют его |
|
stampAnnotations
|
annotationManager.stampAnnotations | array of |
Метка заметок |
|
documentData
|
documentData | array of object |
Данные документа |
|
id
|
documentData.id | string |
Идентификатор данных документа |
|
имя
|
documentData.name | string |
Имя данных документа |
|
Представления
|
documentData.renditions | array of object |
Представления |
|
id
|
documentData.renditions.id | string |
Идентификатор представления |
|
size
|
documentData.renditions.size | string |
Размер представления |
|
files
|
documentData.renditions.files | array of object |
files |
|
BLOBStoreId
|
documentData.renditions.files.blobStoreId | string |
Идентификатор хранилища BLOB-объектов |
|
BLOBPath
|
documentData.renditions.files.blobPath | string |
Путь к BLOB-объектам |
|
pageCount
|
documentData.renditions.pageCount | string |
Число страниц представления |
|
Расширение
|
documentData.renditions.extension | string |
Расширение представления |
|
hashValue
|
documentData.renditions.hashValue | array of integer |
Хэш-значение представления |
|
contentProtections
|
documentData.renditions.contentProtections | array of |
Защита содержимого представления |
|
подписьProfileId
|
signingProfileId | string |
Идентификатор профиля подписи |
|
lifeCycleId
|
lifeCycleManager.lifeCycleId | string |
Идентификатор жизненного цикла |
|
lifeCycleStateId
|
lifeCycleManager.lifeCycleStateId | string |
Идентификатор состояния жизненного цикла |
|
lifeCycleStartDate
|
lifeCycleManager.lifeCycleStartDate | string |
Дата начала жизненного цикла |
|
lifeCycleEndDate
|
lifeCycleManager.lifeCycleEndDate | string |
Дата окончания жизненного цикла |
|
nextLifeCycleStates
|
lifeCycleManager.nextLifeCycleStates | array of |
Состояния следующего жизненного цикла |
|
checkOutLifeCycleStateId
|
lifeCycleManager.checkOutLifeCycleStateId | string |
Ознакомьтесь с идентификатором состояния жизненного цикла |
|
nextAutomaticLifeCycleStateId
|
lifeCycleManager.nextAutomaticLifeCycleStateId | string |
Следующий автоматический идентификатор состояния жизненного цикла |
|
lifeCycleProtections
|
lifeCycleManager.lifeCycleProtections | array of object |
Защита жизненного цикла |
|
id
|
lifeCycleManager.lifeCycleProtections.id | string |
Идентификатор защиты жизненного цикла |
|
protectionDurationTicks
|
lifeCycleManager.lifeCycleProtections.protectionDurationTicks | integer |
Срок действия защиты жизненного цикла |
|
protectCheckOut
|
lifeCycleManager.lifeCycleProtections.protectCheckOut | boolean |
Защита жизненного цикла |
|
protectContentChange
|
lifeCycleManager.lifeCycleProtections.protectContentChange | boolean |
Изменение содержимого в жизненном цикле |
|
protectPropertyChange
|
lifeCycleManager.lifeCycleProtections.protectPropertyChange | boolean |
Изменение свойства защиты жизненного цикла |
|
protectAnnotationChange
|
lifeCycleManager.lifeCycleProtections.protectAnnotationChange | boolean |
Изменение заметки в жизненном цикле |
|
protectProtectionDomainChange
|
lifeCycleManager.lifeCycleProtections.protectProtectionDomainChange | boolean |
Изменение домена защиты жизненного цикла защиты |
|
protectDelete
|
lifeCycleManager.lifeCycleProtections.protectDelete | boolean |
Жизненный цикл защиты удаления |
|
deleteAfterExpiration
|
lifeCycleManager.lifeCycleProtections.deleteAfterExpiration | boolean |
Удаление жизненного цикла после истечения срока действия |
|
hasOverlay
|
hasOverlay | boolean |
Наложение |
|
sessionCount
|
sessionCount | integer |
Количество сеансов |
|
hasSignature
|
hasSignature | boolean |
Имеет сигнатуру |
|
hasBlog
|
hasBlog | boolean |
Блог |
|
hasAnnotation
|
hasAnnotation | boolean |
Имеет заметку |
|
hasTempAccess
|
hasTempAccess | boolean |
Имеет временный доступ |
|
hasReminders
|
hasReminders | boolean |
Есть напоминания |
|
hasLinks
|
hasLinks | boolean |
Содержит ссылки |
|
hasAbonnement
|
hasAbonnement | boolean |
Имеет абоннемент |
Создание документа (не рекомендуется) [DEPRECATED]
Создание документа (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL-адрес api архива (например: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Идентификатор подключения для идентификации подключения |
|
DocumentTitle
|
DocumentTitle | True | string |
Название документа (вкл. расширение) |
|
ImportTemplate
|
ImportTemplate | True | string |
Импорт шаблона |
|
DocumentProperties
|
DocumentProperties | string |
Формат вставки свойств документа: Firstname=Peter|Lastname=Muller|InvoiceNo=4711; 4712; 4713 |
|
|
Культура
|
Culture | string |
Язык и региональные параметры, в которых задаются имена свойств (de, en, fr, ...). Default = de |
|
|
FileContent
|
FileContent | True | string |
Строка содержимого файла base64 |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
абоннементы
|
abonnements | array of string |
абоннементы |
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
accessRightsEnumList |
|
postItAnnotations
|
annotationManager.postItAnnotations | array of object |
postItAnnotations |
|
CreatedDate
|
annotationManager.postItAnnotations.createdDate | string |
Дата создания из публикации заметки |
|
CreatorId
|
annotationManager.postItAnnotations.creatorId | string |
Идентификатор пользователя создателя из публикации заметки |
|
IsItalic
|
annotationManager.postItAnnotations.fontInfo.isItalic | boolean |
Является курсивом шрифта из публикации заметки |
|
IsStrikeOut
|
annotationManager.postItAnnotations.fontInfo.isStrikeOut | boolean |
Вычеркивает шрифт из публикации заметки |
|
IsUnderline
|
annotationManager.postItAnnotations.fontInfo.isUnderline | boolean |
Является ли шрифт подчеркиванием из публикации заметки |
|
Имя
|
annotationManager.postItAnnotations.fontInfo.name | string |
Имя шрифта из публикации заметки. Default = Arial |
|
Подача
|
annotationManager.postItAnnotations.fontInfo.pitch | integer |
Шаг шрифта из публикации заметки |
|
Size
|
annotationManager.postItAnnotations.fontInfo.size | integer |
Размер шрифта из публикации заметки. Пример: размер:12 — 12000. Вам нужен фактор 1000 |
|
Weight
|
annotationManager.postItAnnotations.fontInfo.weight | integer |
Вес шрифта из публикации заметки |
|
Идентификатор
|
annotationManager.postItAnnotations.id | string |
Идентификатор публикации заметки |
|
ИзменениеDate
|
annotationManager.postItAnnotations.modifiedDate | string |
Дата изменения из публикации заметки. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
PageNumber
|
annotationManager.postItAnnotations.pageNumber | integer |
Количество страниц из публикации заметки |
|
SecurityLevelEnum
|
annotationManager.postItAnnotations.securityLevelEnum | string |
Уровень безопасности для публикации заметки (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Default = PubliclyAvailable |
|
Выбор
|
annotationManager.postItAnnotations.selectable | boolean |
Определяет, можно ли выбрать запись заметки пользователем. |
|
Текст
|
annotationManager.postItAnnotations.text | string |
Определяемый пользователем текст для публикации заметки |
|
X
|
annotationManager.postItAnnotations.x | integer |
Координата X в пикселях на дюйм для 7200 DPI записи заметки |
|
У
|
annotationManager.postItAnnotations.y | integer |
Координата Y в пикселях на дюйм для 7200 DPI публикации заметки |
|
прямоугольникиAnnotations
|
annotationManager.rectangleAnnotations | array of object |
прямоугольникиAnnotations |
|
Цвет
|
annotationManager.rectangleAnnotations.color | integer |
Цвет прямоугольника (32-разрядное значение ARGB) из заметки прямоугольника: черный: -16777216 белый: -1 красный: -65536 зеленый: -16744448 синий: -16776961 |
|
ColorHexCode
|
annotationManager.rectangleAnnotations.colorHexCode | string |
Цвет прямоугольника (шестнадцатеричный код RGB) из заметки прямоугольника. Пример: черный: #000000 белый: #FFFFFF красный: #FF0000 зеленый: #008000 синий: #0000FF |
|
CreatedDate
|
annotationManager.rectangleAnnotations.createdDate | string |
Дата создания из заметки прямоугольника. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
creatorId
|
annotationManager.rectangleAnnotations.creatorId | string |
CreatorId |
|
Высота
|
annotationManager.rectangleAnnotations.height | integer |
Высота прямоугольника в пикселях на дюйм для 7200 DPI |
|
Идентификатор
|
annotationManager.rectangleAnnotations.Id | string |
Идентификатор заметки прямоугольника |
|
ИзменениеDate
|
annotationManager.rectangleAnnotations.modifiedDate | string |
Дата изменения из заметки прямоугольника. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
PageNumber
|
annotationManager.rectangleAnnotations.pageNumber | integer |
Число страниц из заметки прямоугольника |
|
SecurityLevelEnum
|
annotationManager.rectangleAnnotations.securityLevelEnum | string |
Уровень безопасности для заметки прямоугольника (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Default = PubliclyAvailable |
|
Выбор
|
annotationManager.rectangleAnnotations.selectable | boolean |
Определяет, можно ли выбрать заметку прямоугольника пользователем |
|
Transparent
|
annotationManager.rectangleAnnotations.transparent | boolean |
Прямоугольник должен быть прозрачным (выделение) |
|
Ширина
|
annotationManager.rectangleAnnotations.width | integer |
Ширина прямоугольника в пикселях на дюйм для 7200 DPI |
|
X
|
annotationManager.rectangleAnnotations.x | integer |
Координата X в пикселях на дюйм для 7200 DPI из заметки прямоугольника |
|
У
|
annotationManager.rectangleAnnotations.y | integer |
Координата Y в пикселях на дюйм для 7200 DPI из заметки прямоугольника |
|
textAnnotations
|
annotationManager.textAnnotations | array of object |
textAnnotations |
|
BackgroundColor
|
annotationManager.textAnnotations.backgroundColor | integer |
Цвет фона (32-разрядное значение ARGB) из текстовой заметки Example: Black: -16777216 White: -1 Red: -65536 Green: -16744448 Blue: -16776961 |
|
BackgroundColorHexCode
|
annotationManager.textAnnotations.backgroundColorHexCode | string |
Цвет фона (шестнадцатеричный код RGB) из текстового заметки Example: Black: #000000 Белый: #FFFFFF Красный: #FF0000 Зеленый: #008000 Синий: #0000FF |
|
CreatedDate
|
annotationManager.textAnnotations.createdDate | string |
дата создания из текстовой заметки. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
CreatorId
|
annotationManager.textAnnotations.creatorId | string |
Идентификатор пользователя создателя из текстовой заметки |
|
IsItalic
|
annotationManager.textAnnotations.fontInfo.isItalic | boolean |
Является курсивом шрифта из текстовой заметки |
|
IsStrikeOut
|
annotationManager.textAnnotations.fontInfo.isStrikeOut | boolean |
Вычеркивает шрифт из текстовой заметки |
|
IsUnderline
|
annotationManager.textAnnotations.fontInfo.isUnderline | boolean |
Подчеркивание шрифта из текстовой заметки |
|
Имя
|
annotationManager.textAnnotations.fontInfo.name | string |
Имя шрифта из текстовой заметки. Default = Arial |
|
Подача
|
annotationManager.textAnnotations.fontInfo.pitch | integer |
Шаг шрифта из текстовой заметки |
|
Size
|
annotationManager.textAnnotations.fontInfo.size | integer |
Размер шрифта из текстовой заметки. Пример: размер:12 — 12000. Вам нужен фактор 1000 |
|
Weight
|
annotationManager.textAnnotations.fontInfo.weight | integer |
Вес шрифта из текстовой заметки |
|
ForegroundColor
|
annotationManager.textAnnotations.foregroundColor | integer |
Цвет переднего плана (32-разрядное значение ARGB) из текстовой заметки. Пример: черный: -16777216 белый: -1 красный: -65536 зеленый: -16744448 синий: -16776961 |
|
ForegroundColorHexCode
|
annotationManager.textAnnotations.foregroundColorHexCode | string |
Цвет переднего плана (шестнадцатеричный код RGB) из текстовой заметки. Пример: черный: #000000 белый: #FFFFFF красный: #FF0000 зеленый: #008000 синий: #0000FF |
|
Высота
|
annotationManager.textAnnotations.height | integer |
Высота текста в пикселях на дюйм для 7200 DPI из текстовой заметки |
|
Идентификатор
|
annotationManager.textAnnotations.id | string |
Идентификатор текстовой заметки |
|
ИзменениеDate
|
annotationManager.textAnnotations.modifiedDate | string |
Дата изменения из текстовой заметки. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
PageNumber
|
annotationManager.textAnnotations.pageNumber | integer |
Количество страниц из текстовой заметки |
|
Вращение
|
annotationManager.textAnnotations.rotation | integer |
Поворот в градусах из текстовой заметки |
|
SecurityLevelEnum
|
annotationManager.textAnnotations.securityLevelEnum | string |
Уровень безопасности для текстовой заметки (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Default = PubliclyAvailable |
|
Выбор
|
annotationManager.textAnnotations.selectable | boolean |
Определяет, можно ли выбрать текстовую заметку пользователем |
|
Текст
|
annotationManager.textAnnotations.text | string |
Определяемый пользователем текст заметки |
|
Transparent
|
annotationManager.textAnnotations.transparent | boolean |
Текстовая заметка должна быть прозрачной |
|
Ширина
|
annotationManager.textAnnotations.width | integer |
Ширина текста в пикселях на дюйм для 7200 DPI из текстовой заметки |
|
X
|
annotationManager.textAnnotations.x | integer |
Координата X в пикселях на дюйм для 7200 DPI из текстовой заметки |
|
У
|
annotationManager.textAnnotations.y | integer |
Координата Y в пикселях на дюйм для 7200 DPI из текстовой заметки |
|
блоги
|
blogs | array of object |
блоги |
|
Blogs
|
blogs | object |
Список всех элементов блога |
|
CheckOutState
|
checkOutStateEnum | string |
Проверьте состояние документа (NotCheckedOut, CheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
checkOutUserId | string |
Идентификатор пользователя, для которого извлечен документ |
|
documentData
|
documentData | array of object |
documentData |
|
Идентификатор
|
documentData.id | string |
Идентификатор представления документа |
|
Имя
|
documentData.name | string |
Имя документа представления |
|
Представления
|
documentData.renditions | array of |
Представления |
|
HasOverlay
|
hasOverlay | boolean |
Определяет, должен ли документ отображаться с наложением |
|
Идентификатор
|
id | string |
Идентификатор документа |
|
ImportTemplateId
|
importTemplateId | string |
Идентификатор шаблона импорта для этого документа |
|
InfoStoreId
|
infoStoreId | string |
Идентификатор хранилища сведений |
|
CheckOutLifeCycleStateId
|
lifeCycleManager.checkOutLifeCycleStateId | string |
Состояние жизненного цикла проверки |
|
LifeCycleEndDate
|
lifeCycleManager.lifeCycleEndDate | string |
Вычисляемая дата окончания жизненного цикла. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
LifeCycleStartDate
|
lifeCycleManager.lifeCycleStartDate | string |
Дата начала жизненного цикла. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
LifeCycleStateId
|
lifeCycleManager.lifeCycleStateId | string |
Идентификатор состояния LifeCycle |
|
NextAutomaticLifeCycleStateId
|
lifeCycleManager.nextAutomaticLifeCycleStateId | string |
Следующее состояние жизненного цикла |
|
nextLifeCycleStates
|
lifeCycleManager.nextLifeCycleStates | array of string |
nextLifeCycleStates |
|
lifeCycleProtections
|
lifeCycleManager.lifeCycleProtections | array of object |
lifeCycleProtections |
|
DeleteAfterExpiration
|
lifeCycleManager.lifeCycleProtections.deleteAfterExpiration | boolean |
Разрешить удалить документ после истечения срока действия защиты |
|
Идентификатор
|
lifeCycleManager.lifeCycleProtections.id | string |
Идентификатор защиты состояния жизненного цикла |
|
ProtectAnnotationChange
|
lifeCycleManager.lifeCycleProtections.protectAnnotationChange | boolean |
Защита от изменений примечаний |
|
ProtectCheckOut
|
lifeCycleManager.lifeCycleProtections.protectCheckOut | boolean |
Защита от извлечений |
|
ProtectContentChange
|
lifeCycleManager.lifeCycleProtections.protectContentChange | boolean |
Защита от изменения содержимого |
|
ProtectDelete
|
lifeCycleManager.lifeCycleProtections.protectDelete | boolean |
Защита от удаления |
|
ProtectPropertyChange
|
lifeCycleManager.lifeCycleProtections.protectPropertyChange | boolean |
Защита от изменений свойств |
|
ProtectProtectionDomainChange
|
lifeCycleManager.lifeCycleProtections.protectProtectionDomainChange | boolean |
Защита от изменений безопасности |
|
ProtectionDurationTicks
|
lifeCycleManager.lifeCycleProtections.protectionDurationTicks | integer |
Длительность защиты |
|
LifeCycleId
|
lifeCycleManager.lifeCycleId | string |
Идентификатор LifeCycle |
|
MainFileLength
|
mainFileLength | integer |
Размер основного файла |
|
Имя
|
name | string |
Имя документа |
|
PageCount
|
pageCount | integer |
Количество страниц основного файла |
|
properties
|
properties | array of object |
properties |
|
globalValues
|
properties.globalValues | array of object |
globalValues |
|
values
|
properties.globalValues.values | array of object |
values |
|
Культура
|
properties.globalValues.values.culture | string |
Культура |
|
текст
|
properties.globalValues.values.text | string |
Текст |
|
PropertyTypeId
|
properties.propertyTypeId | string |
Идентификатор типа поля индекса |
|
values
|
properties.values | array of string |
Значения PropertyType |
|
ProtectionDomainId
|
protectionDomainId | string |
Идентификатор домена защиты |
|
Напоминания
|
reminders | array of object |
Напоминания |
|
Напоминания
|
reminders | object |
Список всех напоминаний |
|
SessionCount
|
sessionCount | integer |
Количество сеансов |
|
ПодписьProfileId
|
signingProfileId | string |
Идентификатор профиля подписи |
|
VersionId
|
versionId | string |
Идентификатор версии документа |
Создание процесса
Создание процесса
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL-адрес api архива (например: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Идентификатор подключения для идентификации подключения |
|
ProcessProperties
|
ProcessProperties | string |
Формат обновления свойств процесса: Firstname=Peter|Lastname=Muller|InvoiceNo=4711; 4712; 4713 |
|
|
CustomProperties
|
CustomProperties | string |
Пользовательские свойства. Формат: [<PropertyName>|<PropertyValue>|PropertyType] (например, [поставщик|Muster |String][InvoiceDate|2021-01-29T13:05:45 |Date][InvoiceNo|4711|Число]) |
|
|
DocumentIds
|
DocumentIds | string |
Список всех идентификаторов документов для присоединения |
|
|
ProcessTemplateName
|
ProcessTemplateName | True | string |
Имя шаблона процесса |
|
Дата выполнения
|
DueDate | string |
Дата выполнения процесса. Формат даты: гггг-ММ-ддTHH:mm:ss. Default = текущая дата |
|
|
Priority
|
Priority | string |
Приоритет процесса (например, низкий, обычный, высокий). Default = Normal |
|
|
Комментарий
|
Comment | string |
Комментарий процесса |
|
|
Культура
|
Culture | string |
Язык и региональные параметры, в которых указан текст (de, en, fr, ...). Default = de |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
accessRightsEnumList |
|
CheckOutState
|
checkOutStateEnum | string |
Проверьте состояние документа (NotCheckedOut, CheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
checkOutUserId | string |
Идентификатор пользователя, для которого извлечен процесс |
|
comments
|
comments | array of object |
comments |
|
Date
|
comments.date | string |
Дата комментария |
|
Идентификатор
|
comments.id | string |
Идентификатор комментария |
|
Текст
|
comments.text | string |
Определяемый пользователем комментарий |
|
UserId
|
comments.userId | string |
Идентификатор пользователя |
|
ЗавершеноDate
|
completedDate | string |
Дата завершения. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
completedTasks
|
completedTasks | array of string |
completedTasks |
|
CreatedDate
|
createdDate | string |
Дата создания. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
Действие
|
currentTask.action | string |
Текст действия для пользователя. Отображается пользователю |
|
assignedUserIds
|
currentTask.assignedUserIds | array of string |
assignedUserIds |
|
comments
|
currentTask.comments | array of string |
comments |
|
ЗавершеноDate
|
currentTask.completedDate | string |
Дата завершения текущей задачи. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
completedUserIds
|
currentTask.completedUserIds | array of string |
completedUserIds |
|
CreatedDate
|
currentTask.createdDate | string |
Дата создания текущей задачи. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
CreatorId
|
currentTask.creatorId | string |
Идентификатор пользователя создателя для текущей задачи |
|
Description
|
currentTask.description | string |
Описание текущей задачи |
|
Дата выполнения
|
currentTask.dueDate | string |
Дата выполнения текущей задачи. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
ПредполагаемыеUserIds
|
currentTask.intendedUserIds | array of string |
ПредполагаемыеUserIds |
|
Напоминание
|
currentTask.reminderDate | string |
Дата напоминания текущей задачи. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
ТребуетсяAllRecipients
|
currentTask.requiresAllRecipients | boolean |
Определяет, должны ли все получатели закрыть эту задачу |
|
ShowCloseTaskDialog
|
currentTask.showCloseTaskDialog | boolean |
Показать диалоговое окно закрытия задачи в конце задачи |
|
StatusEnum
|
currentTask.statusEnum | string |
Текущая задача состояния (Open, InProcess, Complete, PreparedToComplete, Error) |
|
TaskTemplateId
|
currentTask.taskTemplateId | string |
Идентификатор шаблона текущей задачи |
|
customProperties
|
customProperties | array of object |
customProperties |
|
CustomPropertyTypeEnum
|
customProperties.customPropertyTypeEnum | string |
Значение перечисления типа пользовательского свойства (String, Date, Number) |
|
Имя
|
customProperties.name | string |
Имя настраиваемого свойства |
|
Ценность
|
customProperties.value | string |
Значение настраиваемого свойства |
|
documentIds
|
documentIds | array of string |
documentIds |
|
Дата выполнения
|
dueDate | string |
Дата выполнения процесса. Формат даты: гггг-ММ-ддTHH:mm:ss |
|
FolderElementId
|
folderElementId | string |
Идентификатор документа в качестве элемента папки |
|
HasLinks
|
hasLinks | boolean |
Идентификатор документа в качестве элемента папки |
|
Идентификатор
|
id | string |
Идентификатор процесса |
|
values
|
name.values | array of object |
values |
|
Культура
|
name.values.culture | string |
Язык и региональные параметры, в которых указан текст (de, en, fr, ...) |
|
Текст
|
name.values.text | string |
Текст для этого языка |
|
PriorityEnum
|
priorityEnum | string |
Приоритет процесса (высокий, обычный, низкий). Default = Normal |
|
PluginStream
|
pluginStream | string | |
|
ProcessTemplateId
|
processTemplateId | string |
Идентификатор шаблона процесса |
|
properties
|
properties | array of object |
properties |
|
globalValues
|
properties.globalValues | array of object |
globalValues |
|
values
|
properties.globalValues.values | array of object |
values |
|
Культура
|
properties.globalValues.values.culture | string |
Культура |
|
текст
|
properties.globalValues.values.text | string |
текст |
|
ИмяСвойства
|
properties.propertyName | string |
Имя свойства процесса |
|
PropertyTypeId
|
properties.propertyTypeId | string |
Идентификатор свойства процесса |
|
values
|
properties.values | array of string |
values |
|
ProtectionDomainId
|
protectionDomainId | string |
Идентификатор домена защиты процесса |
|
StatusEnum
|
statusEnum | string |
Состояние процесса (Open, InProcess, Complete, PreparedToComplete, Error) |
Создание таблицы пользователя
Создание таблицы пользователя
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL-адрес api архива (например: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Идентификатор подключения для идентификации подключения |
|
UserTable
|
UserTable | True | string |
Имя таблицы пользователя (например, адрес) |
|
ColumnHeaders
|
ColumnHeaders | True | string |
Список заголовков столбцов (например: Firstname,Lastname,City) |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Таблица пользователей
|
userTable | string |
Имя таблицы пользователя |
Удаление строк таблицы пользователей
Удаление строк таблицы пользователей
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL-адрес api архива (например: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Идентификатор подключения для идентификации подключения |
|
UserTable
|
UserTable | True | string |
Имя таблицы пользователя |
|
WhereClause
|
WhereClause | string |
Список sql, где элементы предложения. Формат: [<PropertyName>|<СравнениеEnum>|<PropertyValue>|<RelationEnum>]. ComparisonEnums: "Equals,NotEquals,Greater,GreaterEquals,Less,LessEquals,Like,NotLike" RelationEnums:"AND,OR" (например: [Firstname|Равно|Джон |AND],[Фамилия|Равно|Doe|OR]) |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
userTableDeleteRecordsResult
|
userTableDeleteRecordsResult | integer |
userTableDeleteRecordsResult |