Saltar al contenido principal

Descripción

El tipo de dato Document almacena información sobre un documento.

Fields

ID

int

El ID de un documento.

La única forma de asignar un ID a un documento es usar el método GetBatchIdsRange, que permite reservar ID para documentos nuevos. Recomendamos asignar un ID a un documento antes de agregarlo a un lote.

Si establece su valor en -1, se generará automáticamente un ID de documento.

BatchId

int

El ID del lote

ParentId

int

El ID del documento principal del conjunto.

Si un documento nuevo debe formar parte de un conjunto, a este campo debe asignársele el valor del documento principal del conjunto.

Si un documento nuevo no debe formar parte de ningún conjunto, establezca el valor del campo en 0.

¡Importante! El documento principal debe crearse antes que los documentos secundarios.

ChildrenOrder

ChildrenOrder []

Un conjunto de documentos secundarios que permite ordenar los documentos del conjunto.

Cuando se leen los datos del servidor, el campo se rellena automáticamente.

Si este campo está vacío, los documentos del conjunto se ordenarán en el orden en que se añadieron.

DocIndex

int

Índice del documento

TemplateName

string

El nombre de la Definición de Document

ProcessingStageType

int

El tipo de la etapa de procesamiento; los valores proceden de ProcessingStageType

Comentario

cadena

Comentario

Pages

Page[]

Las páginas del documento

IsProcessed

bool

Un indicador que señala si el documento se ha procesado o no

HasProcessingErrors

bool

Indicador de si hubo errores de procesamiento

HasDocumentErrors

bool

Una marca que indica si hay errores en el documento (p. ej., errores de formato, de validación o de ensamblado)

ErrorText

string

Una descripción de los errores de procesamiento de documentos

ExternalId

string

El ID externo del documento

Propiedades

RegistrationProperty[]

Los parámetros de registro del documento

Priority

Priority[]

Prioridad del documento

FileVersion

int

La versión del archivo de documento en el servidor

OwnerId

int

El ID del usuario o grupo propietario del proyecto

StageExternalId

int

El ID de la etapa de procesamiento en la que se creó la tarea (único dentro del tipo de lote)

TaskId

int

El ID de la tarea a la que pertenece el documento

UncertainSymbols

int

El número de caracteres dudosos

VerificationSymbols

int

El número de caracteres verificados

TotalSymbols

int

El número total de caracteres del documento

HasErrors

bool

Un indicador que muestra si hay errores de reglas de validación

HasWarnings

bool

Un indicador que muestra si hay advertencias de reglas de validación

HasAssemblingErrors

bool

Un indicador que indica si hubo errores de ensamblado

HasAttachments

bool

Un indicador que indica si el documento tiene archivos adjuntos

Flags

int

Un conjunto de flags que describen el estado del documento. El valor de un campo es una combinación de los valores de los flags, que incluyen:

  • BIF_IsAnalyzed = 0x100 indica que el documento está analizado;
  • BIF_IsRecognized = 0x200 indica que el documento está reconocido;
  • BIF_IsVerified = 0x400 indica que el documento está verificado;
  • BIF_IsExported = 0x800 indica que el documento está exportado;
  • BIF_HasRuleErrors = 0x10000 indica que el documento contiene errores en la ejecución de reglas;
  • BIF_HasRuleWarnings = 0x20000 - indica que el documento contiene advertencias en la ejecución de reglas;
  • BIF_HasMergeVersionErrors = 0x80000 - indica que el documento contiene errores al fusionar resultados de doble verificación (los resultados de verificación no coinciden);
  • BIF_HasUserAttachments = 0x100000 - indica que el documento tiene archivos adjuntos;
  • BIF_HasUnmatchedFieldErrors = 0x200000 - indica que el documento contiene campos sin coincidencia;
  • BIF_NeedsPreprocessing = 0x800000 - indica que el documento necesita preprocesamiento;
  • BIF_IsManuallyCreated = 0x1000000 - indica que el documento se creó manualmente;
  • BIF_IsExcludedFromAutomaticAssembling = 0x2000000 - indica que el documento está excluido del ensamblado automático;
  • BIF_IsSourceImageAttached = 0x4000000 - indica que hay un archivo de imagen de origen adjunto al documento.

Nota: Solo se enumeran los flags que resultan útiles al trabajar con las tareas y los métodos de la API de servicios web.