Japanese (日本語) - Change language

API メソッド

アプリケーションサーバーの制御に使用されるAPI方法。

セッション プロジェクト バッチ型
バッチ タスク 文書
ページ ライセンスチケット ユーザー
ファイル 添付 ログ
文書定義 サーバー要求 その他

セッション

CloseSession セッションを閉じます
GetSessionInfo セッションに関する情報を取得します
IsSessionExists セッションが存在するかを確認します
OpenSession セッションを開き、ロール型とステーションを指定します

プロジェクト

CloseProject プロジェクトを閉じます
GetProjects アプリケーションサーバーに読み込まれたプロジェクトのリストを取得します
GetProjectsForUser ユーザーに使用可能なプロジェクトをリスト化する記録のセットを取得します
OpenProject プロジェクトを開きます

バッチ型

GetAllowedBatchTypes 使用可能なバッチ型のリストを取得します。
GetBatchType バッチ型に関する情報を取得します
GetBatchTypes バッチ型のリストを取得します
GetProcessingStages 処理段階に関する詳細情報を取得します
HasRightsForBatchType ユーザーロールが特定のバッチ型へのアクセス権限を持っているかを確認します

バッチ

AddNewBatch 新しいバッチを追加してその所有者を指定します
AddNewImage 画像をバッチに追加します
CloseBatch バッチを閉じます (ロック解除)
DeleteBatch バッチを削除します
GetBatch バッチに関する情報を取得します
GetBatches プロジェクトのバッチに関する情報を取得します
GetBatchIdsRange バッチのIDのセットを予約します
GetBatchPercentCompleted バッチの処理に関する情報を取得します
GetFilteredBatches サーバーからバッチのフィルタ処理されたリストをグループで取得します
OpenBatch バッチを開きます (ロック)
ProcessBatch バッチ処理を開始します
UpdateBatch バッチのヘッダーを更新します

タスク

CancelTask タスクをキャンセルします
CloseTask タスクを閉じます
CreateTask タスクを作成します
GetAvailableTasks 選択された段階型で使用可能なタスクのリストを取得します。使用可能なバッチのセットを制限することを許可します。
GetAvailableTasksByStageId 指定された処理段階で使用可能なタスクのリストを取得します。使用可能なバッチのセットを制限することを許可します
GetAvailableQueues ユーザーに使用可能な処理段階をリストする記録のセットを取得します
GetCurrentTask GetTask方法で取得された未処理状態のタスクのIDを取得します
GetPostponedTasks 延期されたタスクのリストを取得します
GetTask 選択された型の処理段階で優先度が最高のタスクを選択し、処理のために開きます。使用可能なバッチのセットを制限することを許可します。
GetTaskByStageId 指定された処理段階で優先度が最高のタスクを選択し、処理のために開きます。
GetTaskDocuments タスクの文書リストを取得します
GetTaskInfo タスクに関する詳細情報を取得します
OpenTask タスクを開きます
PostponeTask タスクを延期します
SendTask タスクを指定された処理段階に送信します
SendTaskToException タスクを例外に送信します
SetTaskPriority タスクの優先度を変更します

文書

AddNewDocument 新しい文書を追加して追加情報を指定します
AddNewImage 画像をバッチに追加します
DeleteDocument 文書を削除します
GetDocument 文書に関する情報を取得します
GetDocumentResultsList 文書処理結果がエクスポートされたファイルのリストを取得します
GetDocuments バッチの文書リストを取得します
LoadDocumentResult 文書処理結果をエクスポートしたファイルを取得します
SetDocumentProperties 文書の登録パラメータを指定します
SetDocumentPriority 文書の優先度を変更します

ページ

AddNewPage 文書にページ画像を追加して記述を含めます
DeletePage 文書からページを削除します
ReplacePageImage ページ画像を置き換えます

ライセンスチケット

GetNewTicket 新しいライセンスチケットを取得します
ReleaseTicket ライセンスチケットを発行します
UpdateTicket ライセンスチケットのステータスを更新します

ユーザー

AddUserIfNotExist 必要に応じて現在のユーザーのIDを取得し、データベース記録を作成します
FindUser ユーザーIDとユーザー名を取得します
GetAvailableQueues ユーザーに使用可能な処理段階をリストする記録のセットを取得します
GetAvailableUsers 指定した段階の処理を許可されているユーザーまたはグループのリストを取得します
GetProjectsForStationType ユーザーが特定の型のステーションに関連付けられた少なくとも1つのロールを持つプロジェクトを検索します
GetProjectsForUser ユーザーに使用可能なプロジェクトをリスト化する記録のセットを取得します
GetRoles プロジェクトのすべてのロールのリストを取得します
GetUser ユーザーIDに基づいてユーザーに関する情報を取得します
GetUserRoles 所与のプロジェクトで現在のユーザーが使用できるユーザーロールのIDのリストを取得します
GetUsers ユーザーのリストを取得します
GetUserStatistics 所与の期間に状態が「処理済み」に変わったバッチ、文書、ページの数をリスト化する記録のセットを取得します
HasRightsForBatchType ユーザーロールが特定のバッチ型へのアクセス権限を持っているかを確認します

ファイル

GetCustomFileNames アプリケーションサーバーで保存されるユーザーファイルのリストを取得します
LoadCustomFile ユーザーファイルをアプリケーションサーバーから読み込みます
RemoveCustomFile ユーザーファイルをアプリケーションサーバーから削除します
SaveCustomFile ユーザーファイルをアプリケーションサーバーで保存します

添付

GetAttachmentNames アプリケーションサーバーで添付のリストを入手します
LoadAttachment アプリケーションサーバーから添付を読み込みます
RemoveAttachment アプリケーションサーバーから添付を削除します
SaveAttachment アプリケーションサーバーで添付を保存します

文書定義

GetTemplates プロジェクトの文書定義のセットを取得します
GetBatchTypeTemplates バッチ型に添付されている文書定義の識別子のセットを返します

ログ

WriteToLog イベントに関する情報をアプリケーションサーバーのログに書き込みます

サーバー要求

CreateRequest アプリケーションサーバーへの要求を作成します
DeleteRequest アプリケーションサーバーへの要求を削除します。
GetRequests 現在のセッションでアプリケーションサーバーへの要求リストを取得します
GetRequestStatus アプリケーションサーバーへの要求ステータスを取得します
SetRequestStatus アプリケーションサーバーへの要求ステータスを変更します

その他

GetSettingValue 名前付きパラメータをデータベースから取得します
SetSettingValue 名前付きパラメータをデータベースに保存します

11/10/2020 12:08:06 PM


Please leave your feedback about this article