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

# AddNewPage

> ABBYY FlexiCapture ウェブサービス API の AddNewPage メソッドは、ページ画像とその説明を set 内の指定した位置でDocumentに追加します。

<div id="what-it-does">
  ## 機能
</div>

Document にページ画像を追加します。

<Warning>
  追加した画像にアクセスできるようになるのは、前処理が完了した後です。画像を追加した後にバッチ処理を開始するには、[ProcessBatch](/ja/flexi-capture/api/methods/process-batch) メソッドを使用します。別の方法として、[OpenTask](/ja/flexi-capture/api/methods/open-task) メソッドで開いたタスクの Document に画像を追加した場合は、[CloseTask](/ja/flexi-capture/api/methods/close-task) メソッドを使用してタスクを閉じ、**Import** ステージに送信することもできます。
</Warning>

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

```
int AddNewPage( int sessionId, int batchId, int documentId, int previousItemId, Page page, File file );
```

<div id="parameters">
  ## パラメーター
</div>

<table width="100%">
  <tbody>
    <tr>
      <td>
        <p>
          <strong>名前</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>batchId</p>
      </td>

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

      <td>
        <p>Document を含むバッチの ID</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>documentId</p>
      </td>

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

      <td>
        <p>ページの追加先となる Document の ID</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>previousItemId</p>
      </td>

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

      <td>
        <p>set 内で新しいページの位置を明示的に指定するための ID:</p>

        <ul>
          <li>
            <strong>-1</strong> - 新しいページは set の末尾に追加されます
          </li>

          <li>
            <strong>0</strong> - 新しいページは set の先頭に追加されます
          </li>

          <li>
            <strong>ページ ID</strong> - 新しいページはこの ID を持つページの後に追加されます

            <br />

            <strong>注: </strong> この ID を持つページが存在している必要があります。
          </li>
        </ul>
      </td>
    </tr>

    <tr>
      <td>
        <p>page</p>
      </td>

      <td>
        <p>
          <a href="/ja/flexi-capture/api/structures/page">Page</a>
        </p>
      </td>

      <td>
        <p>ページの説明です。事前定義された ID field を持つページを追加することをお勧めします</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>file</p>
      </td>

      <td>
        <p>
          <a href="/ja/flexi-capture/api/structures/file">File</a>
        </p>
      </td>

      <td>
        <p>ページ画像を含むファイル</p>
      </td>
    </tr>
  </tbody>
</table>

<Note>
  画像を含むファイルから新しいページを追加するには、[POST request](/ja/flexi-capture/api/files/files) を使用することもできます。これを行うには、このメソッドを使用して空のファイルを持つページを作成します: (file.Name =
  "FileName", file.Bytes = new bytes \[0])。次に、以下のパラメーターを指定して POST request を実行します:
</Note>

* Action = Save
* objectType = 1
* objectId = documentId (documentId は、ページを追加する Document の ID を表します)
* version = 0
* streamName = "Page 1" (1 は AddNewPage メソッドによって返されるページ ID を表します)

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

| **型** | **説明**       |
| ----- | ------------ |
| int   | 追加されたページの ID |