Table
{
Attribute | Data type | Description |
---|---|---|
pk | Table PK | |
columns | List of Column Metadata | See below for details |
rows | List of Row Data | See below for details |
}
{
"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.
{
Attribute | Data type | Description |
---|---|---|
column_id | String | Unique ID for this column within this Form |
alias_used | String | Text 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
{
Attribute | Data type | Description |
---|---|---|
page_idx | Integer | Zero-based page index on which this row was captured. |
page_doc_pk | Page PK | |
cells | Cell Data | A map of field names to Cell objects. Each Cell object has a value attribute providing captured data. |
}
Updated over 1 year ago