Returning Tabular Data

Tabular data is returned as a list of Column Definitions and Row Data.

Column Definitions

Column definitions are returned in the columns object.

caption field type visible width
Label that should be displayed in the column header. Field name in a row that contains the data. Data Type If the column should be displayed. Column Width (in characters)
Value Data Type
1 String
2 Bool
3 Int
4 Float
5 Time
6 DateTime
7 Date
8 Blob

Example:

      "columns": 
      [
        {
          "caption": "Language ID",
          "field": "LANGUAGE_ID",
          "type": 3,
          "visible": false,
          "width": 14
        },
        {
          "caption": "Language",
          "field": "LANGUAGE",
          "type": 1,
          "visible": true,
          "width": 11
        },
        {
          "caption": "Folder Name",
          "field": "FOLDER_NAME",
          "type": 1,
          "visible": true,
          "width": 14
        },
        {
          "caption": "Date Format",
          "field": "DATE_FORMAT",
          "type": 1,
          "visible": true,
          "width": 14
        }
     ]

Row Data

The rows array contain the field data as defined by the column definitions.

Example:

"rows":

  [
      {
          "LANGUAGE_ID": 3,
          "LANGUAGE": "English",
          "FOLDER_NAME": "ENG",
          "DATE_FORMAT": "DD/MM/YYYY"
      },
      {
          "LANGUAGE_ID": 5,
          "LANGUAGE": "Spanish",
          "FOLDER_NAME": "SPA",
          "DATE_FORMAT": "DD/MM/YYYY"
      }
  ]