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

# GetTaskByStageId

> ABBYY FlexiCapture Web Services API の GetTaskByStageId メソッドを使用して、指定したステージ ID で最も優先度の高いタスクを選択してロックし、その ID を返します。

<div id="what-it-does">
  ## 動作内容
</div>

最も優先度の高いタスクを選択し、処理のために開きます。選択したタスクはロックされるため、他のユーザーは開けません。

<Warning>
  タスクに対して操作を実行するには、先にそのタスクを開いておく必要があります。
</Warning>

<div id="definition">
  ## 定義
</div>

```
int GetTaskByStageId( int sessionId, int projectId, int[] stageIds, bool onlyPreprocessedTasks, bool onlyPrivateBatches );
```

<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>Description</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>stageIds</p>
      </td>

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

      <td>
        <p>タスクの取得元となるステージの ID</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>onlyPreprocessedTask</p>
      </td>

      <td>
        <p>bool</p>
      </td>

      <td>
        <p>どのタスクを選択するかを決定するフラグです。指定可能な値:</p>

        <ul>
          <li>
            <strong>True</strong> - 前処理済みのタスクのみを選択します;
          </li>

          <li>
            <strong>False</strong> - すべてのタスクから選択します。
          </li>
        </ul>
      </td>
    </tr>

    <tr>
      <td>
        <p>onlyPrivateBatches</p>
      </td>

      <td>
        <p>bool</p>
      </td>

      <td>
        <p>利用可能なバッチの範囲を決定するフラグです。指定可能な値:</p>

        <ul>
          <li>
            <strong>True</strong> - 現在のユーザーまたはユーザーグループに属するバッチのみ利用可能です;
          </li>

          <li>
            <strong>False</strong> - すべてのバッチが利用可能です。
          </li>
        </ul>
      </td>
    </tr>
  </tbody>
</table>

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

| **型** | **説明** |
| ----- | ------ |
| int   | タスク ID |