|
<< Click to Display Table of Contents >> Интеграция с внешними системами > Объектная модель для настройки интеграции Серверные функции модуля Docflow |
|
|
<< Click to Display Table of Contents >> Интеграция с внешними системами > Объектная модель для настройки интеграции Серверные функции модуля Docflow |
|
Имя функции |
Модификатор |
Атрибут |
Описание |
virtual |
[Public] |
Добавить папку в родительскую папку |
|
virtual |
[Public] |
Добавить документ в папку |
|
virtual |
[Public] |
Связать документы |
|
static |
[Public] |
Добавить рабочие дни и часы к дате |
|
virtual |
[Public] |
Утвердить документ |
|
virtual |
[Public] |
Заполнить параметры массовой переиндексации |
|
static |
[Public] |
Проверить, есть ли права на изменение настроек интеллектуальной обработки |
|
virtual |
[Public] |
Проверить, что журнал регистрации подходит для регистрации или нумерации документа |
|
virtual |
[Public] |
Проверить, что журнал регистрации подходит для регистрации или нумерации документа |
|
virtual |
[Public] |
Выполнить задание |
|
– |
[Public] |
Преобразовать документ в PDF с отметкой о поступлении |
|
virtual |
[Public] |
Интерактивно преобразовать документ в PDF с наложением отметки об ЭП |
|
CreateApprovalTask + перегрузки |
virtual |
[Public] |
Создать задачу на согласование по регламенту |
virtual |
[Public] |
Создать папку в родительской папке. Если папка с таким именем уже существует, вернуть её ИД |
|
CreateDistributionList + перегрузки |
virtual |
[Public] |
Создать список рассылки |
CreateFreeApprovalTask + перегрузки |
virtual |
[Public] |
Создать задачу на свободное согласование |
virtual |
[Public] |
Создать право подписи с электронной доверенностью |
|
virtual |
[Public] |
Создать простую задачу |
|
– |
[Public] |
Создать версию из шаблона |
|
virtual |
[Public] |
Согласовать документ |
|
virtual |
[Public] |
Проверить, что у папки есть содержимое |
|
static |
[Public] |
Получить токен к Ario |
|
static |
[Public] |
Получить адрес сервиса Ario |
|
– |
[Public] |
Получить текущее наименование культуры |
|
virtual |
[Public] |
Получить вид документа в шаблонах по guid |
|
virtual |
[Public] |
Получить папку "Избранные" заданного сотрудника |
|
virtual |
[Public] |
Получить папку по названию |
|
– |
[Public] |
Получить список Guid видов документов шаблона в виде строки |
|
– |
[Public] |
Получить хэш последней версии шаблона |
|
virtual |
[Public] |
Выдать права на документ |
|
virtual |
[Public] |
Выдать права на папку |
|
virtual |
[Public] |
Импортировать xml фаил эл. доверенности и подпись в новую версию документа |
|
virtual |
[Public] |
Выполнить индексацию документа для полнотекстового поиска |
|
virtual |
[Public] |
Зарегистрировать документ |
|
static |
[Public] |
Задать основные настройки поступления документов |
|
virtual |
[Public] |
Стартовать задачу |
|
virtual |
[Public] |
Попытаться зарегистрировать документ с настройками по умолчанию |
Добавить папку в родительскую папку.
Синтаксис
[Public(WebApiRequestType = RequestType.Post)]
public virtual void AddChildFolder(long folderId, long parentFolderId)
Параметры
folderId – ИД добавляемой папки;
parentFolderId – ИД родительской папки.
Добавить документ в папку.
Синтаксис
[Public(WebApiRequestType = RequestType.Post)]
public virtual void AddDocumentToFolder(long documentId, long folderId)
Параметры
documentId – ИД документа;
folderId – ИД папки.
Связать документы.
Синтаксис
[Public(WebApiRequestType = RequestType.Post)]
public virtual void AddRelations(string relationName, long baseDocumentId, long relationDocumentId)
Параметры
relationName – Наименование типа связи;
baseDocumentId – ИД документа-основания;
relationDocumentId – ИД связываемого документа.
Добавить рабочие дни и часы к дате.
Синтаксис
[Public(WebApiRequestType = RequestType.Get)]
public static DateTime AddWorkingDaysAndHours(DateTime date, int days, int hours)
Параметры
date – Дата;
days – Количество дней;
hours – Количество часов.
Возвращаемое значение
DateTime – Рабочий день и время через определенное количество дней и часов от переданной даты.
Утвердить документ.
Синтаксис
[Public(WebApiRequestType = RequestType.Post)]
public virtual void ApproveDocument(long documentId, string note)
Параметры
documentId – ИД документа;
note – Комментарий.
BulkIndexDocumentsForFullTextSearch
Заполнить параметры массовой переиндексации.
Синтаксис
[Public(WebApiRequestType = RequestType.Post)]
public virtual void BulkIndexDocumentsForFullTextSearch(DateTime periodBegin, DateTime periodEnd, string mode)
Параметры
periodBegin – Дата начала периода;
periodEnd – Дата окончания периода;
mode – Режим отбора документов.
CanUpdateSmartProcessingSettings
Проверить, есть ли права на изменение настроек интеллектуальной обработки.
Синтаксис
[Public(WebApiRequestType = RequestType.Get)]
public static bool CanUpdateSmartProcessingSettings()
Возвращаемое значение
bool – True - права есть, иначе - false.
Проверить, что журнал регистрации подходит для регистрации или нумерации документа.
Синтаксис
[Public(WebApiRequestType = RequestType.Get)]
public virtual bool CheckDocumentRegister(long documentRegisterId, long documentKindId, long? businessUnitId, long? departmentId)
Параметры
documentRegisterId – Ид журнала регистрации;
documentKindId – Ид вида документа;
businessUnitId – Ид нашей организации;
departmentId – Ид подразделения.
Возвращаемое значение
bool – True - если журнал подходит для регистрации или нумерации по переданным критериям.
CheckDocumentRegisterByTinAndTrrc
Проверить, что журнал регистрации подходит для регистрации или нумерации документа.
Синтаксис
[Public(WebApiRequestType = RequestType.Get)]
public virtual bool CheckDocumentRegisterByTinAndTrrc(long documentRegisterId, long documentKindId, string businessUnitTin, string businessUnitTrrc, long? departmentId)
Параметры
documentRegisterId – Ид журнала регистрации;
documentKindId – Ид вида документа;
businessUnitTin – ИНН нашей организации;
businessUnitTrrc – КПП нашей организации;
departmentId – Ид подразделения.
Возвращаемое значение
bool – True - если журнал подходит для регистрации или нумерации по переданным критериям.
Выполнить задание.
Синтаксис
[Public(WebApiRequestType = RequestType.Post)]
public virtual void CompleteAssignment(long assignmentId, string result)
Параметры
assignmentId – ИД задания;
result – Результат выполнения.
ConvertToPdfWithRegistrationStamp
Преобразовать документ в PDF с отметкой о поступлении.
Синтаксис
[Public(WebApiRequestType = RequestType.Post)]
public void ConvertToPdfWithRegistrationStamp(long documentId, double rightIndent, double bottomIndent)
Параметры
documentId – ИД документа;
rightIndent – Значение отступа справа;
bottomIndent – Значение отступа снизу.
ConvertToPdfWithSignatureMarkInteractively
Интерактивно преобразовать документ в PDF с наложением отметки об ЭП.
Синтаксис
[Public(WebApiRequestType = RequestType.Post)]
public virtual void ConvertToPdfWithSignatureMarkInteractively(long documentId)
Параметры
documentId – ИД документа.
Создать задачу на согласование по регламенту.
Перегрузки
Имя функции |
Описание |
CreateApprovalTask (long documentId, string text, long? signatoryId, List<long> addApproverIds) |
Создать задачу на согласование по регламенту |
CreateApprovalTask (long documentId, string text, long? signatoryId, List<long> addApproverIds)
Создать задачу на согласование по регламенту.
Синтаксис
[Public(WebApiRequestType = RequestType.Post)]
public virtual long CreateApprovalTask(long documentId, string text, long? signatoryId, List<long> addApproverIds)
Параметры
documentId – ИД согласуемого документа;
text – Текст задачи;
signatoryId – ИД подписанта;
addApproverIds – Список ИД дополнительных согласующих.
Возвращаемое значение
long – ИД созданной задачи.
Создать папку в родительской папке. Если папка с таким именем уже существует, вернуть её ИД.
Синтаксис
[Public(WebApiRequestType = RequestType.Post)]
public virtual long CreateChildFolder(string folderName, long parentFolderId)
Параметры
folderName – Наименование папки;
parentFolderId – ИД родительской папки.
Возвращаемое значение
long – ИД созданной или существующей папки.
Создать список рассылки.
Перегрузки
Имя функции |
Описание |
CreateDistributionList (string name, List<long> correspondentIds) |
Создать список рассылки |
CreateDistributionList (string name, List<long> correspondentIds)
Создать список рассылки.
Синтаксис
[Public(WebApiRequestType = RequestType.Post)]
public virtual long CreateDistributionList(string name, List<long> correspondentIds)
Параметры
name – Имя списка;
correspondentIds – Список ИД адресатов.
Возвращаемое значение
long – ИД списка.
Создать задачу на свободное согласование.
Перегрузки
Имя функции |
Описание |
CreateFreeApprovalTask (long documentId, string text, DateTime? deadline, List<long> approverIds) |
Создать задачу на свободное согласование |
CreateFreeApprovalTask (long documentId, string text, DateTime? deadline, List<long> approverIds)
Создать задачу на свободное согласование.
Синтаксис
[Public(WebApiRequestType = RequestType.Post)]
public virtual long CreateFreeApprovalTask(long documentId, string text, DateTime? deadline, List<long> approverIds)
Параметры
documentId – ИД согласуемого документа;
text – Текст задачи;
deadline – Срок задачи;
approverIds – Список ИД согласующих.
Возвращаемое значение
long – ИД созданной задачи.
CreateSignatureSettingWithFormalizedPoA
Создать право подписи с электронной доверенностью.
Синтаксис
[Public(WebApiRequestType = RequestType.Post)]
public virtual long CreateSignatureSettingWithFormalizedPoA(long employeeId, long documentId, long certificateId)
Параметры
employeeId – Ид сотрудника;
documentId – Ид документа;
certificateId – Ид сертификата.
Возвращаемое значение
long – Ид права подписи.
Создать простую задачу.
Синтаксис
[Public(WebApiRequestType = RequestType.Post)]
public virtual long CreateSimpleTask(string assignmentType, string subject, DateTime? deadline, string importance, string text, List<long> performerIds, List<long> observerIds, List<long> documentIds)
Параметры
assignmentType – Тип задания. Возможные значения: Assignment (Задание), Notice (Уведомление);
subject – Тема задачи;
deadline – Срок задачи;
importance – Важность;
text – Текст задачи;
performerIds – Список ИД исполнителей;
observerIds – Список ИД наблюдателей;
documentIds – ИД документов.
Возвращаемое значение
long – ИД созданной задачи.
Создать версию из шаблона.
Синтаксис
[Public(WebApiRequestType = RequestType.Post)]
public void CreateVersionFromTemplate(long documentId, long templateId)
Параметры
documentId – ИД документа;
templateId – ИД шаблона.
Согласовать документ.
Синтаксис
[Public(WebApiRequestType = RequestType.Post)]
public virtual void EndorseDocument(long documentId, string note)
Параметры
documentId – ИД документа;
note – Комментарий.
Проверить, что у папки есть содержимое.
Синтаксис
[Public(WebApiRequestType = RequestType.Get)]
public virtual bool FolderHasContent(long folderId)
Параметры
folderId – ИД папки.
Возвращаемое значение
bool – True, если папка содержит какие-то объекты, иначе - false.
Получить токен к Ario.
Синтаксис
[Public(WebApiRequestType = RequestType.Get)]
public static string GetArioToken()
Возвращаемое значение
string – Токен.
Получить адрес сервиса Ario.
Синтаксис
[Public(WebApiRequestType = RequestType.Get)]
public static string GetArioUrl()
Возвращаемое значение
string – Адрес сервиса Ario.
Получить текущее наименование культуры.
Синтаксис
[Public(WebApiRequestType = RequestType.Get)]
public string GetCurrentCultureName()
Возвращаемое значение
string – Текущее наименование культуры.
Получить вид документа в шаблонах по guid.
Виды документов ищутся по связке (guid экземпляра, id записи) в ExternalLink.
Синтаксис
[Public(WebApiRequestType = RequestType.Get)]
public virtual long GetDocumentKindIdByGuid(Guid documentType, Guid kindGuid)
Параметры
documentType – Тип документа;
kindGuid – Guid вида документа, заданный при инициализации.
Возвращаемое значение
long – ИД вида документа.
Получить папку "Избранные" заданного сотрудника.
Синтаксис
[Public(WebApiRequestType = RequestType.Get)]
public virtual long GetEmployeeFavoritesFolderId(long employeeId)
Параметры
employeeId – ИД сотрудника.
Возвращаемое значение
long – ИД папки.
Получить папку по названию.
Синтаксис
[Public(WebApiRequestType = RequestType.Get)]
public virtual long? GetFolderIdByName(string folderName)
Параметры
folderName – Наименование папки.
Возвращаемое значение
long? – ИД папки или Null, если папки с таким названием не существует.
Получить список Guid видов документов шаблона в виде строки.
Синтаксис
[Public(WebApiRequestType = RequestType.Get)]
public string GetTemplateDocumentKindsGuids(long id)
Параметры
id – ИД шаблона.
Возвращаемое значение
string – Список Guid в виде строки.
Получить хэш последней версии шаблона.
Синтаксис
[Public(WebApiRequestType = RequestType.Get)]
public string GetTemplateHash(long id)
Параметры
id – ИД шаблона.
Возвращаемое значение
string – Хэш последней версии.
Выдать права на документ.
Синтаксис
[Public(WebApiRequestType = RequestType.Post)]
public virtual void GrantAccessRightsToDocument(long documentId, long recipientId, string accessRightsTypeGuid)
Параметры
documentId – ИД документа;
recipientId – ИД получателя прав;
accessRightsTypeGuid – Guid типа прав.
Выдать права на папку.
Синтаксис
[Public(WebApiRequestType = RequestType.Post)]
public virtual void GrantAccessRightsToFolder(long folderId, long recipientId, string accessRightsTypeGuid)
Параметры
folderId – ИД папки;
recipientId – ИД получателя прав;
accessRightsTypeGuid – Guid типа прав.
ImportFormalizedPoABodyAndSign
Импортировать xml фаил эл. доверенности и подпись в новую версию документа.
Синтаксис
[Public(WebApiRequestType = RequestType.Post)]
public virtual void ImportFormalizedPoABodyAndSign(long documentId, string xmlDataBase64, string signatureDataBase64)
Параметры
documentId – Ид документа;
xmlDataBase64 – Содержимое XML фаила доверенности в формате Base64;
signatureDataBase64 – Содержимое фаила подписи в формате Base64.
IndexDocumentsForFullTextSearch
Выполнить индексацию документа для полнотекстового поиска.
Синтаксис
[Public(WebApiRequestType = RequestType.Post)]
public virtual void IndexDocumentsForFullTextSearch(long documentId)
Параметры
documentId – ИД документа для индексации.
Зарегистрировать документ.
Синтаксис
[Public(WebApiRequestType = RequestType.Post)]
public virtual void RegisterDocument(long documentId, long documentRegisterId, DateTime? registrationDate, string registrationNumber, bool? numberReservation)
Параметры
documentId – ИД документа;
documentRegisterId – ИД журнала;
registrationDate – Дата;
registrationNumber – Номер регистрации;
numberReservation – Признак резервирования.
Задать основные настройки поступления документов.
Синтаксис
[Public(WebApiRequestType = RequestType.Post)]
public static void SetSmartProcessingSettings(string arioUrl, string lowerConfidenceLimit, string upperConfidenceLimit, string firstPageClassifierName, string typeClassifierName)
Параметры
arioUrl – Адрес Арио;
lowerConfidenceLimit – Нижняя граница доверия извлеченным фактам;
upperConfidenceLimit – Верхняя граница доверия извлеченным фактам;
firstPageClassifierName – Имя классификатора первых страниц;
typeClassifierName – Имя классификатора по типам документов.
Стартовать задачу.
Синтаксис
[Public(WebApiRequestType = RequestType.Post)]
public virtual void StartTask(long taskId)
Параметры
taskId – ИД задачи.
Попытаться зарегистрировать документ с настройками по умолчанию.
Синтаксис
[Public(WebApiRequestType = RequestType.Get)]
public virtual bool TryExternalRegisterDocument(long documentId, string number, DateTime? date)
Параметры
documentId – ИД документа;
number – Номер;
date – Дата.
Возвращаемое значение
bool – True, если регистрация была выполнена.
| © Компания Directum, 2024 |