> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Document

> Type de données Document dans l’API Web Services FlexiCapture d’ABBYY : contient des informations sur le document, notamment l’ID, le lot, les pages, l’étape de traitement, les indicateurs d’état et les erreurs.

<div id="what-it-does">
  ## Description
</div>

Le type de données **Document** stocke des informations sur un document.

<div id="fields">
  ## Fields
</div>

<table width="100%">
  <tbody>
    <tr>
      <td>
        <p>
          <strong>Name</strong>
        </p>
      </td>

      <td>
        <p>
          <strong>Type</strong>
        </p>
      </td>

      <td>
        <p>
          <strong>Description</strong>
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>ID</p>
      </td>

      <td>
        <p>int</p>
      </td>

      <td>
        <p>ID d’un document.</p>

        <p>
          La seule façon d’attribuer un ID à un document consiste à utiliser la méthode <a href="/fr/flexi-capture/api/methods/get-batch-ids-range">GetBatchIdsRange</a>, qui permet de réserver des ID pour de nouveaux documents. Nous
          vous recommandons d’attribuer un ID à un document avant de l’ajouter à un lot.
        </p>

        <p>Un ID de document sera généré automatiquement si vous définissez sa valeur sur -1.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>BatchId</p>
      </td>

      <td>
        <p>int</p>
      </td>

      <td>
        <p>L’ID du lot</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>ParentId</p>
      </td>

      <td>
        <p>int</p>
      </td>

      <td>
        <p>L’ID du document parent du jeu.</p>
        <p>Si un nouveau document doit faire partie d’un jeu, ce champ doit prendre la valeur du document parent du jeu.</p>
        <p>Si un nouveau document ne doit faire partie d’aucun jeu, définissez la valeur du champ sur 0.</p>

        <p>
          <strong>Important ! </strong> Le document parent doit être créé avant les documents enfants.
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>ChildrenOrder</p>
      </td>

      <td>
        <p>
          <a href="/fr/flexi-capture/api/structures/children-order">ChildrenOrder</a> \[]
        </p>
      </td>

      <td>
        <p>Jeu de documents enfants permettant de trier les documents du jeu.</p>
        <p>Lorsque les données sont lues à partir du serveur, le champ est renseigné automatiquement.</p>
        <p>Si ce champ est vide, les documents du jeu seront classés dans l’ordre dans lequel ils ont été ajoutés.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>DocIndex</p>
      </td>

      <td>
        <p>int</p>
      </td>

      <td>
        <p>Indice de document</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>TemplateName</p>
      </td>

      <td>
        <p>string</p>
      </td>

      <td>
        <p>Le nom de la définition de document</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>ProcessingStageType</p>
      </td>

      <td>
        <p>int</p>
      </td>

      <td>
        <p>
          Le type de l’étape de traitement ; les valeurs sont issues de <a href="/fr/flexi-capture/api/structures/t-processing-stage-type">ProcessingStageType</a>
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Commentaire</p>
      </td>

      <td>
        <p>string</p>
      </td>

      <td>
        <p>Commentaire</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Pages</p>
      </td>

      <td>
        <p>
          <a href="/fr/flexi-capture/api/structures/page">Page</a>\[]
        </p>
      </td>

      <td>
        <p>L’ensemble des pages du document</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>IsProcessed</p>
      </td>

      <td>
        <p>bool</p>
      </td>

      <td>
        <p>Un indicateur précisant si le document a été traité ou non</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>HasProcessingErrors</p>
      </td>

      <td>
        <p>bool</p>
      </td>

      <td>
        <p>Un indicateur indiquant si des erreurs de traitement se sont produites</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>HasDocumentErrors</p>
      </td>

      <td>
        <p>bool</p>
      </td>

      <td>
        <p>Un indicateur qui indique s’il y a des erreurs dans le document (par ex. des erreurs de format, des erreurs liées aux règles, des erreurs d’assemblage)</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>ErrorText</p>
      </td>

      <td>
        <p>string</p>
      </td>

      <td>
        <p>Une description des erreurs survenues lors du traitement des documents</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>ExternalId</p>
      </td>

      <td>
        <p>string</p>
      </td>

      <td>
        <p>L’ID externe du document</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Propriétés</p>
      </td>

      <td>
        <p>
          <a href="/fr/flexi-capture/api/structures/registration-property">RegistrationProperty</a>\[]
        </p>
      </td>

      <td>
        <p>Les paramètres d’enregistrement du document</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Priority</p>
      </td>

      <td>
        <p>
          <a href="/fr/flexi-capture/api/structures/t-priority">Priority</a>\[]
        </p>
      </td>

      <td>
        <p>Priorité du document</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>FileVersion</p>
      </td>

      <td>
        <p>int</p>
      </td>

      <td>
        <p>La version du fichier du document sur le serveur</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>OwnerId</p>
      </td>

      <td>
        <p>int</p>
      </td>

      <td>
        <p>L’ID de l’utilisateur ou du Group auquel appartient le projet</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>StageExternalId</p>
      </td>

      <td>
        <p>int</p>
      </td>

      <td>
        <p>L’ID de l’étape de traitement dans laquelle la tâche a été créée (unique dans le type de lot)</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>TaskId</p>
      </td>

      <td>
        <p>int</p>
      </td>

      <td>
        <p>L’ID de la tâche à laquelle le document appartient</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>UncertainSymbols</p>
      </td>

      <td>
        <p>int</p>
      </td>

      <td>
        <p>Le nombre de caractères incertains</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>VerificationSymbols</p>
      </td>

      <td>
        <p>int</p>
      </td>

      <td>
        <p>Le nombre de caractères vérifiés</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>TotalSymbols</p>
      </td>

      <td>
        <p>int</p>
      </td>

      <td>
        <p>Le nombre total de caractères du document</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>HasErrors</p>
      </td>

      <td>
        <p>bool</p>
      </td>

      <td>
        <p>Un indicateur qui indique s’il existe des erreurs de règles de validation</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>HasWarnings</p>
      </td>

      <td>
        <p>bool</p>
      </td>

      <td>
        <p>Un indicateur indiquant s'il existe des avertissements liés aux règles de validation</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>HasAssemblingErrors</p>
      </td>

      <td>
        <p>bool</p>
      </td>

      <td>
        <p>Un indicateur indiquant s’il y a eu des erreurs d’assemblage</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>HasAttachments</p>
      </td>

      <td>
        <p>bool</p>
      </td>

      <td>
        <p>Un indicateur indiquant si le document contient des pièces jointes</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Flags</p>
      </td>

      <td>
        <p>int</p>
      </td>

      <td>
        <p>Ensemble d’indicateurs décrivant l’état du document. La valeur d’un champ est une combinaison des valeurs des indicateurs, notamment :</p>

        <ul>
          <li>BIF\_IsAnalyzed = 0x100 indique que le document est analysé ;</li>
          <li>BIF\_IsRecognized = 0x200 indique que le document est reconnu ;</li>
          <li>BIF\_IsVerified = 0x400 indique que le document est vérifié ;</li>
          <li>BIF\_IsExported = 0x800 indique que le document est exporté ;</li>
          <li>BIF\_HasRuleErrors = 0x10000 indique que le document contient des erreurs d’exécution de règles ;</li>
          <li>BIF\_HasRuleWarnings = 0x20000 - indique que le document contient des avertissements liés à l’exécution des règles ;</li>
          <li>BIF\_HasMergeVersionErrors = 0x80000 - indique que le document contient des erreurs lors de la fusion des résultats de double vérification (les résultats de vérification ne correspondent pas) ;</li>
          <li>BIF\_HasUserAttachments = 0x100000 - indique que le document comporte des pièces jointes ;</li>
          <li>BIF\_HasUnmatchedFieldErrors = 0x200000 - indique que le document contient des champs non associés ;</li>
          <li>BIF\_NeedsPreprocessing = 0x800000 - indique que le document nécessite un prétraitement ;</li>
          <li>BIF\_IsManuallyCreated = 0x1000000 - indique que le document a été créé manuellement ;</li>
          <li>BIF\_IsExcludedFromAutomaticAssembling = 0x2000000 - indique que le document est exclu de l’assemblage automatique ;</li>
          <li>BIF\_IsSourceImageAttached = 0x4000000 - indique qu’un fichier image source est joint au document.</li>
        </ul>

        <p>
          <strong>Remarque : </strong> Seuls les indicateurs utiles pour travailler avec les tâches et les <a href="/fr/flexi-capture/api/methods/methods">méthodes de l’API Web Services</a> sont répertoriés.
        </p>
      </td>
    </tr>
  </tbody>
</table>