> ## 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-Methoden

> Durchsuchen Sie die vollständige Liste der Methoden der ABBYY FlexiCapture Web Services API, gruppiert nach Sitzungen, Projekten, Batches, Aufgaben, Dokumenten, Seiten, Benutzern, Dateien und mehr.

API-Methoden dienen zur Steuerung des Application Server.

| [Sitzungen](/de/flexi-capture/api/methods/methods#sessions) | [Projekte](/de/flexi-capture/api/methods/methods#projects)             | [Batch Types](/de/flexi-capture/api/methods/methods#batchtypes) |
| ----------------------------------------------------------- | ---------------------------------------------------------------------- | --------------------------------------------------------------- |
| [Batches](/de/flexi-capture/api/methods/methods#batches)    | [Aufgaben](/de/flexi-capture/api/methods/methods#tasks)                | [documents](/de/flexi-capture/api/methods/methods#documents)    |
| [Seiten](/de/flexi-capture/api/methods/methods#pages)       | [Lizenztickets](/de/flexi-capture/api/methods/methods#tickets)         | [Benutzer](/de/flexi-capture/api/methods/methods#users)         |
| [Dateien](/de/flexi-capture/api/methods/methods#files)      | [Anhänge](/de/flexi-capture/api/methods/methods#attachments)           | [Protokoll](/de/flexi-capture/api/methods/methods#log)          |
| [Dokumentdefinitionen](#templates)                          | [Serveranfragen](/de/flexi-capture/api/methods/methods#serverrequests) | [Sonstiges](/de/flexi-capture/api/methods/methods#other)        |

## <a id="sessions" />Sitzungen

| [CloseSession](/de/flexi-capture/api/methods/close-session)        | Schließt eine Sitzung                                             |
| ------------------------------------------------------------------ | ----------------------------------------------------------------- |
| [GetSessionInfo](/de/flexi-capture/api/methods/get-session-info)   | Ruft Informationen zu einer Sitzung ab                            |
| [IsSessionExists](/de/flexi-capture/api/methods/is-session-exists) | Prüft, ob eine Sitzung existiert                                  |
| [OpenSession](/de/flexi-capture/api/methods/open-session)          | Öffnet eine Sitzung und legt die Rollentypen und die Station fest |

## <a id="projects" />Projekte

| [CloseProject](/de/flexi-capture/api/methods/close-project)               | Schließt ein Projekt                                                  |
| ------------------------------------------------------------------------- | --------------------------------------------------------------------- |
| [GetProjects](/de/flexi-capture/api/methods/get-projects)                 | Ruft eine Liste der auf den Application Server geladenen Projekte ab  |
| [GetProjectsForUser](/de/flexi-capture/api/methods/get-projects-for-user) | Ruft die Datensätze mit den für den Benutzer verfügbaren Projekten ab |
| [OpenProject](/de/flexi-capture/api/methods/open-project)                 | Öffnet ein Projekt                                                    |

## <a id="batchtypes" />Batch Types

| [GetAllowedBatchTypes](/de/flexi-capture/api/methods/get-allowed-batch-types)    | Ruft eine Liste der verfügbaren Batch-Typen ab                                        |
| -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| [GetBatchType](/de/flexi-capture/api/methods/get-batchtype)                      | Ruft Informationen zu einem Batch-Typ ab                                              |
| [GetBatchTypes](/de/flexi-capture/api/methods/get-batch-types)                   | Ruft eine Liste von Batch-Typen ab                                                    |
| [GetProcessingStages](/de/flexi-capture/api/methods/get-processing-stages)       | Ruft erweiterte Informationen zu Verarbeitungsstufen ab                               |
| [HasRightsForBatchType](/de/flexi-capture/api/methods/has-rights-for-batch-type) | Prüft, ob die Benutzerrolle Zugriffsberechtigungen für einen bestimmten Batch-Typ hat |

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

| [AddNewBatch](/de/flexi-capture/api/methods/add-new-batch)                            | Fügt einen neuen Batch hinzu und gibt dessen Besitzer an               |
| ------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| [AddNewImage](/de/flexi-capture/api/methods/add-new-image)                            | Fügt einem Batch ein Bild hinzu                                        |
| [CloseBatch](/de/flexi-capture/api/methods/close-batch)                               | Schließt einen Batch (entsperrt ihn)                                   |
| [DeleteBatch](/de/flexi-capture/api/methods/delete-batch)                             | Löscht einen Batch                                                     |
| [GetBatch](/de/flexi-capture/api/methods/get-batch)                                   | Ruft Informationen zu einem Batch ab                                   |
| [GetBatches](/de/flexi-capture/api/methods/get-batches)                               | Ruft Informationen zu Batches in einem Projekt ab                      |
| [GetBatchIdsRange](/de/flexi-capture/api/methods/get-batch-ids-range)                 | Reserviert eine Reihe von IDs in einem Batch                           |
| [GetBatchPercentCompleted](/de/flexi-capture/api/methods/get-batch-percent-completed) | Ruft Informationen zur Verarbeitung eines Batches ab                   |
| [GetFilteredBatches](/de/flexi-capture/get-filtered-batches)                          | Ruft die gefilterte Liste von Batches gruppenweise von einem Server ab |
| [OpenBatch](/de/flexi-capture/api/methods/open-batch)                                 | Öffnet einen Batch (sperrt ihn)                                        |
| [ProcessBatch](/de/flexi-capture/api/methods/process-batch)                           | Startet die Verarbeitung eines Batches                                 |
| [UpdateBatch](/de/flexi-capture/api/methods/update-batch)                             | Aktualisiert den Kopfbereich des Batches                               |

## <a id="tasks" />Aufgaben

| [CancelTask](/de/flexi-capture/api/methods/cancel-task)                                     | Bricht eine Aufgabe ab                                                                                                                                                                                |
| ------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [CloseTask](/de/flexi-capture/api/methods/close-task)                                       | Schließt eine Aufgabe                                                                                                                                                                                 |
| [CreateTask](/de/flexi-capture/api/methods/create-task)                                     | Erstellt eine Aufgabe                                                                                                                                                                                 |
| [GetAvailableTasks](/de/flexi-capture/api/methods/get-available-tasks)                      | Ruft die Liste der verfügbaren Aufgaben für den ausgewählten Verarbeitungsstufentyp ab. Ermöglicht es, die Auswahl der verfügbaren Batches einzuschränken.                                            |
| [GetAvailableTasksByStageId](/de/flexi-capture/api/methods/get-available-tasks-by-stage-id) | Ruft die Liste der verfügbaren Aufgaben für die angegebenen Verarbeitungsstufen ab. Ermöglicht es, die Auswahl der verfügbaren Batches einzuschränken                                                 |
| [GetAvailableQueues](/de/flexi-capture/api/methods/get-available-queues)                    | Ruft die Menge der Datensätze ab, in denen die für den Benutzer verfügbaren Verarbeitungsstufen aufgelistet sind                                                                                      |
| [GetCurrentTask](/de/flexi-capture/api/methods/get-current-task)                            | Ruft die ID der Aufgabe ab, die mit der Methode [GetTask](/de/flexi-capture/api/methods/get-task) abgerufen und noch nicht verarbeitet wurde                                                          |
| [GetPostponedTasks](/de/flexi-capture/api/methods/get-postponed-tasks)                      | Ruft eine Liste zurückgestellter Aufgaben ab                                                                                                                                                          |
| [GetTask](/de/flexi-capture/api/methods/get-task)                                           | Wählt die Aufgabe mit der höchsten Priorität in den Verarbeitungsstufen des ausgewählten Typs aus und öffnet sie zur Verarbeitung. Ermöglicht es, die Auswahl der verfügbaren Batches einzuschränken. |
| [GetTaskByStageId](/de/flexi-capture/api/methods/get-task-by-stage-id)                      | Wählt die Aufgabe mit der höchsten Priorität in den angegebenen Verarbeitungsstufen aus und öffnet sie zur Verarbeitung                                                                               |
| [GetTaskDocuments](/de/flexi-capture/api/methods/get-task-documents)                        | Ruft eine Liste der Dokumente in einer Aufgabe ab                                                                                                                                                     |
| [GetTaskInfo](/de/flexi-capture/api/methods/get-task-info)                                  | Ruft erweiterte Informationen zu einer Aufgabe ab                                                                                                                                                     |
| [OpenTask](/de/flexi-capture/api/methods/open-task)                                         | Öffnet eine Aufgabe                                                                                                                                                                                   |
| [PostponeTask](/de/flexi-capture/api/methods/postpone-task)                                 | Stellt eine Aufgabe zurück                                                                                                                                                                            |
| [SendTask](/de/flexi-capture/api/methods/send-task)                                         | Sendet die Aufgabe an die angegebene Verarbeitungsstufe                                                                                                                                               |
| [SendTaskToException](/de/flexi-capture/api/methods/send-task-to-exception)                 | Sendet eine Aufgabe an Exceptions                                                                                                                                                                     |
| [SetTaskPriority](/de/flexi-capture/api/methods/set-task-priority)                          | Ändert die Priorität der Aufgabe                                                                                                                                                                      |

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

| [AddNewDocument](/de/flexi-capture/api/methods/add-new-document)               | Fügt ein neues Dokument hinzu und legt zusätzliche Informationen fest                            |
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
| [AddNewImage](/de/flexi-capture/api/methods/add-new-image)                     | Fügt einem Batch ein Bild hinzu                                                                  |
| [DeleteDocument](/de/flexi-capture/api/methods/delete-document)                | Löscht ein Dokument                                                                              |
| [GetDocument](/de/flexi-capture/api/methods/get-document)                      | Ruft Informationen über ein Dokument ab                                                          |
| [GetDocumentResultsList](/de/flexi-capture/get-document-results-list)          | Ruft eine Liste der Dateien ab, in die die Ergebnisse der Dokumentverarbeitung exportiert wurden |
| [GetDocuments](/de/flexi-capture/api/methods/get-documents)                    | Ruft eine Liste der Dokumente in einem Batch ab                                                  |
| [LoadDocumentResult](/de/flexi-capture/api/methods/load-document-result)       | Ruft die Datei ab, in die die Ergebnisse der Dokumentverarbeitung exportiert wurden              |
| [SetDocumentProperties](/de/flexi-capture/api/methods/set-document-properties) | Legt Registrierungsparameter für ein Dokument fest                                               |
| [SetDocumentPriority](/de/flexi-capture/api/methods/set-document-priority)     | Ändert die Priorität eines Dokuments                                                             |

## <a id="pages" />Seiten

| [AddNewPage](/de/flexi-capture/api/methods/add-new-page)             | Fügt einem Dokument ein Seitenbild hinzu und enthält eine Beschreibung |
| -------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| [DeletePage](/de/flexi-capture/api/methods/delete-page)              | Löscht eine Seite aus einem Dokument                                   |
| [ReplacePageImage](/de/flexi-capture/api/methods/replace-page-image) | Ersetzt ein Seitenbild                                                 |

## <a id="tickets" />Lizenztickets

| [GetNewTicket](/de/flexi-capture/api/methods/get-new-ticket)  | Ruft ein neues Lizenzticket ab              |
| ------------------------------------------------------------- | ------------------------------------------- |
| [ReleaseTicket](/de/flexi-capture/api/methods/release-ticket) | Gibt ein Lizenzticket frei                  |
| [UpdateTicket](/de/flexi-capture/api/methods/update-ticket)   | Aktualisiert den Status eines Lizenztickets |

## <a id="users" />Benutzer

| [AddUserIfNotExist](/de/flexi-capture/api/methods/add-user-if-not-exist)         | Ruft die ID des aktuellen Benutzers ab und erstellt bei Bedarf einen Datenbankeintrag                                                          |
| -------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| [FindUser](/de/flexi-capture/api/methods/find-user)                              | Ruft die Benutzer-ID und den Benutzernamen ab                                                                                                  |
| [GetAvailableQueues](/de/flexi-capture/api/methods/get-available-queues)         | Ruft die Datensätze mit den dem Benutzer verfügbaren Verarbeitungsstufen ab                                                                    |
| [GetAvailableUsers](/de/flexi-capture/api/methods/get-available-users)           | Ruft eine Liste der Benutzer oder Gruppen ab, die eine angegebene Verarbeitungsstufe bearbeiten dürfen                                         |
| [GetProjectsForStationType](/de/flexi-capture/get-projects-for-station-type)     | Findet Projekte, in denen ein Benutzer mindestens eine Rolle hat, die einem bestimmten Stationstyp zugeordnet ist                              |
| [GetProjectsForUser](/de/flexi-capture/api/methods/get-projects-for-user)        | Ruft die Datensätze mit den dem Benutzer verfügbaren Projekten ab                                                                              |
| [GetRoles](/de/flexi-capture/api/methods/get-roles)                              | Ruft die Liste aller Rollen im Projekt ab                                                                                                      |
| [GetUser](/de/flexi-capture/api/methods/get-user)                                | Ruft anhand der Benutzer-ID Informationen über den Benutzer ab                                                                                 |
| [GetUserRoles](/de/flexi-capture/api/methods/get-user-roles)                     | Ruft die Liste der IDs der Benutzerrollen ab, die dem aktuellen Benutzer im angegebenen Projekt zur Verfügung stehen                           |
| [GetUsers](/de/flexi-capture/api/methods/get-users)                              | Ruft die Liste der Benutzer ab                                                                                                                 |
| [GetUserStatistics](/de/flexi-capture/api/methods/get-user-statistics)           | Ruft Datensätze mit der Anzahl der Batches, Dokumente und Seiten ab, deren Status in einem bestimmten Zeitraum in „verarbeitet“ geändert wurde |
| [HasRightsForBatchType](/de/flexi-capture/api/methods/has-rights-for-batch-type) | Prüft, ob die Benutzerrolle Zugriffsberechtigungen für einen bestimmten Batch-Typ hat                                                          |

## <a id="files" />Dateien

| [GetCustomFileNames](/de/flexi-capture/api/methods/get-custom-file-names) | Ruft eine Liste der auf dem Application Server gespeicherten Benutzerdateien ab |
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
| [LoadCustomFile](/de/flexi-capture/api/methods/load-custom-file)          | Lädt eine Benutzerdatei vom Application Server                                  |
| [RemoveCustomFile](/de/flexi-capture/api/methods/remove-custom-file)      | Löscht eine Benutzerdatei vom Application Server                                |
| [SaveCustomFile](/de/flexi-capture/api/methods/save-custom-file)          | Speichert eine Benutzerdatei auf dem Application Server                         |

## <a id="attachments" />Anhänge

| [GetAttachmentNames](/de/flexi-capture/api/methods/get-attachment-names) | Gibt eine Liste der Anhänge auf dem Application Server zurück |
| ------------------------------------------------------------------------ | ------------------------------------------------------------- |
| [LoadAttachment](/de/flexi-capture/api/methods/load-attachment)          | Lädt einen Anhang vom Application Server                      |
| [RemoveAttachment](/de/flexi-capture/api/methods/remove-attachment)      | Löscht einen Anhang vom Application Server                    |
| [SaveAttachment](/de/flexi-capture/api/methods/save-attachment)          | Speichert einen Anhang auf dem Application Server             |

## <a id="templates" />Dokumentdefinitionen

| [GetTemplates](/de/flexi-capture/api/methods/get-templates)                     | Ruft die Dokumentdefinitionen des Projekts ab                                  |
| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
| [GetBatchTypeTemplates](/de/flexi-capture/api/methods/get-batch-type-templates) | Gibt die Bezeichner der dem Batch-Typ zugeordneten Dokumentdefinitionen zurück |

## <a id="log" />Protokoll

| [WriteToLog](/de/flexi-capture/api/methods/write-to-log) | Schreibt Informationen zu Ereignissen in das Protokoll des Application Servers |
| -------------------------------------------------------- | ------------------------------------------------------------------------------ |

## <a id="serverrequests" />Serveranfragen

| [CreateRequest](/de/flexi-capture/api/methods/create-request-api-methods) | Erstellt eine Anfrage an den Application Server                                    |
| ------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| [DeleteRequest](/de/flexi-capture/api/methods/delete-request)             | Löscht eine Anfrage an den Application Server.                                     |
| [GetRequests](/de/flexi-capture/api/methods/get-requests)                 | Ruft eine Liste der Anfragen an den Application Server in der aktuellen Sitzung ab |
| [GetRequestStatus](/de/flexi-capture/api/methods/get-request-status)      | Ruft den Status einer Anfrage an den Application Server ab                         |
| [SetRequestStatus](/de/flexi-capture/api/methods/set-request-status)      | Ändert den Status einer Anfrage an den Application Server                          |

## <a id="other" />Sonstiges

| [GetSettingValue](/de/flexi-capture/api/methods/get-setting-value) | Ruft einen benannten Parameter aus der Datenbank ab  |
| ------------------------------------------------------------------ | ---------------------------------------------------- |
| [SetSettingValue](/de/flexi-capture/api/methods/set-setting-value) | Speichert einen benannten Parameter in der Datenbank |
