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

> Récupérez un ensemble de lots filtré et paginé avec la méthode GetFilteredBatches de l’API Web Services d’ABBYY FlexiCapture, à l’aide de filtres sur l’étape, la date et le SLA.

<div id="what-it-does">
  ## Ce que cela fait
</div>

Demande au serveur un ensemble filtré de lots, par groupes. Par exemple, vous pouvez envoyer une requête du type : « renvoyer 100 lots à l’étape de reconnaissance, à partir du 500e lot. »

<div id="definition">
  ## Définition
</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">
  ## Paramètres
</div>

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

      <td>
        <p>
          <strong>Type</strong>
        </p>
      </td>

      <td>
        <p>
          <strong>Description</strong>
        </p>
      </td>
    </tr>

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

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

      <td>
        <p>L’ID de connexion au serveur d’applications</p>
      </td>
    </tr>

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

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

      <td>
        <p>L’ID du projet contenant les types de lots pour lesquels des informations doivent être récupérées</p>
      </td>
    </tr>

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

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

      <td>
        <p>L’ID du type de lot</p>

        <ul>
          <li>0 - lot par défaut</li>
          <li>-1 - tous les types de lots</li>
        </ul>
      </td>
    </tr>

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

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

      <td>
        <p>
          Ensemble des types d’étape (pour les valeurs possibles, voir <a href="/fr/flexi-capture/api/structures/processing-stage">ProcessingStage</a>) auxquels appartiennent les lots recherchés
        </p>

        <ul>
          <li>Ensemble vide - tous les lots</li>
          <li>0 - lots qui ne se trouvent à aucune étape particulière</li>
        </ul>
      </td>
    </tr>

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

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

      <td>
        <p>
          Ensemble des ID d’étape (le champ Id dans la structure <a href="/fr/flexi-capture/api/structures/processing-stage">ProcessingStage</a>) correspondant aux lots que vous recherchez
        </p>

        <ul>
          <li>Ensemble vide - tous les lots</li>
          <li>0 - lots ne se trouvant à aucune étape particulière</li>
        </ul>
      </td>
    </tr>

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

      <td>
        <p>string</p>
      </td>

      <td>
        <p>Le préfixe du nom du batch. Une ligne vide signifie que tous les noms sont autorisés</p>
      </td>
    </tr>

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

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

      <td>
        <p>La finalité du lot</p>
        <p>Valeurs possibles :</p>

        <ul>
          <li>0 - lots contenant des données</li>
          <li>1 - lots destinés à l’entraînement de la mise en correspondance de Document Definition</li>
          <li>2 - lots destinés à l’entraînement des classificateurs</li>
        </ul>
      </td>
    </tr>

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

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

      <td>
        <p>Lots créés après la date spécifiée ; 0 indique tous les lots</p>
        <p>Pour la conversion, utilisez les méthodes suivantes (l'exemple ci-dessous est en C#) :</p>

        <pre>
          <code>DateTime dtTime; long lTime; ... // conversion de DataTime en long dTime = DataTime.FromFileTime(lTime); ... // conversion de long en DataTime lTime = dTime.ToFileTime();</code>
        </pre>
      </td>
    </tr>

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

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

      <td>
        <p>Lots créés à partir de la date spécifiée ; 0 indique tous les lots</p>
        <p>Pour la conversion, utilisez les méthodes suivantes (l’exemple ci-dessous est en C#) :</p>

        <pre>
          <code>DateTime dtTime; long lTime; ... // conversion de DataTime en long dTime = DataTime.FromFileTime(lTime); ... // conversion de long en DataTime lTime = dTime.ToFileTime();</code>
        </pre>
      </td>
    </tr>

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

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

      <td>
        <p>Les batches dont la date de fin de traitement dans le cadre d’un SLA n’est pas antérieure à la date spécifiée ; 0 correspond à tous les batches</p>
        <p>Pour la conversion, utilisez les méthodes suivantes (l’exemple ci-dessous est en C#) :</p>

        <pre>
          <code>DateTime dtTime; long lTime; ... // conversion de DataTime en long dTime = DataTime.FromFileTime(lTime); ... // conversion de long en DataTime lTime = dTime.ToFileTime();</code>
        </pre>
      </td>
    </tr>

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

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

      <td>
        <p>Les lots dont la date de fin de traitement dans le cadre d’un SLA n’est pas postérieure à la date spécifiée ; 0 correspond à tous les lots</p>
        <p>Pour la conversion, utilisez les méthodes suivantes (l’exemple ci-dessous est en C#) :</p>

        <pre>
          <code>DateTime dtTime; long lTime; ... // conversion de DataTime en long dTime = DataTime.FromFileTime(lTime); ... // conversion de long en DataTime lTime = dTime.ToFileTime();</code>
        </pre>
      </td>
    </tr>

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

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

      <td>
        <p>Contient un avertissement relatif à l’échéance de traitement d’un lot</p>
        <p>Les valeurs suivantes, ou leur combinaison logique (OR), sont autorisées :</p>

        <ul>
          <li>0 - les lots ne sont pas filtrés selon cet attribut</li>
          <li>1 - les lots sans échéance de traitement spécifiée</li>
          <li>2 - les lots avec une échéance de traitement qui n’est ni imminente ni atteinte</li>
          <li>4 - les lots avec une échéance de traitement imminente</li>
          <li>8 - les lots avec une échéance de traitement atteinte</li>
        </ul>
      </td>
    </tr>

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

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

      <td>
        <p>Le premier enregistrement de la liste</p>
        <p>(Les enregistrements sont numérotés à partir de l’élément 0)</p>
      </td>
    </tr>

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

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

      <td>
        <p>Le nombre de lots qu’un utilisateur tente d’obtenir</p>
      </td>
    </tr>

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

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

      <td>
        <p>Ensemble de paires « nom-valeur » utilisé pour filtrer selon les paramètres d’enregistrement</p>
        <p>(Il est possible d’envoyer uniquement 5 paires de valeurs ; les autres seront ignorées)</p>
      </td>
    </tr>
  </tbody>
</table>

<Note>
  Les lots sont triés par ID décroissant, ce qui signifie que les lots les plus récents apparaissent en tête de liste.
</Note>

<div id="returned-value">
  ## Valeur de retour
</div>

| **Type**                                                          | **Description**                                                                                   |
| ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| int                                                               | Le nombre de lots sur le serveur correspondant aux critères de filtre spécifiés                   |
| [Batch](/fr/flexi-capture/api/structures/batch-api-structures)\[] | L’ensemble des structures [Batch](/fr/flexi-capture/api/structures/batch-api-structures) achevées |