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

> ステージ、date、SLA フィルターを使用して、ABBYY FlexiCapture Web Services API の GetFilteredBatches メソッドで、条件に一致するバッチのセットをページ分けして要求します。

<div id="what-it-does">
  ## 何をするか
</div>

フィルターされたBatchesのセットを、グループ単位でサーバーからリクエストします。たとえば、次のようなリクエストを送信できます。「500 番目のバッチから開始し、認識ステージにあるバッチを 100 件返す。」"

<div id="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">
  ## パラメーター
</div>

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

      <td>
        <p>
          <strong>型</strong>
        </p>
      </td>

      <td>
        <p>
          <strong>説明</strong>
        </p>
      </td>
    </tr>

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

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

      <td>
        <p>Application Server への接続ID</p>
      </td>
    </tr>

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

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

      <td>
        <p>情報を取得する対象のバッチタイプを含むプロジェクトのID。</p>
      </td>
    </tr>

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

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

      <td>
        <p>バッチタイプのID</p>

        <ul>
          <li>0 - 既定のバッチ</li>
          <li>-1 - すべてのバッチタイプ</li>
        </ul>
      </td>
    </tr>

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

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

      <td>
        <p>
          探しているバッチが含まれるステージ型のセット (指定可能な値については<a href="/ja/flexi-capture/api/structures/processing-stage">ProcessingStage</a>を参照)
        </p>

        <ul>
          <li>空のセット - すべてのバッチ</li>
          <li>0 - 特定のステージに属していないバッチ</li>
        </ul>
      </td>
    </tr>

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

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

      <td>
        <p>
          探しているバッチが含まれるステージ ID (<a href="/ja/flexi-capture/api/structures/processing-stage">ProcessingStage</a> 構造体の Id field) の集合
        </p>

        <ul>
          <li>空の集合 - すべてのバッチ</li>
          <li>0 - 特定のステージに属していないバッチ</li>
        </ul>
      </td>
    </tr>

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

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

      <td>
        <p>バッチ名の接頭辞。空欄は任意の名前を使用できることを示します</p>
      </td>
    </tr>

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

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

      <td>
        <p>バッチの用途</p>
        <p>指定可能な値:</p>

        <ul>
          <li>0 - データを含むバッチ</li>
          <li>1 - Document Definition のマッチング学習用バッチ</li>
          <li>2 - 分類器の学習用バッチ</li>
        </ul>
      </td>
    </tr>

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

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

      <td>
        <p>指定した日付より後に作成されたバッチ。0 はすべてのバッチを表します</p>
        <p>変換には次のメソッドを使用します (以下の例は C#) 。</p>

        <pre>
          <code>DateTime dtTime; long lTime; ... // DataTime から long への変換 dTime = DataTime.FromFileTime(lTime); ... // long から DataTime への変換 lTime = dTime.ToFileTime();</code>
        </pre>
      </td>
    </tr>

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

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

      <td>
        <p>指定した日付以降に作成されたバッチ。0 はすべてのバッチを表します</p>
        <p>変換するには、次のメソッドを使用します (以下は C# の例です) 。</p>

        <pre>
          <code>DateTime dtTime; long lTime; ... // DataTime から long への変換 dTime = DataTime.FromFileTime(lTime); ... // long から DataTime への変換 lTime = dTime.ToFileTime();</code>
        </pre>
      </td>
    </tr>

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

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

      <td>
        <p>SLA における処理終了日が指定した日付以前ではない batch。0 はすべての batch を表します</p>
        <p>変換には、次のメソッドを使用します (以下の例は C#) 。</p>

        <pre>
          <code>DateTime dtTime; long lTime; ... // DataTime から long への変換 dTime = DataTime.FromFileTime(lTime); ... // long から DataTime への変換 lTime = dTime.ToFileTime();</code>
        </pre>
      </td>
    </tr>

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

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

      <td>
        <p>SLA における処理終了日が指定した日付以前の Batches。0 はすべての batch を表します</p>
        <p>変換には次のメソッドを使用します (以下の例は C# です) 。</p>

        <pre>
          <code>DateTime dtTime; long lTime; ... // DataTime から long への変換 dTime = DataTime.FromFileTime(lTime); ... // long から DataTime への変換 lTime = dTime.ToFileTime();</code>
        </pre>
      </td>
    </tr>

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

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

      <td>
        <p>バッチの処理期限に関する警告を含みます</p>
        <p>次の値、またはそれらの論理和 (OR) を指定できます：</p>

        <ul>
          <li>0 - この属性ではバッチは絞り込まれません</li>
          <li>1 - 処理期限が指定されていないバッチ</li>
          <li>2 - 処理期限が近づいておらず、期限にも達していないバッチ</li>
          <li>4 - 処理期限が近づいているバッチ</li>
          <li>8 - 処理期限に達したバッチ</li>
        </ul>
      </td>
    </tr>

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

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

      <td>
        <p>リストの先頭レコード</p>
        <p> (レコード番号は 0 から始まります) </p>
      </td>
    </tr>

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

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

      <td>
        <p>ユーザーが取得しようとするbatch数</p>
      </td>
    </tr>

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

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

      <td>
        <p>登録パラメーターでフィルタリングするために使用される「name–value」ペアのセット</p>
        <p> (送信できる値のペアは 5 件までで、それ以外のペアは無視されます) </p>
      </td>
    </tr>
  </tbody>
</table>

<Note>
  Batches は ID の降順で並べ替えられるため、最新のバッチがリストの先頭に返されます。
</Note>

<div id="returned-value">
  ## 戻り値
</div>

| **型**                                                             | **説明**                                                                      |
| ----------------------------------------------------------------- | --------------------------------------------------------------------------- |
| int                                                               | 指定したフィルター条件に一致するサーバー上のBatches数                                              |
| [Batch](/ja/flexi-capture/api/structures/batch-api-structures)\[] | 完了した [Batch](/ja/flexi-capture/api/structures/batch-api-structures) 構造体のセット |