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

> Fordern Sie mit der Methode GetFilteredBatches der ABBYY FlexiCapture Web Services API einen gefilterten, paginierten Satz von Batches an, wobei Filter für Stufe, Datum und SLA verwendet werden.

<div id="what-it-does">
  ## Was es macht
</div>

Fordert vom Server gruppenweise eine gefilterte Menge von Batches an. Sie können zum Beispiel eine Anfrage senden, die wie folgt aussieht: „Gib 100 Batches zurück, die sich ab dem 500. Batch in der Erkennungsphase befinden.“

<div id="definition">
  ## Definition
</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">
  ## Parameter
</div>

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

      <td>
        <p>
          <strong>Typ</strong>
        </p>
      </td>

      <td>
        <p>
          <strong>Beschreibung</strong>
        </p>
      </td>
    </tr>

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

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

      <td>
        <p>Die ID der Verbindung zum Application Server</p>
      </td>
    </tr>

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

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

      <td>
        <p>Die ID des Projekts, das die Batch-Typen enthält, für die Informationen abgerufen werden sollen</p>
      </td>
    </tr>

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

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

      <td>
        <p>Die ID des Batch-Typs</p>

        <ul>
          <li>0 - Standard-Batch</li>
          <li>-1 - alle Batch-Typen</li>
        </ul>
      </td>
    </tr>

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

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

      <td>
        <p>
          Die Menge der Stufentypen (mögliche Werte finden Sie unter <a href="/de/flexi-capture/api/structures/processing-stage">ProcessingStage</a>), zu denen die gesuchten Batches gehören
        </p>

        <ul>
          <li>Leere Menge – alle Batches</li>
          <li>0 – Batches, die sich in keiner bestimmten Stufe befinden</li>
        </ul>
      </td>
    </tr>

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

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

      <td>
        <p>
          Die Menge an Stufen-IDs (das Feld Id in der Struktur <a href="/de/flexi-capture/api/structures/processing-stage">ProcessingStage</a>), zu denen die gesuchten Batches gehören
        </p>

        <ul>
          <li>Leere Menge - alle Batches</li>
          <li>0 - Batches, die sich in keiner bestimmten Stufe befinden</li>
        </ul>
      </td>
    </tr>

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

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

      <td>
        <p>Das Präfix des Batch-Namens. Eine leere Zeile bedeutet, dass alle Namen zulässig sind</p>
      </td>
    </tr>

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

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

      <td>
        <p>Der Zweck des Batches</p>
        <p>Mögliche Werte:</p>

        <ul>
          <li>0 - Batches mit Daten</li>
          <li>1 - Batches zum Trainieren des Matchings von Document Definitions</li>
          <li>2 - Batches zum Trainieren von Klassifikatoren</li>
        </ul>
      </td>
    </tr>

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

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

      <td>
        <p>Batches, die nach dem angegebenen Datum erstellt wurden; 0 steht für alle Batches</p>
        <p>Verwenden Sie für die Konvertierung die folgenden Methoden (das nachstehende Beispiel ist in C#):</p>

        <pre>
          <code>DateTime dtTime; long lTime; ... // Konvertierung von DataTime in long dTime = DataTime.FromFileTime(lTime); ... // Konvertierung von long in DataTime lTime = dTime.ToFileTime();</code>
        </pre>
      </td>
    </tr>

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

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

      <td>
        <p>Batches, die frühestens am angegebenen Datum erstellt wurden; 0 steht für alle Batches</p>
        <p>Für die Konvertierung verwenden Sie die folgenden Methoden (das folgende Beispiel ist in C#):</p>

        <pre>
          <code>DateTime dtTime; long lTime; ... // Konvertierung von DataTime zu long dTime = DataTime.FromFileTime(lTime); ... // Konvertierung von long zu DataTime lTime = dTime.ToFileTime();</code>
        </pre>
      </td>
    </tr>

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

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

      <td>
        <p>Batches, deren Verarbeitungsenddatum im Rahmen einer SLA nicht vor dem angegebenen Datum liegt; 0 steht für alle Batches</p>
        <p>Verwenden Sie für die Konvertierung die folgenden Methoden (das folgende Beispiel ist in C#):</p>

        <pre>
          <code>DateTime dtTime; long lTime; ... // Konvertierung von DataTime in long dTime = DataTime.FromFileTime(lTime); ... // Konvertierung von long in DataTime lTime = dTime.ToFileTime();</code>
        </pre>
      </td>
    </tr>

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

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

      <td>
        <p>Batches, deren SLA-Verarbeitungsenddatum nicht nach dem angegebenen Datum liegt; 0 steht für alle Batches</p>
        <p>Verwenden Sie für die Konvertierung die folgenden Methoden (das folgende Beispiel ist in C#):</p>

        <pre>
          <code>DateTime dtTime; long lTime; ... // Konvertierung von DataTime in long dTime = DataTime.FromFileTime(lTime); ... // Konvertierung von long in DataTime lTime = dTime.ToFileTime();</code>
        </pre>
      </td>
    </tr>

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

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

      <td>
        <p>Enthält eine Warnung bezüglich der Verarbeitungsfrist eines Batches</p>
        <p>Die folgenden Werte oder ihre logische Summe (OR) sind zulässig:</p>

        <ul>
          <li>0 - Batches werden nicht nach diesem Attribut gefiltert</li>
          <li>1 - Batches ohne angegebene Verarbeitungsfrist</li>
          <li>2 - Batches mit einer Verarbeitungsfrist, die weder bevorsteht noch erreicht ist</li>
          <li>4 - Batches mit einer bevorstehenden Verarbeitungsfrist</li>
          <li>8 - Batches mit einer erreichten Verarbeitungsfrist</li>
        </ul>
      </td>
    </tr>

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

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

      <td>
        <p>Der erste Datensatz in der Liste</p>
        <p>(Datensätze werden ab dem Element mit Index null nummeriert)</p>
      </td>
    </tr>

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

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

      <td>
        <p>Die Anzahl der Batches, die ein Benutzer abrufen möchte</p>
      </td>
    </tr>

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

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

      <td>
        <p>Die Menge der „Name-Wert“-Paare, die zum Filtern nach Registrierungsparametern verwendet wird</p>
        <p>(Es dürfen nur 5 Wertepaaren gesendet werden, andere Paare werden ignoriert)</p>
      </td>
    </tr>
  </tbody>
</table>

<Note>
  Batches sind nach IDs in absteigender Reihenfolge sortiert. Das bedeutet, dass die neuesten Batches oben in der Liste zurückgegeben werden.
</Note>

<div id="returned-value">
  ## Rückgabewert
</div>

| **Typ**                                                           | **Beschreibung**                                                                                       |
| ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
| int                                                               | Die Anzahl der Batches auf dem Server, die den angegebenen Filterkriterien entsprechen                 |
| [Batch](/de/flexi-capture/api/structures/batch-api-structures)\[] | Die Sammlung abgeschlossener [Batch](/de/flexi-capture/api/structures/batch-api-structures)-Strukturen |