Japanese (日本語) - Change language

Document

操作

Documentデータ型は文書に関する情報を格納します。

フィールド

名前 記述
Id int

文書のID。

文書をバッチに追加する前に文書IDを設定することをおすすめします。GetBatchIdsRange方法を使用して、新しい文書のIDを予約します。

BatchId int バッチのID
ParentId int

セットの親文書のID。

新しい文書をセットの一部にする場合は、このフィールドにセットの親文書の値を割り当てます。

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

重要!子文書を作成する前に親文書を作成する必要があります。

ChildrenOrder ChildrenOrder []

セットの文書の並べ替えを可能にする子文書のセット。

データがサーバーから読み取られると、フィールドは自動的に入力されます。

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

DocIndex int 文書インデックス
TemplateName string 文書定義の名前
ProcessingStageType int 処理段階の型、ProcessingStageTypeの値
Comment string コメント
Pages Page[] 文書のページのセット
IsProcessed bool 文書が処理されたかを示すフラグ
HasProcessingErrors bool 処理エラーがあったかを示すフラグ
HasDocumentErrors bool 文書にエラーがあるかを示すフラグ (形式エラー、規則エラー、組み込みエラーなど)
ErrorText string 文書処理エラーの記述。
ExternalId string 文書の外部ID。
Properties RegistrationProperty[] 文書の登録パラメータのセット
Priority Priority[] 文書優先度
FileVersion int サーバーの文書ファイルのバージョン
ownerId int プロジェクトを所有するユーザーまたはグループのID
StageExternalId int タスクが作成された処理段階のID (バッチ型内で一意)
taskId int 文書が属するタスクのID
UncertainSymbols int 不確実な文字の数
VerificationSymbols int 検証された文字数
TotalSymbols int 文書の文字総数
HasErrors bool 検証規則エラーがあるかを示すフラグ
HasWarnings bool 検証規則警告があるかを示すフラグ
HasAssemblingErrors bool 組み込みエラーがあったかを示すフラグ
HasAttachments bool 文書に添付があるかを示すフラグ
Flags int

文書のステータスを記述するフラグのセットです。フィールドの値はフラグの値の組み合わせで、以下を含みます:

  • BIF_IsAnalyzed = 0x100は文書が分析されていることを示します
  • BIF_IsRecognized = 0x200は文書が認識されていることを示します
  • BIF_IsVerified = 0x400は文書が検証されていることを示します
  • BIF_IsExported = 0x800は文書がエクスポートされていることを示します
  • BIF_HasRuleErrors = 0x10000は文書が規則の実行エラーを含んでいることを示します
  • BIF_HasRuleWarnings = 0x20000は文書が規則の実行警告を含んでいることを示します
  • BIF_HasMergeVersionErrors = 0x80000は文書が二重検証結果の結合エラーを含んでいることを示します (検証結果が合致しない)
  • BIF_HasUserAttachments = 0x100000は文書に添付があることを示します
  • BIF_HasUnmatchedFieldErrors = 0x200000は文書が合致しないフィールドを含んでいることを示します
  • BIF_NeedsPreprocessing = 0x800000は文書に前処理が必要なことを示します
  • BIF_IsManuallyCreated = 0x1000000は文書が手動で作成されたことを示します
  • BIF_IsExcludedFromAutomaticAssembling = 0x2000000は文書が自動組み込みから除外されていることを示します
  • BIF_IsSourceImageAttached = 0x4000000はソース画像ファイルが文書に添付されていることを示します

注:ウェブサービスAPIの方法とタスクを操作する時に便利なフラグのみがリストに入ります。

10.11.2020 12:08:06


Please leave your feedback about this article