The following attributes are considered while processing the table data, including column and row metadata:

AttributeData typeDescription
pkTable PKUnique identification number of the Book.
columnsList of Column MetadataThe list of available columns
rowsList of Row DataThe list of available rows
{
  "pk": 2020,
  "columns": [
    {
      "alias_used": "Total",
      "column_id": "total"
    },
    {
      "alias_used": "Description",
      "column_id": "description"
    },
    {
      "alias_used": "Quantity",
      "column_id": "quantity"
    },
    {
      "alias_used": "Ref Number",
      "column_id": "refNumber"
    },
    {
      "alias_used": "Unit Price",
      "column_id": "unitPrice"
    },
    {
      "alias_used": "Item Number",
      "column_id": "itemNumber"
    }
  ],
  "rows": [
    {
      "page_idx": 0,
      "page_doc_pk": 12345,
      "cells": {
        "total": {
          "value": "1000.00"
        },
        "description": {
          "value": "Item 1 Description"
        },
        "quantity": {
          "value": "1"
        },
        "refNumber": {
          "value": "ITEM #001"
        },
        "unitPrice": {
          "value": "1000.00"
        },
        "itemNumber": {
          "value": "10"
        }
      }
    },
    {
      "page_idx": 0,
      "page_doc_pk": 12345,
      "cells": {
        "total": {
          "value": "2000.00"
        },
        "description": {
          "value": "Item 2 Description"
        },
        "quantity": {
          "value": "4"
        },
        "refNumber": {
          "value": "ITEM #002"
        },
        "unitPrice": {
          "value": "500.00"
        },
        "itemNumber": {
          "value": "10"
        }
      }
    }
    //, ...
  ]
}

Column metadata

The list will contain one object for every column in the table.

AttributeData typeDescription
column_idStringUnique ID for this column within this Form
alias_usedStringText of column header if it does not exactly match the column_id. The value is null if not applicable.

Row data

This is the data captured in the body of the table. The list will contain one object for every row of data captured

AttributeData typeDescription
page_idxIntegerZero-based page index on which this row was captured.
page_doc_pkPage PKUnique identification number of the page within a Document.
cellsCell DataA map of field names to Cell objects. Each Cell object has a value attribute providing captured data.