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

# GetFilteredBatches

> Solicite un conjunto de lotes filtrado y paginado mediante el método GetFilteredBatches de la API de servicios web de ABBYY FlexiCapture, con filtros por etapa, fecha y SLA.

<div id="what-it-does">
  ## Lo que hace
</div>

Solicita al servidor un conjunto filtrado de lotes en grupos. Por ejemplo, puede enviar una solicitud como la siguiente: "devuelve 100 lotes que están en la etapa de reconocimiento a partir del lote número 500."

<div id="definition">
  ## Definición
</div>

```
int GetFilteredBatches(int sessionId, int projectId, int batchTypeId, int[] stageTypes, int[] stageExtIds, string name, int batchPurpose, long startDate, long stopDate, long slaDateBeginRange, long slaDateEndRange, int slaStateFlags, int firstRecord, int recordsCount, RegistrationProperty[] filterRegParams, out Batch[] batches)
```

<div id="parameters">
  ## Parámetros
</div>

<table width="100%">
  <tbody>
    <tr>
      <td>
        <p>
          <strong>Name</strong>
        </p>
      </td>

      <td>
        <p>
          <strong>Tipo</strong>
        </p>
      </td>

      <td>
        <p>
          <strong>Descripción</strong>
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>sessionId</p>
      </td>

      <td>
        <p>int</p>
      </td>

      <td>
        <p>El ID de la conexión con el Servidor de aplicaciones</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>projectId</p>
      </td>

      <td>
        <p>int</p>
      </td>

      <td>
        <p>El ID del proyecto que contiene los tipos de lote cuya información se quiere obtener</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>batchTypeId</p>
      </td>

      <td>
        <p>int</p>
      </td>

      <td>
        <p>El ID del tipo de lote</p>

        <ul>
          <li>0 - lote predeterminado</li>
          <li>-1 - todos los tipos de lote</li>
        </ul>
      </td>
    </tr>

    <tr>
      <td>
        <p>stageTypes</p>
      </td>

      <td>
        <p>int \[]</p>
      </td>

      <td>
        <p>
          El conjunto de tipos de etapa (para ver los valores posibles, consulte <a href="/es/flexi-capture/api/structures/processing-stage">ProcessingStage</a>) en los que se encuentran los lotes que busca
        </p>

        <ul>
          <li>Conjunto vacío: todos los lotes</li>
          <li>0 - lotes que no están en ninguna etapa en particular</li>
        </ul>
      </td>
    </tr>

    <tr>
      <td>
        <p>stageExtIds</p>
      </td>

      <td>
        <p>int \[]</p>
      </td>

      <td>
        <p>
          El conjunto de ID de etapa (el campo Id de la estructura <a href="/es/flexi-capture/api/structures/processing-stage">ProcessingStage</a>) en el que se encuentran los lotes que busca
        </p>

        <ul>
          <li>Conjunto vacío: todos los lotes</li>
          <li>0: lotes que no están en ninguna etapa en particular</li>
        </ul>
      </td>
    </tr>

    <tr>
      <td>
        <p>name</p>
      </td>

      <td>
        <p>cadena</p>
      </td>

      <td>
        <p>El prefijo del nombre del lote. Una línea vacía indica que se admite cualquier nombre</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>batchPurpose</p>
      </td>

      <td>
        <p>int</p>
      </td>

      <td>
        <p>La finalidad del lote</p>
        <p>Valores posibles:</p>

        <ul>
          <li>0 - lotes con datos</li>
          <li>1 - lotes para entrenar el emparejamiento de Definición de Document</li>
          <li>2 - lotes para entrenar clasificadores</li>
        </ul>
      </td>
    </tr>

    <tr>
      <td>
        <p>startDate</p>
      </td>

      <td>
        <p>long</p>
      </td>

      <td>
        <p>Lotes creados después de la fecha especificada; 0 representa todos los lotes</p>
        <p>Para realizar la conversión, use los siguientes métodos (el ejemplo de abajo está en C#):</p>

        <pre>
          <code>DateTime dtTime; long lTime; ... // conversión de DataTime a long dTime = DataTime.FromFileTime(lTime); ... // conversión de long a DataTime lTime = dTime.ToFileTime();</code>
        </pre>
      </td>
    </tr>

    <tr>
      <td>
        <p>stopDate</p>
      </td>

      <td>
        <p>long</p>
      </td>

      <td>
        <p>Lotes creados en la fecha especificada o con posterioridad; 0 indica todos los lotes</p>
        <p>Para la conversión, use los siguientes métodos (el ejemplo siguiente está en C#):</p>

        <pre>
          <code>DateTime dtTime; long lTime; ... // conversión de DataTime a long dTime = DataTime.FromFileTime(lTime); ... // conversión de long a DataTime lTime = dTime.ToFileTime();</code>
        </pre>
      </td>
    </tr>

    <tr>
      <td>
        <p>slaDateBeginRange</p>
      </td>

      <td>
        <p>long</p>
      </td>

      <td>
        <p>Lotes cuya fecha de finalización del procesamiento según un SLA no es anterior a la fecha especificada; 0 representa todos los lotes</p>
        <p>Para la conversión, utilice los siguientes métodos (el ejemplo a continuación está en C#):</p>

        <pre>
          <code>DateTime dtTime; long lTime; ... // conversión de DataTime a long dTime = DataTime.FromFileTime(lTime); ... // conversión de long a DataTime lTime = dTime.ToFileTime();</code>
        </pre>
      </td>
    </tr>

    <tr>
      <td>
        <p>slaDateEndRange</p>
      </td>

      <td>
        <p>long</p>
      </td>

      <td>
        <p>Lotes cuya fecha de finalización del procesamiento bajo un SLA no sea posterior a la fecha especificada; 0 indica todos los lotes</p>
        <p>Para la conversión, utilice los siguientes métodos (el ejemplo de abajo está en C#):</p>

        <pre>
          <code>DateTime dtTime; long lTime; ... // conversión de DataTime a long dTime = DataTime.FromFileTime(lTime); ... // conversión de long a DataTime lTime = dTime.ToFileTime();</code>
        </pre>
      </td>
    </tr>

    <tr>
      <td>
        <p>slaStateFlags</p>
      </td>

      <td>
        <p>int</p>
      </td>

      <td>
        <p>Contiene una advertencia sobre el plazo de procesamiento de un lote</p>
        <p>Se admiten los siguientes valores o su suma lógica (OR):</p>

        <ul>
          <li>0 - los lotes no se filtran por este atributo</li>
          <li>1 - lotes sin un plazo de procesamiento especificado</li>
          <li>2 - lotes con un plazo de procesamiento que no está próximo ni vencido</li>
          <li>4 - lotes con un plazo de procesamiento próximo</li>
          <li>8 - lotes con un plazo de procesamiento vencido</li>
        </ul>
      </td>
    </tr>

    <tr>
      <td>
        <p>firstRecord</p>
      </td>

      <td>
        <p>int</p>
      </td>

      <td>
        <p>El primer Record de la lista</p>
        <p>(Los Records se numeran a partir del elemento con índice cero)</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>recordsCount</p>
      </td>

      <td>
        <p>int</p>
      </td>

      <td>
        <p>Número de lotes que un usuario intenta obtener</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>filterRegParams</p>
      </td>

      <td>
        <p>
          <a href="/es/flexi-capture/api/structures/registration-property">RegistrationProperty</a>\[]
        </p>
      </td>

      <td>
        <p>Conjunto de pares "nombre-valor" utilizado para filtrar por parámetros de registro</p>
        <p>(Solo se permite enviar 5 pares de valores; los demás se ignorarán)</p>
      </td>
    </tr>
  </tbody>
</table>

<Note>
  Los lotes se ordenan por ID en orden descendente, lo que significa que los más recientes aparecen al principio de la lista.
</Note>

<div id="returned-value">
  ## Valor devuelto
</div>

| **Tipo**                                                          | **Descripción**                                                                                       |
| ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| int                                                               | La cantidad de lotes del servidor que coinciden con los criterios de filtro especificados             |
| [Batch](/es/flexi-capture/api/structures/batch-api-structures)\[] | El conjunto de estructuras [Batch](/es/flexi-capture/api/structures/batch-api-structures) completadas |