> ## 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.

# Layout

Renvoie la structure des données capturées.

<div id="http-request">
  ## Requête HTTP
</div>

```http theme={null}
GET https://api-{location-id}.flexicapture.com/v2/training/layout/{taskId}/{fileId}
```

Remplacez `{location-id}` par l’[emplacement pris en charge](/fr/flexi-capture/cloud/cloud-f-cfor-invoices-api#icaas-supported-countries).

<div id="path-parameters">
  ## Paramètres du chemin d’accès
</div>

| Paramètre | Type         | Description                        |
| --------- | ------------ | ---------------------------------- |
| `taskId`  | path, string | Obligatoire. ID de tâche.          |
| `fileId`  | path, string | Obligatoire. ID du fichier source. |

<div id="response">
  ## Réponse
</div>

En cas de succès, le corps de la réponse contient une instance de `TrainingDataViewModel`.

```json theme={null}
{
  "task_id": "string",
  "file_id": "string",
  "pages": [
    {
      "id": 0,
      "number": 0,
      "resolution": 0,
      "height": 0,
      "width": 0
    }
  ],
  "fields": [
    {
      "name": "string",
      "value": "string",
      "rectangles": [
        {
          "page_id": 0,
          "x1": 0,
          "y1": 0,
          "x2": 0,
          "y2": 0
        }
      ],
      "cell": {
        "table_name": "string",
        "row_number": 0,
        "column_name": "string"
      }
    }
  ],
  "tables": [
    {
      "name": "string",
      "regions": [
        {
          "rectangles": [
            {
              "page_id": 0,
              "x1": 0,
              "y1": 0,
              "x2": 0,
              "y2": 0
            }
          ],
          "columns": [
            {
              "left": 0,
              "right": 0
            }
          ],
          "horizontal_separators": [
            0
          ]
        }
      ]
    }
  ]
}
```

<div id="trainingdataviewmodel">
  ### TrainingDataViewModel
</div>

| Champ     | Type                   | Description                                 |
| --------- | ---------------------- | ------------------------------------------- |
| `task_id` | string                 | Obligatoire. ID de tâche.                   |
| `file_id` | string                 | Obligatoire. ID du fichier.                 |
| `pages`   | Array\[PageViewModel]  | Facultatif. Liste des pages du document.    |
| `fields`  | Array\[FieldViewModel] | Obligatoire. Ensemble des champs capturés.  |
| `tables`  | Array\[TableViewModel] | Facultatif. Ensemble des tableaux capturés. |

<div id="pageviewmodel">
  ### PageViewModel
</div>

| Champ        | Type             | Description                                                            |
| ------------ | ---------------- | ---------------------------------------------------------------------- |
| `id`         | integer(\$int32) | Facultatif. En lecture seule. ID interne de la page.                   |
| `number`     | integer(\$int32) | Facultatif. En lecture seule. Numéro de page.                          |
| `resolution` | integer(\$int32) | Facultatif. En lecture seule. Résolution en PPP de l'image de la page. |
| `height`     | integer(\$int32) | Facultatif. En lecture seule. Hauteur de l'image de la page.           |
| `width`      | integer(\$int32) | Facultatif. En lecture seule. Largeur de l'image de la page.           |

<div id="fieldviewmodel">
  ### FieldViewModel
</div>

| Champ          | Type                           | Description                                         |
| -------------- | ------------------------------ | --------------------------------------------------- |
| `name`         | string                         | Obligatoire. Nom du champ.                          |
| `value`        | string                         | Facultatif. Valeur extraite.                        |
| `rectangles[]` | object(RectangleViewModel)     | Obligatoire. Rectangles du champ.                   |
| `cell`         | object(CellReferenceViewModel) | Facultatif. Position de la cellule dans le tableau. |

<div id="tableviewmodel">
  ### TableViewModel
</div>

| Champ       | Type                    | Description                      |
| ----------- | ----------------------- | -------------------------------- |
| `name`      | string                  | Obligatoire. Nom du tableau.     |
| `regions[]` | object(RegionViewModel) | Obligatoire. Régions du tableau. |

<div id="rectangleviewmodel">
  ### RectangleViewModel
</div>

| Champ     | Type             | Description                         |
| --------- | ---------------- | ----------------------------------- |
| `page_id` | integer(\$int32) | Obligatoire. ID interne de la page. |
| `x1`      | integer(\$int32) | Obligatoire. Coordonnée x1.         |
| `y1`      | integer(\$int32) | Obligatoire. Coordonnée y1.         |
| `x2`      | integer(\$int32) | Obligatoire. Coordonnée x2.         |
| `y2`      | integer(\$int32) | Obligatoire. Coordonnée y2.         |

<div id="cellreferenceviewmodel">
  ### CellReferenceViewModel
</div>

| Champ         | Type             | Description                                 |
| ------------- | ---------------- | ------------------------------------------- |
| `table_name`  | string           | Obligatoire. Nom du tableau référencé.      |
| `row_number`  | integer(\$int32) | Obligatoire. Numéro de la ligne référencée. |
| `column_name` | string           | Obligatoire. Nom de la colonne référencée.  |

<div id="regionviewmodel">
  ### RegionViewModel
</div>

| Champ                     | Type                       | Description                                    |
| ------------------------- | -------------------------- | ---------------------------------------------- |
| `rectangles[]`            | object(RectangleViewModel) | Obligatoire. Rectangle du champ.               |
| `columns[]`               | object(ColumnViewModel)    | Obligatoire. Colonnes du tableau.              |
| `horizontal_separators[]` | integer(\$int32)           | Obligatoire. Séparateur horizontal du tableau. |

<div id="columnviewmodel">
  ### ColumnViewModel
</div>

| Champ   | Type             | Description                               |
| ------- | ---------------- | ----------------------------------------- |
| `left`  | integer(\$int32) | Obligatoire. Limite gauche de la colonne. |
| `right` | integer(\$int32) | Obligatoire. Limite droite de la colonne. |
