> ## 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étodos de la API

> Explore el conjunto completo de métodos de la API de servicios web de ABBYY FlexiCapture, agrupados por sesiones, proyectos, lotes, tareas, documentos, páginas, usuarios, archivos y más.

Los métodos de la API se usan para controlar el Application Server.

| [Sesiones](/es/flexi-capture/api/methods/methods#sessions) | [Proyectos](/es/flexi-capture/api/methods/methods#projects)                     | [Tipos de lote](/es/flexi-capture/api/methods/methods#batchtypes) |
| ---------------------------------------------------------- | ------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
| [Lotes](/es/flexi-capture/api/methods/methods#batches)     | [Tareas](/es/flexi-capture/api/methods/methods#tasks)                           | [Documentos](/es/flexi-capture/api/methods/methods#documents)     |
| [Páginas](/es/flexi-capture/api/methods/methods#pages)     | [Tickets de licencia](/es/flexi-capture/api/methods/methods#tickets)            | [Usuarios](/es/flexi-capture/api/methods/methods#users)           |
| [Archivos](/es/flexi-capture/api/methods/methods#files)    | [Archivos adjuntos](/es/flexi-capture/api/methods/methods#attachments)          | [Registro](/es/flexi-capture/api/methods/methods#log)             |
| [Definiciones de Document](#templates)                     | [Solicitudes al servidor](/es/flexi-capture/api/methods/methods#serverrequests) | [Otros](/es/flexi-capture/api/methods/methods#other)              |

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

| [CloseSession](/es/flexi-capture/api/methods/close-session)        | Cierra una sesión                                           |
| ------------------------------------------------------------------ | ----------------------------------------------------------- |
| [GetSessionInfo](/es/flexi-capture/api/methods/get-session-info)   | Obtiene información de una sesión                           |
| [IsSessionExists](/es/flexi-capture/api/methods/is-session-exists) | Comprueba si existe una sesión                              |
| [OpenSession](/es/flexi-capture/api/methods/open-session)          | Abre una sesión y especifica los tipos de rol y la estación |

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

| [CloseProject](/es/flexi-capture/api/methods/close-project)               | Cierra un proyecto                                                                     |
| ------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| [GetProjects](/es/flexi-capture/api/methods/get-projects)                 | Obtiene una lista de proyectos cargados en el Application Server                       |
| [GetProjectsForUser](/es/flexi-capture/api/methods/get-projects-for-user) | Obtiene el conjunto de registros con la lista de proyectos disponibles para el usuario |
| [OpenProject](/es/flexi-capture/api/methods/open-project)                 | Abre un proyecto                                                                       |

## <a id="batchtypes" />Tipos de lote

| [GetAllowedBatchTypes](/es/flexi-capture/api/methods/get-allowed-batch-types)    | Obtiene una lista de los tipos de lote disponibles                                     |
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| [GetBatchType](/es/flexi-capture/api/methods/get-batchtype)                      | Obtiene información sobre un tipo de lote                                              |
| [GetBatchTypes](/es/flexi-capture/api/methods/get-batch-types)                   | Obtiene una lista de tipos de lote                                                     |
| [GetProcessingStages](/es/flexi-capture/api/methods/get-processing-stages)       | Obtiene información ampliada sobre las etapas de procesamiento                         |
| [HasRightsForBatchType](/es/flexi-capture/api/methods/has-rights-for-batch-type) | Comprueba si el rol del usuario tiene permisos de acceso a un tipo de lote determinado |

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

| [AddNewBatch](/es/flexi-capture/api/methods/add-new-batch)                            | Añade un nuevo lote y especifica su propietario           |
| ------------------------------------------------------------------------------------- | --------------------------------------------------------- |
| [AddNewImage](/es/flexi-capture/api/methods/add-new-image)                            | Añade una imagen a un lote                                |
| [CloseBatch](/es/flexi-capture/api/methods/close-batch)                               | Cierra (desbloquea) un lote                               |
| [DeleteBatch](/es/flexi-capture/api/methods/delete-batch)                             | Elimina un lote                                           |
| [GetBatch](/es/flexi-capture/api/methods/get-batch)                                   | Obtiene información sobre un lote                         |
| [GetBatches](/es/flexi-capture/api/methods/get-batches)                               | Obtiene información sobre los lotes de un proyecto        |
| [GetBatchIdsRange](/es/flexi-capture/api/methods/get-batch-ids-range)                 | Reserva un conjunto de ID en un lote                      |
| [GetBatchPercentCompleted](/es/flexi-capture/api/methods/get-batch-percent-completed) | Obtiene información sobre el procesamiento de un lote     |
| [GetFilteredBatches](/es/flexi-capture/get-filtered-batches)                          | Obtiene del servidor la lista filtrada de lotes en grupos |
| [OpenBatch](/es/flexi-capture/api/methods/open-batch)                                 | Abre (bloquea) un lote                                    |
| [ProcessBatch](/es/flexi-capture/api/methods/process-batch)                           | Inicia el procesamiento de un lote                        |
| [UpdateBatch](/es/flexi-capture/api/methods/update-batch)                             | Actualiza el encabezado del lote                          |

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

| [CancelTask](/es/flexi-capture/api/methods/cancel-task)                                     | Cancela una tarea                                                                                                                                                                 |
| ------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [CloseTask](/es/flexi-capture/api/methods/close-task)                                       | Cierra una tarea                                                                                                                                                                  |
| [CreateTask](/es/flexi-capture/api/methods/create-task)                                     | Crea una tarea                                                                                                                                                                    |
| [GetAvailableTasks](/es/flexi-capture/api/methods/get-available-tasks)                      | Obtiene la lista de tareas disponibles para el tipo de etapa seleccionado. Permite restringir el conjunto de lotes disponibles.                                                   |
| [GetAvailableTasksByStageId](/es/flexi-capture/api/methods/get-available-tasks-by-stage-id) | Obtiene la lista de tareas disponibles para las etapas de procesamiento especificadas. Permite restringir el conjunto de lotes disponibles                                        |
| [GetAvailableQueues](/es/flexi-capture/api/methods/get-available-queues)                    | Obtiene el conjunto de registros que contiene las etapas de procesamiento disponibles para el usuario                                                                             |
| [GetCurrentTask](/es/flexi-capture/api/methods/get-current-task)                            | Obtiene el ID de la tarea obtenida con el método [GetTask](/es/flexi-capture/api/methods/get-task) y que aún no se ha procesado                                                   |
| [GetPostponedTasks](/es/flexi-capture/api/methods/get-postponed-tasks)                      | Obtiene una lista de tareas aplazadas                                                                                                                                             |
| [GetTask](/es/flexi-capture/api/methods/get-task)                                           | Selecciona la tarea de mayor prioridad en las etapas de procesamiento del tipo seleccionado y la abre para su procesamiento. Permite restringir el conjunto de lotes disponibles. |
| [GetTaskByStageId](/es/flexi-capture/api/methods/get-task-by-stage-id)                      | Selecciona la tarea de mayor prioridad en las etapas de procesamiento especificadas y la abre para su procesamiento                                                               |
| [GetTaskDocuments](/es/flexi-capture/api/methods/get-task-documents)                        | Obtiene una lista de documentos de una tarea                                                                                                                                      |
| [GetTaskInfo](/es/flexi-capture/api/methods/get-task-info)                                  | Obtiene información detallada sobre una tarea                                                                                                                                     |
| [OpenTask](/es/flexi-capture/api/methods/open-task)                                         | Abre una tarea                                                                                                                                                                    |
| [PostponeTask](/es/flexi-capture/api/methods/postpone-task)                                 | Aplaza una tarea                                                                                                                                                                  |
| [SendTask](/es/flexi-capture/api/methods/send-task)                                         | Envía la tarea a la etapa de procesamiento especificada                                                                                                                           |
| [SendTaskToException](/es/flexi-capture/api/methods/send-task-to-exception)                 | Envía una tarea a Excepciones                                                                                                                                                     |
| [SetTaskPriority](/es/flexi-capture/api/methods/set-task-priority)                          | Cambia la prioridad de la tarea                                                                                                                                                   |

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

| [AddNewDocument](/es/flexi-capture/api/methods/add-new-document)               | Añade un documento nuevo y especifica información adicional                                              |
| ------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------- |
| [AddNewImage](/es/flexi-capture/api/methods/add-new-image)                     | Añade una imagen a un lote                                                                               |
| [DeleteDocument](/es/flexi-capture/api/methods/delete-document)                | Elimina un documento                                                                                     |
| [GetDocument](/es/flexi-capture/api/methods/get-document)                      | Obtiene información sobre un documento                                                                   |
| [GetDocumentResultsList](/es/flexi-capture/get-document-results-list)          | Obtiene una lista de los archivos a los que se exportaron los resultados del procesamiento de documentos |
| [GetDocuments](/es/flexi-capture/api/methods/get-documents)                    | Obtiene una lista de documentos de un lote                                                               |
| [LoadDocumentResult](/es/flexi-capture/api/methods/load-document-result)       | Obtiene el archivo al que se exportaron los resultados del procesamiento de documentos                   |
| [SetDocumentProperties](/es/flexi-capture/api/methods/set-document-properties) | Especifica los parámetros de registro de un documento                                                    |
| [SetDocumentPriority](/es/flexi-capture/api/methods/set-document-priority)     | Cambia la prioridad del documento                                                                        |

## <a id="pages" />Páginas

| [AddNewPage](/es/flexi-capture/api/methods/add-new-page)             | Agrega la imagen de una página a un documento e incluye una descripción |
| -------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| [DeletePage](/es/flexi-capture/api/methods/delete-page)              | Elimina una página de un documento                                      |
| [ReplacePageImage](/es/flexi-capture/api/methods/replace-page-image) | Reemplaza la imagen de una página                                       |

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

| [GetNewTicket](/es/flexi-capture/api/methods/get-new-ticket)  | Obtiene un nuevo ticket de licencia          |
| ------------------------------------------------------------- | -------------------------------------------- |
| [ReleaseTicket](/es/flexi-capture/api/methods/release-ticket) | Libera un ticket de licencia                 |
| [UpdateTicket](/es/flexi-capture/api/methods/update-ticket)   | Actualiza el estado de un ticket de licencia |

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

| [AddUserIfNotExist](/es/flexi-capture/api/methods/add-user-if-not-exist)         | Obtiene el ID del usuario actual y crea un registro en la base de datos si es necesario                                                         |
| -------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| [FindUser](/es/flexi-capture/api/methods/find-user)                              | Obtiene el ID y el nombre del usuario                                                                                                           |
| [GetAvailableQueues](/es/flexi-capture/api/methods/get-available-queues)         | Obtiene el conjunto de registros con la lista de las etapas de procesamiento disponibles para el usuario                                        |
| [GetAvailableUsers](/es/flexi-capture/api/methods/get-available-users)           | Obtiene una lista de usuarios o grupos autorizados para procesar una etapa especificada                                                         |
| [GetProjectsForStationType](/es/flexi-capture/get-projects-for-station-type)     | Encuentra proyectos en los que un usuario tiene al menos un rol asociado a un tipo de estación determinado                                      |
| [GetProjectsForUser](/es/flexi-capture/api/methods/get-projects-for-user)        | Obtiene el conjunto de registros con la lista de los proyectos disponibles para el usuario                                                      |
| [GetRoles](/es/flexi-capture/api/methods/get-roles)                              | Obtiene la lista de todos los roles del proyecto                                                                                                |
| [GetUser](/es/flexi-capture/api/methods/get-user)                                | Obtiene información sobre el usuario a partir del ID de usuario                                                                                 |
| [GetUserRoles](/es/flexi-capture/api/methods/get-user-roles)                     | Obtiene la lista de ID de los roles de usuario disponibles para el usuario actual en el proyecto especificado                                   |
| [GetUsers](/es/flexi-capture/api/methods/get-users)                              | Obtiene la lista de usuarios                                                                                                                    |
| [GetUserStatistics](/es/flexi-capture/api/methods/get-user-statistics)           | Obtiene un conjunto de registros con la cantidad de lotes, documentos y páginas cuyo estado cambió a "procesado" durante un período determinado |
| [HasRightsForBatchType](/es/flexi-capture/api/methods/has-rights-for-batch-type) | Comprueba si el rol del usuario tiene permisos de acceso a un determinado tipo de lote                                                          |

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

| [GetCustomFileNames](/es/flexi-capture/api/methods/get-custom-file-names) | Obtiene la lista de archivos de usuario almacenados en el Application Server |
| ------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
| [LoadCustomFile](/es/flexi-capture/api/methods/load-custom-file)          | Carga un archivo de usuario desde el Application Server                      |
| [RemoveCustomFile](/es/flexi-capture/api/methods/remove-custom-file)      | Elimina un archivo de usuario del Application Server                         |
| [SaveCustomFile](/es/flexi-capture/api/methods/save-custom-file)          | Guarda un archivo de usuario en el Application Server                        |

## <a id="attachments" />Archivos adjuntos

| [GetAttachmentNames](/es/flexi-capture/api/methods/get-attachment-names) | Obtiene la lista de archivos adjuntos del Application Server |
| ------------------------------------------------------------------------ | ------------------------------------------------------------ |
| [LoadAttachment](/es/flexi-capture/api/methods/load-attachment)          | Carga un archivo adjunto desde el Application Server         |
| [RemoveAttachment](/es/flexi-capture/api/methods/remove-attachment)      | Elimina un archivo adjunto del Application Server            |
| [SaveAttachment](/es/flexi-capture/api/methods/save-attachment)          | Guarda un archivo adjunto en el Application Server           |

## <a id="templates" />Definiciones de Document

| [GetTemplates](/es/flexi-capture/api/methods/get-templates)                     | Obtiene el conjunto de Definiciones de Document del proyecto                                      |
| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| [GetBatchTypeTemplates](/es/flexi-capture/api/methods/get-batch-type-templates) | Devuelve el conjunto de identificadores de las Definiciones de Document asociadas al tipo de lote |

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

| [WriteToLog](/es/flexi-capture/api/methods/write-to-log) | Escribe información sobre eventos en el registro de Application Server |
| -------------------------------------------------------- | ---------------------------------------------------------------------- |

## <a id="serverrequests" />Solicitudes al servidor

| [CreateRequest](/es/flexi-capture/api/methods/create-request-api-methods) | Crea una solicitud al Application Server                                   |
| ------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
| [DeleteRequest](/es/flexi-capture/api/methods/delete-request)             | Elimina una solicitud al Application Server.                               |
| [GetRequests](/es/flexi-capture/api/methods/get-requests)                 | Obtiene una lista de solicitudes al Application Server en la sesión actual |
| [GetRequestStatus](/es/flexi-capture/api/methods/get-request-status)      | Obtiene el estado de una solicitud al Application Server                   |
| [SetRequestStatus](/es/flexi-capture/api/methods/set-request-status)      | Cambia el estado de una solicitud al Application Server                    |

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

| [GetSettingValue](/es/flexi-capture/api/methods/get-setting-value) | Obtiene un parámetro identificado por nombre de la base de datos |
| ------------------------------------------------------------------ | ---------------------------------------------------------------- |
| [SetSettingValue](/es/flexi-capture/api/methods/set-setting-value) | Guarda un parámetro identificado por nombre en la base de datos  |
