Russian (Русский) - Change language

Методы программного интерфейса

С помощью методов программного интерфейса осуществляется управление Сервером Приложений.

Сессии Проекты Типы пакета
Пакеты Задания Документы
Страницы Мандаты лицензирования Пользователи
Файлы Приложения Журнал
Определения документов Запросы к серверу Прочее

Сессии

CloseSession Закрыть сессию
GetSessionInfo Получить информацию о сессии
IsSessionExists Проверить существование сессии
OpenSession Открыть сессию подключения с указанием типов роли и станции

Проекты

CloseProject Закрыть проект
GetProjects Получить список проектов, загруженных на Сервер Приложений
GetProjectsForUser Получить список проектов, к которым пользователю предоставлен доступ
OpenProject Открыть проект

Типы пакета

GetAllowedBatchTypes Получить список доступных типов пакета
GetBatchType Получить информацию о типе пакета
GetBatchTypes Получить список типов пакета
GetProcessingStages Получить список этапов обработки
HasRightsForBatchType Проверить права доступа роли пользователя к типу пакета

Пакеты

AddNewBatch Добавить новый пакет
AddNewImage Добавить в пакет изображение
CloseBatch Закрыть (разблокировать) пакет
DeleteBatch Удалить пакет
GetBatch Получить информацию о пакете
GetBatches Получить информацию обо всех пакетах проекта
GetBatchIdsRange Зарезервировать набор идентификаторов внутри пакета
GetBatchPercentCompleted Получить информацию об обработке пакета
GetFilteredBatches Запросить отфильтрованный набор пакетов с сервера
OpenBatch Открыть (заблокировать) пакет
ProcessBatch Запустить обработку пакета
UpdateBatch Изменить заголовок пакета

Задания

CancelTask Прекратить выполнение задания
CloseTask Закрыть обработанное задание. Позволяет принудительно отправить документы задания на выбранный этап
CreateTask Создать задание
GetAvailableTasks Получить список доступных заданий на этапах обработки указанного типа
GetAvailableTasksByStageId Получить список доступных заданий на указанных этапах обработки
GetAvailableQueues Получить набор записей о доступных пользователю этапах обработки
GetCurrentTask Получить идентификатор задания, полученного с помощью метода GetTask и еще не обработанного.
GetPostponedTasks Получить список отложенных заданий
GetTask Выбрать наиболее приоритетное задание на этапах указанного типа и открыть его для обработки
GetTaskByStageId Выбрать наиболее приоритетное задание на указанных этапах и открыть его для обработки
GetTaskDocuments Получить список документов задания
GetTaskInfo Получить информацию о задании
OpenTask Открыть задание
PostponeTask Отложить выполнение задания
SendTask Отправить задание на указанный этап обработки
SendTaskToException Отправить задание в Исключения
SetTaskPriority Изменить приоритет задания

Документы

AddNewDocument Добавить новый документ
AddNewImage Добавить в пакет изображение
DeleteDocument Удалить документ
GetDocument Получить информацию о документе
GetDocumentResultsList Получить список файлов, в которые были экспортированы результаты обработки документа
GetDocuments Получить список документов в пакете
LoadDocumentResult Получить файл, в который были экспортированы результаты обработки документа
SetDocumetnProperties Указать регистрационные параметры документа
SetDocumentPriority Изменить приоритет документа

Страницы

AddNewPage Добавить в документ изображение страницы
DeletePage Удалить страницу документа
ReplacePageImage Заменить изображение страницы документа

Мандаты лицензирования

GetNewTicket Получить новый мандат
ReleaseTicket Освободить мандат
UpdateTicket Обновить состояние мандата

Пользователи

AddUserIfNotExist Получить идентификатор текущего пользователя, при необходимости - создать запись в базе данных
FindUser Получить идентификатор пользователя с указанным именем
GetAvailableQueues Получить набор записей о доступных пользователю этапах обработки
GetAvailableUsers Получить список пользователей/групп, которые могут обрабатывать указанный этап обработки
GetProjectsForStationType Получить проекты, на которые у указанного пользователя есть хотя бы одна из ролей, привязанных к указанному типу станции
GetProjectsForUser Получить список проектов, к которым пользователю предоставлен доступ
GetRoles Получить список всех ролей в проекте
GetUser Получить информацию о пользователе по идентификатору
GetUserRoles Получить список идентификаторов ролей, доступных текущему пользователю в данном проекте
GetUsers Получить список пользователей
GetUserStatistics Получить набор записей о числе пакетов, документов и страниц, состояние которых изменилось на "обработанные" за указанный период времени.
HasRightsForBatchType Проверить права доступа роли пользователя к типу пакета

Файлы

GetCustomFileNames Получить список пользовательских файлов, хранящихся на Сервере Приложений
LoadCustomFile Загрузить пользовательский файл с Сервера Приложений
RemoveCustomFile Удалить пользовательский файл с Сервера Приложений
SaveCustomFile Сохранить пользовательский файл на Сервере Приложений

Приложения

GetAttachmentNames Получить список приложений
LoadAttachment Загрузить приложение
RemoveAttachment Удалить приложение
SaveAttachment Добавить приложение

Определения документов

GetTemplates Получить список определений документов в проекте
GetBatchTypeTemplates Возвращает список идентификаторов определений документов, прикрепленных к типу пакета

Журнал

WriteToLog Записать в журнал Сервера Приложений информацию о событиях

Запросы к Серверу Приложений

CreateRequest Создать запрос к Серверу Приложений
DeleteRequest Удалить запрос к Серверу Приложений
GetRequests Получить список запросов текущей сессии к Серверу Приложений
GetRequestStatus Получить статус запроса к Серверу Приложений
SetRequestStatus Изменить статус запроса к Серверу Приложений

Прочее

GetSettingValue Получить из базы данных именованный параметр
SetSettingValue Сохранить в базе данных именованный параметр

12/1/2020 7:04:04 AM


Please leave your feedback about this article