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

# AddNewDocument

> ABBYY FlexiCapture ウェブサービス API の AddNewDocument メソッドは、画像ファイルから新しいドキュメントをバッチに追加し、そのアセンブリと挿入位置を制御します。

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

画像ファイルから新しいDocumentをバッチに追加します。

画像なしでDocumentを作成するには、file パラメーターを空のままにします (file.Name = "", file.Bytes = new bytes \[0]) 。

新しいDocumentは、**excludeFromAutomaticAssembling** フラグが **true** に設定された状態で作成されます。このフラグは、そのDocumentがすでにアセンブリ済みであり、バッチタイプに指定されたアセンブリ設定がそのDocumentには適用されないことを示します。

<Warning>
  新しく追加したDocumentにアクセスできるようになるのは、その画像の前処理が完了した後です。新しいDocumentを追加した後にバッチ処理を開始するには、[ProcessBatch](/ja/flexi-capture/api/methods/process-batch) メソッドを使用します。
</Warning>

<Note>
  新しいDocumentをバッチに追加する場合、対応するオブジェクトの Id フィールドは空であってはなりません。
</Note>

PDF Documentを追加し、そのテキストレイヤーに保存されているテキストをプログラムで使用したい場合は、それらのDocumentの処理に使用される Project で、**OCR の代わりに PDF テキストレイヤーを使用** オプションが選択されていることを確認してください (このオプションは **処理** タブの **ページのプロパティ** ダイアログにあります) 。

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

```
int AddNewDocument( int sessionId, Document document, File file, bool excludeFromAutomaticAssembling, int previousItemId );
```

<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>document</p>
      </td>

      <td>
        <p>
          <a href="/ja/flexi-capture/api/structures/document">Document</a>
        </p>
      </td>

      <td>
        <p>作成するDocumentの説明</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>Document画像を含むファイル</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>excludeFromAutomaticAssembling</p>
      </td>

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

      <td>
        <p>DocumentをDocumentアセンブリの対象から除外するかどうかを示すフラグです。</p>

        <ul>
          <li>
            <strong>True</strong> - Documentはすでにアセンブリ済みであり、Documentアセンブリには含まれません。
          </li>

          <li>
            <strong>False</strong> - Documentは、バッチタイプに指定された設定に従ってアセンブリされます。
          </li>
        </ul>
      </td>
    </tr>

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

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

      <td>
        <p>セット内での新しいDocumentの位置を明示的に指定する ID です。</p>

        <ul>
          <li>
            <strong>-1</strong> - 新しいDocumentはセットの末尾に追加されます
          </li>

          <li>
            <strong>0</strong> - 新しいDocumentはセットの先頭に追加されます
          </li>

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

            <br />

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

<Note>
  [POST リクエスト](/ja/flexi-capture/api/files/files)を使用してDocument画像を追加することもできます。この場合は、このメソッドで空のファイルを持つDocumentを作成します (file.Name = "FileName", file.Bytes = new bytes
  \[0])。その後、次のパラメーターを指定して POST リクエストを実行します。
</Note>

* Action = Save
* objectType = 0
* objectId = documentId (documentId は AddNewDocument メソッドによって返される document ID)
* version = 0
* streamName = "C:\Temp\image.pdf" (image.pdf は、AddNewDocument メソッドの呼び出し時に指定したファイル名です)

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

| **型** | **説明**            |
| ----- | ----------------- |
| int   | 作成されたDocumentの ID |