Skip to main content
Returns the captured data layout.

​
HTTP request

GET https://api-{location-id}.flexicapture.com/v2/training/layout/{taskId}/{fileId}
Replace {location-id} with your supported location.

​
Path parameters

ParameterTypeDescription
taskIdpath, stringRequired. Task ID.
fileIdpath, stringRequired. Source file ID.

​
Response

If successful, the response body contains an instance of TrainingDataViewModel. 
{
  "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
          ]
        }
      ]
    }
  ]
}

​
TrainingDataViewModel

FieldTypeDescription
task_idstringRequired. Task ID.
file_idstringRequired. File ID.
pagesArray[PageViewModel]Optional. List of document pages.
fieldsArray[FieldViewModel]Required. Set of captured fields.
tablesArray[TableViewModel]Optional. Set of captured tables.

​
PageViewModel

FieldTypeDescription
idinteger($int32)Optional. Readonly. Internal page ID.
numberinteger($int32)Optional. Readonly. Page number.
resolutioninteger($int32)Optional. Readonly. Page image DPI.
heightinteger($int32)Optional. Readonly. Page image height.
widthinteger($int32)Optional. Readonly. Page image width.

​
FieldViewModel

FieldTypeDescription
namestringRequired. Field name.
valuestringOptional. Extracted value.
rectangles[]object(RectangleViewModel)Required. Field rectangles.
cellobject(CellReferenceViewModel)Optional. Position of the cell in the table.

​
TableViewModel

FieldTypeDescription
namestringRequired. Table name.
regions[]object(RegionViewModel)Required. Table regions.

​
RectangleViewModel

FieldTypeDescription
page_idinteger($int32)Required. Internal page ID.
x1integer($int32)Required. Coordinate of x1.
y1integer($int32)Required. Coordinate of y1.
x2integer($int32)Required. Coordinate of x2.
y2integer($int32)Required. Coordinate of y2.

​
CellReferenceViewModel

FieldTypeDescription
table_namestringRequired. Name of referred table.
row_numberinteger($int32)Required. Number of referred row.
column_namestringRequired. Name of referred column.

​
RegionViewModel

FieldTypeDescription
rectangles[]object(RectangleViewModel)Required. Field rectangle.
columns[]object(ColumnViewModel)Required. Table columns.
horizontal_separators[]integer($int32)Required. Horizontal table separator.

​
ColumnViewModel

FieldTypeDescription
leftinteger($int32)Required. Left boundary of the column.
rightinteger($int32)Required. Right boundary of the column.