Document - ABBYY Documentation

Document データ型には、Document に関する情報が格納されます。

field

名前	型	説明
`Id`	`int`	Document の ID。Document に ID を設定するには、新しい Document 用の ID を予約する GetBatchIdsRange メソッドを使用します。Document をバッチに追加する前に、ID を設定してください。値を `-1` に設定すると、Document ID が自動的に生成されます。
`BatchId`	`int`	バッチの ID。
`ParentId`	`int`	セットの親 Document の ID。新しい Document がセットに含まれる場合は、この field にセットの親 Document の ID を設定します。新しい Document がどのセットにも含まれない場合は、この field の値を `0` に設定します。子 Document を作成する前に、親 Document を作成してください。
`ChildrenOrder`	ChildrenOrder[]	セット内の Document の並べ替え順を指定する子 Document のセット。サーバーからデータを読み取ると、この field は自動的に設定されます。この field が空の場合、セット内の Document は追加順に配置されます。
`DocIndex`	`int`	Document のインデックス。
`TemplateName`	`string`	Document Definition の名前。
`ProcessingStageType`	`int`	処理ステージの型。使用可能な値については、ProcessingStageType を参照してください。
`Comment`	`string`	Document に関するコメント。
`Pages`	Page[]	Document 内のページのセット。
`IsProcessed`	`bool`	Document が処理済みかどうかを示すフラグ。
`HasProcessingErrors`	`bool`	処理エラーが発生したかどうかを示すフラグ。
`HasDocumentErrors`	`bool`	Document にエラー (例：フォーマットエラー、ルールエラー、アセンブリエラー) があるかどうかを示すフラグ。
`ErrorText`	`string`	Document 処理エラーの説明。
`ExternalId`	`string`	Document の外部 ID。
`Properties`	RegistrationProperty[]	Document の登録パラメーターのセット。
`Priority`	Priority[]	Document の優先度。
`FileVersion`	`int`	サーバー上の Document ファイルのバージョン。
`OwnerId`	`int`	プロジェクトを所有するユーザーまたはグループの ID。
`StageExternalId`	`int`	タスクが作成された処理ステージの ID (バッチタイプ内で一意) 。
`TaskId`	`int`	Document が属するタスクの ID。
`UncertainSymbols`	`int`	不確実な文字の数。
`VerificationSymbols`	`int`	検証済み文字の数。
`TotalSymbols`	`int`	Document 内の文字の総数。
`HasErrors`	`bool`	検証ルールエラーがあるかどうかを示すフラグ。
`HasWarnings`	`bool`	検証ルールの警告があるかどうかを示すフラグ。
`HasAssemblingErrors`	`bool`	アセンブリエラーが発生したかどうかを示すフラグ。
`HasAttachments`	`bool`	Document に添付ファイルがあるかどうかを示すフラグ。
`Flags`	`int`	Document のステータスを示すフラグのセット。この値は、この表の後に記載されているフラグを組み合わせたものです。

Flags field の値

Flags の値は、次のフラグを組み合わせたものです。ここでは、タスクおよび Web Services API メソッドを使用する際に役立つフラグのみを示します。

フラグ	値	意味
`BIF_IsAnalyzed`	`0x100`	Document が解析されています。
`BIF_IsRecognized`	`0x200`	Document が認識されています。
`BIF_IsVerified`	`0x400`	Document が検証済みです。
`BIF_IsExported`	`0x800`	Document がエクスポート済みです。
`BIF_HasRuleErrors`	`0x10000`	Document にルール実行エラーが含まれています。
`BIF_HasRuleWarnings`	`0x20000`	Document にルール実行時の警告が含まれています。
`BIF_HasMergeVersionErrors`	`0x80000`	Document に二重検証結果のマージによるエラーが含まれています (検証結果が一致しない場合) 。
`BIF_HasUserAttachments`	`0x100000`	Document に添付ファイルがあります。
`BIF_HasUnmatchedFieldErrors`	`0x200000`	Document に未照合のfieldが含まれています。
`BIF_NeedsPreprocessing`	`0x800000`	Document に前処理が必要です。
`BIF_IsManuallyCreated`	`0x1000000`	Document が手動で作成されています。
`BIF_IsExcludedFromAutomaticAssembling`	`0x2000000`	Document が自動アセンブリの対象から除外されています。
`BIF_IsSourceImageAttached`	`0x4000000`	Document に元の画像ファイルが添付されています。