メインコンテンツへスキップ

概要

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

Fields

ID

int

ドキュメントのID。

ドキュメントにIDを設定するには、GetBatchIdsRange メソッドを使用して新しいドキュメント用のIDを予約する以外に方法はありません。ドキュメントをバッチに追加する前に、IDを設定することをお勧めします。

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

BatchId

int

バッチのID

ParentId

int

セットの親ドキュメントのIDです。

新しいドキュメントをセットの一部にする場合は、このフィールドにセットの親ドキュメントの値を設定する必要があります。

新しいドキュメントをどのセットにも含めない場合は、このフィールドの値を0に設定します。

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

ChildrenOrder

ChildrenOrder []

セット内の文書を並べ替えるための子文書のセットです。

サーバーからデータを読み込むと、このフィールドは自動的に設定されます。

このフィールドが空の場合、セット内の文書は追加された順序で並べられます。

DocIndex

int

ドキュメントのインデックス番号

TemplateName

string

Document Definitionの名前

ProcessingStageType

int

処理ステージの型。値はProcessingStageTypeの値です

備考

string

備考

Pages

Page[]

ドキュメントに含まれるページ

IsProcessed

bool

ドキュメントが処理されたかどうかを示すフラグ

HasProcessingErrors

bool

処理エラーがあったかどうかを示すフラグ

HasDocumentErrors

bool

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

ErrorText

string

文書処理エラーの説明

ExternalId

string

ドキュメントの外部 ID

プロパティ

RegistrationProperty[]

ドキュメントの登録パラメーターの一覧

Priority

Priority[]

ドキュメントの優先度

FileVersion

int

サーバー上にあるドキュメントファイルのバージョン

OwnerId

int

Projectの所有者であるユーザーまたはグループのID

StageExternalId

int

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

TaskId

int

ドキュメントが属するタスクの ID

UncertainSymbols

int

認識が不確かな文字数

VerificationSymbols

int

検証済み文字数

TotalSymbols

int

ドキュメント内の文字総数

HasErrors

bool

検証ルール エラーがあるかどうかを示すフラグ

HasWarnings

bool

検証ルールに関する警告があるかどうかを示すフラグ

HasAssemblingErrors

bool

組み立て時のエラーの有無を示すフラグ

HasAttachments

bool

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

Flags

int

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

  • BIF_IsAnalyzed = 0x100 は、ドキュメントが解析済みであることを示します。
  • BIF_IsRecognized = 0x200 は、ドキュメントが認識済みであることを示します。
  • BIF_IsVerified = 0x400 は、ドキュメントが検証済みであることを示します。
  • BIF_IsExported = 0x800 は、ドキュメントがエクスポート済みであることを示します。
  • BIF_HasRuleErrors = 0x10000 は、ドキュメントに rule の実行エラーが含まれていることを示します。
  • BIF_HasRuleWarnings = 0x20000 - ドキュメントに rule の実行警告が含まれていることを示します。
  • BIF_HasMergeVersionErrors = 0x80000 - ドキュメントに二重検証結果のマージ エラー (検証結果が一致しない) が含まれていることを示します。
  • BIF_HasUserAttachments = 0x100000 - ドキュメントに添付ファイルがあることを示します。
  • BIF_HasUnmatchedFieldErrors = 0x200000 - ドキュメントに未照合のfieldが含まれていることを示します。
  • BIF_NeedsPreprocessing = 0x800000 - ドキュメントで前処理が必要であることを示します。
  • BIF_IsManuallyCreated = 0x1000000 - ドキュメントが手動で作成されたことを示します。
  • BIF_IsExcludedFromAutomaticAssembling = 0x2000000 - ドキュメントが自動アセンブリから除外されていることを示します。
  • BIF_IsSourceImageAttached = 0x4000000 - ドキュメントに元の画像ファイルが添付されていることを示します。

注: ここでは、タスクおよび Web Services API のメソッド の操作時に役立つフラグのみを示しています。