> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API メソッド

> ABBYY FlexiCapture Web Services API の全メソッドを参照できます。メソッドは、セッション、プロジェクト、バッチ、タスク、ドキュメント、ページ、ユーザー、ファイルなどのカテゴリ別に分類されています。

API メソッドは、Application Server の制御に使用します。

| [セッション](/ja/flexi-capture/api/methods/methods#sessions)  | [プロジェクト](/ja/flexi-capture/api/methods/methods#projects)           | [バッチタイプ](/ja/flexi-capture/api/methods/methods#batchtypes)   |
| -------------------------------------------------------- | ------------------------------------------------------------------ | ------------------------------------------------------------ |
| [Batches](/ja/flexi-capture/api/methods/methods#batches) | [タスク](/ja/flexi-capture/api/methods/methods#tasks)                 | [documents](/ja/flexi-capture/api/methods/methods#documents) |
| [ページ](/ja/flexi-capture/api/methods/methods#pages)       | [ライセンス チケット](/ja/flexi-capture/api/methods/methods#tickets)        | [ユーザー](/ja/flexi-capture/api/methods/methods#users)          |
| [ファイル](/ja/flexi-capture/api/methods/methods#files)      | [添付ファイル](/ja/flexi-capture/api/methods/methods#attachments)        | [ログ](/ja/flexi-capture/api/methods/methods#log)              |
| [Document Definitions](#templates)                       | [サーバー リクエスト](/ja/flexi-capture/api/methods/methods#serverrequests) | [その他](/ja/flexi-capture/api/methods/methods#other)           |

## <a id="sessions" />セッション

| [CloseSession](/ja/flexi-capture/api/methods/close-session)        | セッションを閉じます                   |
| ------------------------------------------------------------------ | ---------------------------- |
| [GetSessionInfo](/ja/flexi-capture/api/methods/get-session-info)   | セッション情報を取得します                |
| [IsSessionExists](/ja/flexi-capture/api/methods/is-session-exists) | セッションが存在するかどうかを確認します         |
| [OpenSession](/ja/flexi-capture/api/methods/open-session)          | セッションを開き、ロールの種類とステーションを指定します |

## <a id="projects" />プロジェクト

| [CloseProject](/ja/flexi-capture/api/methods/close-project)               | プロジェクトを閉じます                                  |
| ------------------------------------------------------------------------- | -------------------------------------------- |
| [GetProjects](/ja/flexi-capture/api/methods/get-projects)                 | Application Server にロードされているプロジェクトのリストを取得します |
| [GetProjectsForUser](/ja/flexi-capture/api/methods/get-projects-for-user) | ユーザーが利用可能なプロジェクトの一覧を含むレコードのセットを取得します         |
| [OpenProject](/ja/flexi-capture/api/methods/open-project)                 | プロジェクトを開きます                                  |

## <a id="batchtypes" />バッチタイプ

| [GetAllowedBatchTypes](/ja/flexi-capture/api/methods/get-allowed-batch-types)    | 利用可能なバッチタイプの一覧を取得します                   |
| -------------------------------------------------------------------------------- | -------------------------------------- |
| [GetBatchType](/ja/flexi-capture/api/methods/get-batchtype)                      | バッチタイプの情報を取得します                        |
| [GetBatchTypes](/ja/flexi-capture/api/methods/get-batch-types)                   | バッチタイプの一覧を取得します                        |
| [GetProcessingStages](/ja/flexi-capture/api/methods/get-processing-stages)       | 処理ステージの詳細情報を取得します                      |
| [HasRightsForBatchType](/ja/flexi-capture/api/methods/has-rights-for-batch-type) | ユーザーロールに特定のバッチタイプへのアクセス権限があるかどうかを確認します |

## <a id="batches" />Batches

| [AddNewBatch](/ja/flexi-capture/api/methods/add-new-batch)                            | 新しいバッチを追加し、その所有者を指定します                 |
| ------------------------------------------------------------------------------------- | -------------------------------------- |
| [AddNewImage](/ja/flexi-capture/api/methods/add-new-image)                            | バッチに画像を追加します                           |
| [CloseBatch](/ja/flexi-capture/api/methods/close-batch)                               | バッチを閉じます (ロックを解除します)                   |
| [DeleteBatch](/ja/flexi-capture/api/methods/delete-batch)                             | バッチを削除します                              |
| [GetBatch](/ja/flexi-capture/api/methods/get-batch)                                   | バッチの情報を取得します                           |
| [GetBatches](/ja/flexi-capture/api/methods/get-batches)                               | プロジェクト内のBatches情報を取得します                |
| [GetBatchIdsRange](/ja/flexi-capture/api/methods/get-batch-ids-range)                 | バッチ内の一連の ID を予約します                     |
| [GetBatchPercentCompleted](/ja/flexi-capture/api/methods/get-batch-percent-completed) | バッチの処理状況に関する情報を取得します                   |
| [GetFilteredBatches](/ja/flexi-capture/get-filtered-batches)                          | サーバーから、フィルターされたBatchesの一覧をグループ単位で取得します |
| [OpenBatch](/ja/flexi-capture/api/methods/open-batch)                                 | バッチを開きます (ロックします)                      |
| [ProcessBatch](/ja/flexi-capture/api/methods/process-batch)                           | バッチの処理を開始します                           |
| [UpdateBatch](/ja/flexi-capture/api/methods/update-batch)                             | バッチのヘッダー情報を更新します                       |

## <a id="tasks" />タスク

| [CancelTask](/ja/flexi-capture/api/methods/cancel-task)                                     | タスクをキャンセルします                                                                       |
| ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| [CloseTask](/ja/flexi-capture/api/methods/close-task)                                       | タスクを閉じます                                                                           |
| [CreateTask](/ja/flexi-capture/api/methods/create-task)                                     | タスクを作成します                                                                          |
| [GetAvailableTasks](/ja/flexi-capture/api/methods/get-available-tasks)                      | 選択したステージタイプで利用可能なタスクの一覧を取得します。利用可能なBatchesのセットを制限できます。                             |
| [GetAvailableTasksByStageId](/ja/flexi-capture/api/methods/get-available-tasks-by-stage-id) | 指定した処理ステージで利用可能なタスクの一覧を取得します。利用可能なBatchesのセットを制限できます                               |
| [GetAvailableQueues](/ja/flexi-capture/api/methods/get-available-queues)                    | ユーザーが利用可能な処理ステージを列挙したレコードのセットを取得します                                                |
| [GetCurrentTask](/ja/flexi-capture/api/methods/get-current-task)                            | [GetTask](/ja/flexi-capture/api/methods/get-task) メソッドで取得され、まだ処理されていないタスクのIDを取得します |
| [GetPostponedTasks](/ja/flexi-capture/api/methods/get-postponed-tasks)                      | 保留されたタスクの一覧を取得します                                                                  |
| [GetTask](/ja/flexi-capture/api/methods/get-task)                                           | 選択した型の処理ステージで最も優先度の高いタスクを選択し、処理用に開きます。利用可能なBatchesのセットを制限できます。                     |
| [GetTaskByStageId](/ja/flexi-capture/api/methods/get-task-by-stage-id)                      | 指定した処理ステージで最も優先度の高いタスクを選択し、処理用に開きます                                                |
| [GetTaskDocuments](/ja/flexi-capture/api/methods/get-task-documents)                        | タスク内のドキュメントの一覧を取得します                                                               |
| [GetTaskInfo](/ja/flexi-capture/api/methods/get-task-info)                                  | タスクに関する詳細情報を取得します                                                                  |
| [OpenTask](/ja/flexi-capture/api/methods/open-task)                                         | タスクを開きます                                                                           |
| [PostponeTask](/ja/flexi-capture/api/methods/postpone-task)                                 | タスクを保留します                                                                          |
| [SendTask](/ja/flexi-capture/api/methods/send-task)                                         | タスクを指定した処理ステージに送信します                                                               |
| [SendTaskToException](/ja/flexi-capture/api/methods/send-task-to-exception)                 | タスクをExceptionsに送信します                                                               |
| [SetTaskPriority](/ja/flexi-capture/api/methods/set-task-priority)                          | タスクの優先度を変更します                                                                      |

## <a id="documents" />documents

| [AddNewDocument](/ja/flexi-capture/api/methods/add-new-document)               | 新しいドキュメントを追加し、追加情報を指定します    |
| ------------------------------------------------------------------------------ | --------------------------- |
| [AddNewImage](/ja/flexi-capture/api/methods/add-new-image)                     | バッチに画像を追加します                |
| [DeleteDocument](/ja/flexi-capture/api/methods/delete-document)                | ドキュメントを削除します                |
| [GetDocument](/ja/flexi-capture/api/methods/get-document)                      | ドキュメントに関する情報を取得します          |
| [GetDocumentResultsList](/ja/flexi-capture/get-document-results-list)          | 文書処理結果のエクスポート先ファイルの一覧を取得します |
| [GetDocuments](/ja/flexi-capture/api/methods/get-documents)                    | バッチ内のドキュメント一覧を取得します         |
| [LoadDocumentResult](/ja/flexi-capture/api/methods/load-document-result)       | 文書処理結果のエクスポート先ファイルを取得します    |
| [SetDocumentProperties](/ja/flexi-capture/api/methods/set-document-properties) | ドキュメントの登録パラメータを指定します        |
| [SetDocumentPriority](/ja/flexi-capture/api/methods/set-document-priority)     | ドキュメントの優先度を変更します            |

## <a id="pages" />ページ

| [AddNewPage](/ja/flexi-capture/api/methods/add-new-page)             | ドキュメントにページ画像を追加し、説明も含めます |
| -------------------------------------------------------------------- | ------------------------ |
| [DeletePage](/ja/flexi-capture/api/methods/delete-page)              | ドキュメントからページを削除します        |
| [ReplacePageImage](/ja/flexi-capture/api/methods/replace-page-image) | ページ画像を置き換えます             |

## <a id="tickets" />ライセンス チケット

| [GetNewTicket](/ja/flexi-capture/api/methods/get-new-ticket)  | 新しいライセンス チケットを取得します    |
| ------------------------------------------------------------- | ---------------------- |
| [ReleaseTicket](/ja/flexi-capture/api/methods/release-ticket) | ライセンス チケットを解放します       |
| [UpdateTicket](/ja/flexi-capture/api/methods/update-ticket)   | ライセンス チケットのステータスを更新します |

## <a id="users" />ユーザー

| [AddUserIfNotExist](/ja/flexi-capture/api/methods/add-user-if-not-exist)         | 現在のユーザーのIDを取得し、必要に応じてデータベースレコードを作成します                         |
| -------------------------------------------------------------------------------- | ------------------------------------------------------------- |
| [FindUser](/ja/flexi-capture/api/methods/find-user)                              | ユーザーIDとユーザー名を取得します                                            |
| [GetAvailableQueues](/ja/flexi-capture/api/methods/get-available-queues)         | ユーザーが利用可能な処理ステージの一覧を含むレコードセットを取得します                           |
| [GetAvailableUsers](/ja/flexi-capture/api/methods/get-available-users)           | 指定したステージを処理できるユーザーまたはグループの一覧を取得します                            |
| [GetProjectsForStationType](/ja/flexi-capture/get-projects-for-station-type)     | ユーザーが特定のステーションタイプに関連付けられたロールを少なくとも1つ持つプロジェクトを検索します            |
| [GetProjectsForUser](/ja/flexi-capture/api/methods/get-projects-for-user)        | ユーザーが利用可能なプロジェクトの一覧を含むレコードセットを取得します                           |
| [GetRoles](/ja/flexi-capture/api/methods/get-roles)                              | プロジェクト内のすべてのロールの一覧を取得します                                      |
| [GetUser](/ja/flexi-capture/api/methods/get-user)                                | ユーザーIDに基づいてユーザー情報を取得します                                       |
| [GetUserRoles](/ja/flexi-capture/api/methods/get-user-roles)                     | 指定したプロジェクトで現在のユーザーが利用可能なユーザーロールのID一覧を取得します                    |
| [GetUsers](/ja/flexi-capture/api/methods/get-users)                              | ユーザーの一覧を取得します                                                 |
| [GetUserStatistics](/ja/flexi-capture/api/methods/get-user-statistics)           | 指定した期間内に状態が「処理完了」に変わったBatches、ドキュメント、ページの数の一覧を含むレコードセットを取得します |
| [HasRightsForBatchType](/ja/flexi-capture/api/methods/has-rights-for-batch-type) | ユーザーロールが特定のバッチタイプに対するアクセス権限を持っているかどうかを確認します                   |

## <a id="files" />ファイル

| [GetCustomFileNames](/ja/flexi-capture/api/methods/get-custom-file-names) | Application Server に保存されているユーザーファイルの一覧を取得します |
| ------------------------------------------------------------------------- | -------------------------------------------- |
| [LoadCustomFile](/ja/flexi-capture/api/methods/load-custom-file)          | Application Server からユーザーファイルをロードします         |
| [RemoveCustomFile](/ja/flexi-capture/api/methods/remove-custom-file)      | Application Server からユーザーファイルを削除します          |
| [SaveCustomFile](/ja/flexi-capture/api/methods/save-custom-file)          | Application Server にユーザーファイルを保存します           |

## <a id="attachments" />添付ファイル

| [GetAttachmentNames](/ja/flexi-capture/api/methods/get-attachment-names) | Application Server上の添付ファイルの一覧を取得します |
| ------------------------------------------------------------------------ | ----------------------------------- |
| [LoadAttachment](/ja/flexi-capture/api/methods/load-attachment)          | Application Serverから添付ファイルをロードします   |
| [RemoveAttachment](/ja/flexi-capture/api/methods/remove-attachment)      | Application Serverから添付ファイルを削除します    |
| [SaveAttachment](/ja/flexi-capture/api/methods/save-attachment)          | Application Serverに添付ファイルを保存します     |

## <a id="templates" />Document Definitions

| [GetTemplates](/ja/flexi-capture/api/methods/get-templates)                     | プロジェクトのDocument Definitions一式を取得します           |
| ------------------------------------------------------------------------------- | --------------------------------------------- |
| [GetBatchTypeTemplates](/ja/flexi-capture/api/methods/get-batch-type-templates) | バッチタイプにアタッチされたDocument Definitionsの識別子一式を返します |

## <a id="log" />ログ

| [WriteToLog](/ja/flexi-capture/api/methods/write-to-log) | Application Server のログにイベント情報を書き込みます |
| -------------------------------------------------------- | ------------------------------------ |

## <a id="serverrequests" />サーバー リクエスト

| [CreateRequest](/ja/flexi-capture/api/methods/create-request-api-methods) | Application Server への要求を作成します                 |
| ------------------------------------------------------------------------- | --------------------------------------------- |
| [DeleteRequest](/ja/flexi-capture/api/methods/delete-request)             | Application Server への要求を削除します。                |
| [GetRequests](/ja/flexi-capture/api/methods/get-requests)                 | 現在のセッションにおける Application Server への要求の一覧を取得します |
| [GetRequestStatus](/ja/flexi-capture/api/methods/get-request-status)      | Application Server への要求のステータスを取得します           |
| [SetRequestStatus](/ja/flexi-capture/api/methods/set-request-status)      | Application Server への要求のステータスを変更します           |

## <a id="other" />その他

| [GetSettingValue](/ja/flexi-capture/api/methods/get-setting-value) | データベースから指定した名前のパラメーターを取得します |
| ------------------------------------------------------------------ | --------------------------- |
| [SetSettingValue](/ja/flexi-capture/api/methods/set-setting-value) | 指定した名前のパラメーターをデータベースに保存します  |