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

# Méthodes API

> Parcourez l’ensemble complet des méthodes de l’API Web Services FlexiCapture d’ABBYY, regroupées par sessions, projets, lots, tâches, documents, pages, utilisateurs, fichiers, etc.

Les méthodes API permettent de contrôler l’Application Server.

| [Sessions](/fr/flexi-capture/api/methods/methods#sessions) | [Projets](/fr/flexi-capture/api/methods/methods#projects)                   | [Types de lots](/fr/flexi-capture/api/methods/methods#batchtypes) |
| ---------------------------------------------------------- | --------------------------------------------------------------------------- | ----------------------------------------------------------------- |
| [Lots](/fr/flexi-capture/api/methods/methods#batches)      | [Tâches](/fr/flexi-capture/api/methods/methods#tasks)                       | [Documents](/fr/flexi-capture/api/methods/methods#documents)      |
| [Pages](/fr/flexi-capture/api/methods/methods#pages)       | [Tickets de licence](/fr/flexi-capture/api/methods/methods#tickets)         | [Users](/fr/flexi-capture/api/methods/methods#users)              |
| [Fichiers](/fr/flexi-capture/api/methods/methods#files)    | [Pièces jointes](/fr/flexi-capture/api/methods/methods#attachments)         | [Journal](/fr/flexi-capture/api/methods/methods#log)              |
| [Définitions de documents](#templates)                     | [Requêtes du serveur](/fr/flexi-capture/api/methods/methods#serverrequests) | [Autres](/fr/flexi-capture/api/methods/methods#other)             |

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

| [CloseSession](/fr/flexi-capture/api/methods/close-session)        | Ferme une session                                              |
| ------------------------------------------------------------------ | -------------------------------------------------------------- |
| [GetSessionInfo](/fr/flexi-capture/api/methods/get-session-info)   | Récupère les informations d’une session                        |
| [IsSessionExists](/fr/flexi-capture/api/methods/is-session-exists) | Vérifie si une session existe                                  |
| [OpenSession](/fr/flexi-capture/api/methods/open-session)          | Ouvre une session et spécifie les types de rôles et la station |

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

| [CloseProject](/fr/flexi-capture/api/methods/close-project)               | Ferme un projet                                                                                |
| ------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| [GetProjects](/fr/flexi-capture/api/methods/get-projects)                 | Renvoie la liste des projets chargés sur le serveur d’applications                             |
| [GetProjectsForUser](/fr/flexi-capture/api/methods/get-projects-for-user) | Renvoie l’ensemble des enregistrements répertoriant les projets disponibles pour l’utilisateur |
| [OpenProject](/fr/flexi-capture/api/methods/open-project)                 | Ouvre un projet                                                                                |

## <a id="batchtypes" />Types de lots

| [GetAllowedBatchTypes](/fr/flexi-capture/api/methods/get-allowed-batch-types)    | Renvoie une liste des types de lots disponibles                                          |
| -------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| [GetBatchType](/fr/flexi-capture/api/methods/get-batchtype)                      | Renvoie des informations sur un type de lot                                              |
| [GetBatchTypes](/fr/flexi-capture/api/methods/get-batch-types)                   | Renvoie une liste de types de lots                                                       |
| [GetProcessingStages](/fr/flexi-capture/api/methods/get-processing-stages)       | Renvoie des informations détaillées sur les étapes de traitement                         |
| [HasRightsForBatchType](/fr/flexi-capture/api/methods/has-rights-for-batch-type) | Vérifie si le rôle de l'utilisateur dispose des droits d'accès pour un type de lot donné |

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

| [AddNewBatch](/fr/flexi-capture/api/methods/add-new-batch)                            | Ajoute un nouveau lot et en spécifie le propriétaire         |
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------ |
| [AddNewImage](/fr/flexi-capture/api/methods/add-new-image)                            | Ajoute une image à un lot                                    |
| [CloseBatch](/fr/flexi-capture/api/methods/close-batch)                               | Ferme (déverrouille) un lot                                  |
| [DeleteBatch](/fr/flexi-capture/api/methods/delete-batch)                             | Supprime un lot                                              |
| [GetBatch](/fr/flexi-capture/api/methods/get-batch)                                   | Récupère des informations sur un lot                         |
| [GetBatches](/fr/flexi-capture/api/methods/get-batches)                               | Récupère des informations sur les lots d’un projet           |
| [GetBatchIdsRange](/fr/flexi-capture/api/methods/get-batch-ids-range)                 | Réserve un ensemble d’ID dans un lot                         |
| [GetBatchPercentCompleted](/fr/flexi-capture/api/methods/get-batch-percent-completed) | Récupère des informations sur le traitement d’un lot         |
| [GetFilteredBatches](/fr/flexi-capture/get-filtered-batches)                          | Récupère la liste filtrée des lots d’un serveur, par groupes |
| [OpenBatch](/fr/flexi-capture/api/methods/open-batch)                                 | Ouvre (verrouille) un lot                                    |
| [ProcessBatch](/fr/flexi-capture/api/methods/process-batch)                           | Lance le traitement d’un lot                                 |
| [UpdateBatch](/fr/flexi-capture/api/methods/update-batch)                             | Met à jour l’en-tête du lot                                  |

## <a id="tasks" />Tâches

| [CancelTask](/fr/flexi-capture/api/methods/cancel-task)                                     | Annule une tâche                                                                                                                                                                |
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [CloseTask](/fr/flexi-capture/api/methods/close-task)                                       | Ferme une tâche                                                                                                                                                                 |
| [CreateTask](/fr/flexi-capture/api/methods/create-task)                                     | Crée une tâche                                                                                                                                                                  |
| [GetAvailableTasks](/fr/flexi-capture/api/methods/get-available-tasks)                      | Renvoie la liste des tâches disponibles pour le type d’étape sélectionné. Permet de restreindre l’ensemble des lots disponibles.                                                |
| [GetAvailableTasksByStageId](/fr/flexi-capture/api/methods/get-available-tasks-by-stage-id) | Renvoie la liste des tâches disponibles pour les étapes de traitement spécifiées. Permet de restreindre l’ensemble des lots disponibles                                         |
| [GetAvailableQueues](/fr/flexi-capture/api/methods/get-available-queues)                    | Renvoie l’ensemble des enregistrements répertoriant les étapes de traitement disponibles pour l’utilisateur                                                                     |
| [GetCurrentTask](/fr/flexi-capture/api/methods/get-current-task)                            | Renvoie l’ID de la tâche obtenue avec la méthode [GetTask](/fr/flexi-capture/api/methods/get-task) et qui n’a pas encore été traitée                                            |
| [GetPostponedTasks](/fr/flexi-capture/api/methods/get-postponed-tasks)                      | Renvoie la liste des tâches reportées                                                                                                                                           |
| [GetTask](/fr/flexi-capture/api/methods/get-task)                                           | Sélectionne la tâche de priorité la plus élevée aux étapes de traitement du type sélectionné et l’ouvre pour traitement. Permet de restreindre l’ensemble des lots disponibles. |
| [GetTaskByStageId](/fr/flexi-capture/api/methods/get-task-by-stage-id)                      | Sélectionne la tâche de priorité la plus élevée aux étapes de traitement spécifiées et l’ouvre pour traitement                                                                  |
| [GetTaskDocuments](/fr/flexi-capture/api/methods/get-task-documents)                        | Renvoie la liste des documents d’une tâche                                                                                                                                      |
| [GetTaskInfo](/fr/flexi-capture/api/methods/get-task-info)                                  | Renvoie des informations détaillées sur une tâche                                                                                                                               |
| [OpenTask](/fr/flexi-capture/api/methods/open-task)                                         | Ouvre une tâche                                                                                                                                                                 |
| [PostponeTask](/fr/flexi-capture/api/methods/postpone-task)                                 | Reporte une tâche                                                                                                                                                               |
| [SendTask](/fr/flexi-capture/api/methods/send-task)                                         | Envoie la tâche à l’étape de traitement spécifiée                                                                                                                               |
| [SendTaskToException](/fr/flexi-capture/api/methods/send-task-to-exception)                 | Envoie une tâche vers Exceptions                                                                                                                                                |
| [SetTaskPriority](/fr/flexi-capture/api/methods/set-task-priority)                          | Modifie la priorité de la tâche                                                                                                                                                 |

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

| [AddNewDocument](/fr/flexi-capture/api/methods/add-new-document)               | Ajoute un nouveau document et spécifie des informations supplémentaires                                 |
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------- |
| [AddNewImage](/fr/flexi-capture/api/methods/add-new-image)                     | Ajoute une image à un lot                                                                               |
| [DeleteDocument](/fr/flexi-capture/api/methods/delete-document)                | Supprime un document                                                                                    |
| [GetDocument](/fr/flexi-capture/api/methods/get-document)                      | Récupère des informations sur un document                                                               |
| [GetDocumentResultsList](/fr/flexi-capture/get-document-results-list)          | Récupère la liste des fichiers dans lesquels les résultats du traitement des documents ont été exportés |
| [GetDocuments](/fr/flexi-capture/api/methods/get-documents)                    | Récupère la liste des documents d’un lot                                                                |
| [LoadDocumentResult](/fr/flexi-capture/api/methods/load-document-result)       | Récupère le fichier dans lequel les résultats du traitement des documents ont été exportés              |
| [SetDocumentProperties](/fr/flexi-capture/api/methods/set-document-properties) | Spécifie les paramètres d’enregistrement d’un document                                                  |
| [SetDocumentPriority](/fr/flexi-capture/api/methods/set-document-priority)     | Modifie la priorité du document                                                                         |

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

| [AddNewPage](/fr/flexi-capture/api/methods/add-new-page)             | Ajoute l’image d’une page à un document et inclut une description |
| -------------------------------------------------------------------- | ----------------------------------------------------------------- |
| [DeletePage](/fr/flexi-capture/api/methods/delete-page)              | Supprime une page d’un document                                   |
| [ReplacePageImage](/fr/flexi-capture/api/methods/replace-page-image) | Remplace l’image d’une page                                       |

## <a id="tickets" />Tickets de licence

| [GetNewTicket](/fr/flexi-capture/api/methods/get-new-ticket)  | Obtient un nouveau ticket de licence     |
| ------------------------------------------------------------- | ---------------------------------------- |
| [ReleaseTicket](/fr/flexi-capture/api/methods/release-ticket) | Libère un ticket de licence              |
| [UpdateTicket](/fr/flexi-capture/api/methods/update-ticket)   | Met à jour l’état d’un ticket de licence |

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

| [AddUserIfNotExist](/fr/flexi-capture/api/methods/add-user-if-not-exist)         | Obtient l’ID de l’utilisateur actuel et crée un enregistrement dans la base de données si nécessaire                                                     |
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [FindUser](/fr/flexi-capture/api/methods/find-user)                              | Obtient l’ID et le nom de l’utilisateur                                                                                                                  |
| [GetAvailableQueues](/fr/flexi-capture/api/methods/get-available-queues)         | Obtient l’ensemble des enregistrements répertoriant les étapes de traitement disponibles pour l’utilisateur                                              |
| [GetAvailableUsers](/fr/flexi-capture/api/methods/get-available-users)           | Obtient une liste des utilisateurs ou groupes autorisés à traiter une étape donnée                                                                       |
| [GetProjectsForStationType](/fr/flexi-capture/get-projects-for-station-type)     | Recherche les projets dans lesquels un utilisateur a au moins un rôle associé à un type de station particulier                                           |
| [GetProjectsForUser](/fr/flexi-capture/api/methods/get-projects-for-user)        | Obtient l’ensemble des enregistrements répertoriant les projets disponibles pour l’utilisateur                                                           |
| [GetRoles](/fr/flexi-capture/api/methods/get-roles)                              | Obtient la liste de tous les rôles du projet                                                                                                             |
| [GetUser](/fr/flexi-capture/api/methods/get-user)                                | Obtient des informations sur l’utilisateur à partir de son ID                                                                                            |
| [GetUserRoles](/fr/flexi-capture/api/methods/get-user-roles)                     | Obtient la liste des ID des rôles utilisateur disponibles pour l’utilisateur actuel dans le projet spécifié                                              |
| [GetUsers](/fr/flexi-capture/api/methods/get-users)                              | Obtient la liste des utilisateurs                                                                                                                        |
| [GetUserStatistics](/fr/flexi-capture/api/methods/get-user-statistics)           | Obtient un ensemble d’enregistrements répertoriant le nombre de lots, de documents et de pages dont l’état est passé à « traité » sur une période donnée |
| [HasRightsForBatchType](/fr/flexi-capture/api/methods/has-rights-for-batch-type) | Vérifie si le rôle utilisateur dispose des droits d’accès à un certain type de lot                                                                       |

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

| [GetCustomFileNames](/fr/flexi-capture/api/methods/get-custom-file-names) | Renvoie la liste des fichiers utilisateur stockés sur le serveur d’applications |
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
| [LoadCustomFile](/fr/flexi-capture/api/methods/load-custom-file)          | Charge un fichier utilisateur à partir du serveur d’applications                |
| [RemoveCustomFile](/fr/flexi-capture/api/methods/remove-custom-file)      | Supprime un fichier utilisateur du serveur d’applications                       |
| [SaveCustomFile](/fr/flexi-capture/api/methods/save-custom-file)          | Enregistre un fichier utilisateur sur le serveur d’applications                 |

## <a id="attachments" />Pièces jointes

| [GetAttachmentNames](/fr/flexi-capture/api/methods/get-attachment-names) | Récupère la liste des pièces jointes du serveur d’applications |
| ------------------------------------------------------------------------ | -------------------------------------------------------------- |
| [LoadAttachment](/fr/flexi-capture/api/methods/load-attachment)          | Charge une pièce jointe depuis le serveur d’applications       |
| [RemoveAttachment](/fr/flexi-capture/api/methods/remove-attachment)      | Supprime une pièce jointe du serveur d’applications            |
| [SaveAttachment](/fr/flexi-capture/api/methods/save-attachment)          | Enregistre une pièce jointe sur le serveur d’applications      |

## <a id="templates" />Définitions de documents

| [GetTemplates](/fr/flexi-capture/api/methods/get-templates)                     | Obtient l’ensemble des définitions de documents du projet                                 |
| ------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| [GetBatchTypeTemplates](/fr/flexi-capture/api/methods/get-batch-type-templates) | Renvoie l’ensemble des identifiants des définitions de documents associées au type de lot |

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

| [WriteToLog](/fr/flexi-capture/api/methods/write-to-log) | Consigne des informations sur les événements dans le journal du serveur d’applications |
| -------------------------------------------------------- | -------------------------------------------------------------------------------------- |

## <a id="serverrequests" />Requêtes du serveur

| [CreateRequest](/fr/flexi-capture/api/methods/create-request-api-methods) | Crée une requête adressée au serveur d’applications                                         |
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| [DeleteRequest](/fr/flexi-capture/api/methods/delete-request)             | Supprime une requête adressée au serveur d’applications.                                    |
| [GetRequests](/fr/flexi-capture/api/methods/get-requests)                 | Récupère la liste des requêtes adressées au serveur d’applications dans la session en cours |
| [GetRequestStatus](/fr/flexi-capture/api/methods/get-request-status)      | Récupère le statut d’une requête adressée au serveur d’applications                         |
| [SetRequestStatus](/fr/flexi-capture/api/methods/set-request-status)      | Modifie le statut d’une requête adressée au serveur d’applications                          |

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

| [GetSettingValue](/fr/flexi-capture/api/methods/get-setting-value) | Récupère un paramètre nommé dans la base de données   |
| ------------------------------------------------------------------ | ----------------------------------------------------- |
| [SetSettingValue](/fr/flexi-capture/api/methods/set-setting-value) | Enregistre un paramètre nommé dans la base de données |
