Zum Hauptinhalt springen

Funktion

Der Document-Datentyp speichert Informationen zu einem Dokument.

fields

Id

int

Die ID eines Dokuments.

Eine ID für ein Dokument kann nur mit der Methode GetBatchIdsRange festgelegt werden, mit der sich IDs für neue Dokumente reservieren lassen. Wir empfehlen, einem Dokument eine ID zuzuweisen, bevor Sie es einem Batch hinzufügen.

Eine Dokument-ID wird automatisch generiert, wenn Sie ihren Wert auf -1 setzen.

BatchId

int

Die ID des Batchs

ParentId

int

Die ID des übergeordneten Dokuments im Set.

Wenn ein neues Dokument Teil eines Sets sein soll, muss diesem Feld der Wert des übergeordneten Dokuments im Set zugewiesen werden.

Wenn ein neues Dokument zu keinem Set gehören soll, setzen Sie den Wert dieses Feldes auf 0.

Wichtig! Das übergeordnete Dokument muss erstellt werden, bevor untergeordnete Dokumente erstellt werden.

ChildrenOrder

ChildrenOrder []

Eine Sammlung untergeordneter Dokumente, die das Sortieren der Dokumente in der Sammlung ermöglicht.

Wenn Daten vom Server gelesen werden, wird das Feld automatisch ausgefüllt.

Wenn dieses Feld leer ist, werden die Dokumente in der Sammlung in der Reihenfolge angeordnet, in der sie hinzugefügt wurden.

DocIndex

int

Index des Dokuments

TemplateName

string

Name der Document Definition

ProcessingStageType

int

Der Typ der Verarbeitungsstufe; die Werte sind in ProcessingStageType definiert

Kommentar

string

Kommentar

Pages

Page[]

Die Seiten im Dokument

IsProcessed

bool

Ein Flag, das angibt, ob das Dokument verarbeitet wurde

HasProcessingErrors

bool

Ein Flag, das anzeigt, ob Verarbeitungsfehler aufgetreten sind

HasDocumentErrors

bool

Ein Flag, das angibt, ob das Dokument Fehler enthält (z. B. Formatfehler, Regelfehler, Zusammenstellungsfehler)

ErrorText

string

Beschreibung der Fehler bei der Dokumentenverarbeitung

ExternalId

string

Die externe ID des Dokuments

Eigenschaften

RegistrationProperty[]

Die Registrierungsparameter des Dokuments

Priorität

Priority[]

Dokumentpriorität

FileVersion

int

Die Version der auf dem Server gespeicherten Dokumentdatei

OwnerId

int

Die ID des Users oder der Gruppe, dem bzw. der das Projekt gehört

StageExternalId

int

Die ID der Verarbeitungsstufe, in der die Aufgabe erstellt wurde (innerhalb des Batch-Typs eindeutig)

TaskId

int

Die ID der Aufgabe, zu der das Dokument gehört

UncertainSymbols

int

Die Anzahl der unsicheren Zeichen

VerificationSymbols

int

Anzahl verifizierter Zeichen

TotalSymbols

int

Die Gesamtzahl der Zeichen im Dokument

HasErrors

bool

Ein Flag, das angibt, ob Regelfehler vorliegen

HasWarnings

bool

Ein Flag, das angibt, ob Warnungen zu Validierungsregeln vorliegen

HasAssemblingErrors

bool

Ein Flag, das angibt, ob beim Zusammenfügen Fehler aufgetreten sind

HasAttachments

bool

Ein Flag, das anzeigt, ob das Dokument Anhänge enthält

Flags

int

Ein Satz von Flags, die den Status des Dokuments beschreiben. Der Wert eines Feldes ist eine Kombination aus den Werten der Flags, darunter:

  • BIF_IsAnalyzed = 0x100 zeigt an, dass das Dokument analysiert wurde;
  • BIF_IsRecognized = 0x200 zeigt an, dass das Dokument erkannt wurde;
  • BIF_IsVerified = 0x400 zeigt an, dass das Dokument verifiziert wurde;
  • BIF_IsExported = 0x800 zeigt an, dass das Dokument exportiert wurde;
  • BIF_HasRuleErrors = 0x10000 zeigt an, dass das Dokument Fehler bei der Regelausführung enthält;
  • BIF_HasRuleWarnings = 0x20000 - zeigt an, dass das Dokument Warnungen bei der Regelausführung enthält;
  • BIF_HasMergeVersionErrors = 0x80000 - zeigt an, dass das Dokument Fehler beim Zusammenführen der Ergebnisse der doppelten Verifizierung enthält (die Verifizierungsergebnisse stimmen nicht überein);;
  • BIF_HasUserAttachments = 0x100000 - zeigt an, dass das Dokument Anhänge enthält;
  • BIF_HasUnmatchedFieldErrors = 0x200000 - zeigt an, dass das Dokument nicht abgeglichene Felder enthält;
  • BIF_NeedsPreprocessing = 0x800000 - zeigt an, dass das Dokument vorverarbeitet werden muss;
  • BIF_IsManuallyCreated = 0x1000000 - zeigt an, dass das Dokument manuell erstellt wurde;
  • BIF_IsExcludedFromAutomaticAssembling = 0x2000000 - zeigt an, dass das Dokument von der automatischen Zusammenstellung ausgeschlossen ist;
  • BIF_IsSourceImageAttached = 0x4000000 - zeigt an, dass dem Dokument eine Quellbilddatei angehängt ist.

Hinweis: Es sind nur die Flags aufgeführt, die bei der Arbeit mit den Aufgaben und Methoden der Web Services API relevant sind.