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

# Document

> ABBYY FlexiCapture Web Services API の Document データ型。ID、バッチ、ページ、処理ステージ、ステータスフラグ、エラーなどのドキュメント詳細を保持します。

<div id="what-it-does">
  ## 概要
</div>

**Document** データ型には、ドキュメントに関する情報が格納されます。

<div id="fields">
  ## Fields
</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>ID</p>
      </td>

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

      <td>
        <p>ドキュメントのID。</p>

        <p>
          ドキュメントにIDを設定するには、<a href="/ja/flexi-capture/api/methods/get-batch-ids-range">GetBatchIdsRange</a> メソッドを使用して新しいドキュメント用のIDを予約する以外に方法はありません。ドキュメントをバッチに追加する前に、IDを設定することをお勧めします。
        </p>

        <p>IDの値を -1 に設定すると、ドキュメントIDは自動的に生成されます。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>BatchId</p>
      </td>

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

      <td>
        <p>バッチのID</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>ParentId</p>
      </td>

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

      <td>
        <p>セットの親ドキュメントのIDです。</p>
        <p>新しいドキュメントをセットの一部にする場合は、このフィールドにセットの親ドキュメントの値を設定する必要があります。</p>
        <p>新しいドキュメントをどのセットにも含めない場合は、このフィールドの値を0に設定します。</p>

        <p>
          <strong>重要:</strong> 親ドキュメントは、子ドキュメントを作成する前に作成しておく必要があります。
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>ChildrenOrder</p>
      </td>

      <td>
        <p>
          <a href="/ja/flexi-capture/api/structures/children-order">ChildrenOrder</a> \[]
        </p>
      </td>

      <td>
        <p>セット内の文書を並べ替えるための子文書のセットです。</p>
        <p>サーバーからデータを読み込むと、このフィールドは自動的に設定されます。</p>
        <p>このフィールドが空の場合、セット内の文書は追加された順序で並べられます。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>DocIndex</p>
      </td>

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

      <td>
        <p>ドキュメントのインデックス番号</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>TemplateName</p>
      </td>

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

      <td>
        <p>Document Definitionの名前</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>ProcessingStageType</p>
      </td>

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

      <td>
        <p>
          処理ステージの型。値は<a href="/ja/flexi-capture/api/structures/t-processing-stage-type">ProcessingStageType</a>の値です
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>備考</p>
      </td>

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

      <td>
        <p>備考</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Pages</p>
      </td>

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

      <td>
        <p>ドキュメントに含まれるページ</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>IsProcessed</p>
      </td>

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

      <td>
        <p>ドキュメントが処理されたかどうかを示すフラグ</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>HasProcessingErrors</p>
      </td>

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

      <td>
        <p>処理エラーがあったかどうかを示すフラグ</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>HasDocumentErrors</p>
      </td>

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

      <td>
        <p>ドキュメントにエラー (例：形式エラー、ルール エラー、アセンブリ エラー) があるかどうかを示すフラグ</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>ErrorText</p>
      </td>

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

      <td>
        <p>文書処理エラーの説明</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>ExternalId</p>
      </td>

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

      <td>
        <p>ドキュメントの外部 ID</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>プロパティ</p>
      </td>

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

      <td>
        <p>ドキュメントの登録パラメーターの一覧</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Priority</p>
      </td>

      <td>
        <p>
          <a href="/ja/flexi-capture/api/structures/t-priority">Priority</a>\[]
        </p>
      </td>

      <td>
        <p>ドキュメントの優先度</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>FileVersion</p>
      </td>

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

      <td>
        <p>サーバー上にあるドキュメントファイルのバージョン</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>OwnerId</p>
      </td>

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

      <td>
        <p>Projectの所有者であるユーザーまたはグループのID</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>StageExternalId</p>
      </td>

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

      <td>
        <p>タスクが作成された処理ステージのID (バッチタイプ内で一意) </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>TaskId</p>
      </td>

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

      <td>
        <p>ドキュメントが属するタスクの ID</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>UncertainSymbols</p>
      </td>

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

      <td>
        <p>認識が不確かな文字数</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>VerificationSymbols</p>
      </td>

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

      <td>
        <p>検証済み文字数</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>TotalSymbols</p>
      </td>

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

      <td>
        <p>ドキュメント内の文字総数</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>HasErrors</p>
      </td>

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

      <td>
        <p>検証ルール エラーがあるかどうかを示すフラグ</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>HasWarnings</p>
      </td>

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

      <td>
        <p>検証ルールに関する警告があるかどうかを示すフラグ</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>HasAssemblingErrors</p>
      </td>

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

      <td>
        <p>組み立て時のエラーの有無を示すフラグ</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>HasAttachments</p>
      </td>

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

      <td>
        <p>ドキュメントに添付ファイルがあるかどうかを示すフラグ</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Flags</p>
      </td>

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

      <td>
        <p>ドキュメントのステータスを示すフラグのセットです。field の値は、次のフラグ値を組み合わせたものです。</p>

        <ul>
          <li>BIF\_IsAnalyzed = 0x100 は、ドキュメントが解析済みであることを示します。</li>
          <li>BIF\_IsRecognized = 0x200 は、ドキュメントが認識済みであることを示します。</li>
          <li>BIF\_IsVerified = 0x400 は、ドキュメントが検証済みであることを示します。</li>
          <li>BIF\_IsExported = 0x800 は、ドキュメントがエクスポート済みであることを示します。</li>
          <li>BIF\_HasRuleErrors = 0x10000 は、ドキュメントに rule の実行エラーが含まれていることを示します。</li>
          <li>BIF\_HasRuleWarnings = 0x20000 - ドキュメントに rule の実行警告が含まれていることを示します。</li>
          <li>BIF\_HasMergeVersionErrors = 0x80000 - ドキュメントに二重検証結果のマージ エラー (検証結果が一致しない) が含まれていることを示します。</li>
          <li>BIF\_HasUserAttachments = 0x100000 - ドキュメントに添付ファイルがあることを示します。</li>
          <li>BIF\_HasUnmatchedFieldErrors = 0x200000 - ドキュメントに未照合のfieldが含まれていることを示します。</li>
          <li>BIF\_NeedsPreprocessing = 0x800000 - ドキュメントで前処理が必要であることを示します。</li>
          <li>BIF\_IsManuallyCreated = 0x1000000 - ドキュメントが手動で作成されたことを示します。</li>
          <li>BIF\_IsExcludedFromAutomaticAssembling = 0x2000000 - ドキュメントが自動アセンブリから除外されていることを示します。</li>
          <li>BIF\_IsSourceImageAttached = 0x4000000 - ドキュメントに元の画像ファイルが添付されていることを示します。</li>
        </ul>

        <p>
          <strong>注:</strong> ここでは、タスクおよび <a href="/ja/flexi-capture/api/methods/methods">Web Services API のメソッド</a> の操作時に役立つフラグのみを示しています。
        </p>
      </td>
    </tr>
  </tbody>
</table>