Datatable Object#

The datatable configuration is a json document with the following structure. Some properties have been omitted.

{
    "org_id": "56A23D908AD3312676D3D9DF9099A5C9",
    "user_id": "56A23B5444D384B805785604C517C14B",
    "table_id": "62569C1F623A83536F1FD718DB131752",
    "name": "Testing all fieldtypes",
    "col_settings": {
        "c0": {
            "name": "Column 0 Text",
            "display_type": "string",
            "unique": false
        },
        "c1": {
            "name": "Column 1 Number",
            "display_type": "integer",
            "unique": false
        },
        "c2": {
            "name": "Column 2 Series",
            "display_type": "number_series",
            "number_series_id": "628E22C5E5007BFD32ECF73FBF005915"
        }
    },
    "exporter_presets": []
}

Properties

org_id

Id of the owning organisation.

user_id

Id of the user that created the table initially.

table_id

Id of the table itself, used in any related api request.

name

A use defined descriptive name of the table.

col_settings

This defines the whole structure of the table. Each cx sub object defines the settings of a column, where c0 is the first column, c1 the second and so on.

Properties of a col_settings object are:

  • display_type: Defines the data contained here, see Column Display Types for a list of available display types.

  • unique: The values in this colmn will be unique, no two rows will have the same values here. I.e. a user defined id column. Often used in combination with a number series

  • number_series_id: The default values for this column will be generated by this number series. An easy way to build a user defined id column.

  • read_only: Used in many system type tables. Values in this column can not be modified.

  • hidden: Also mainly used in system type tables. These columns are not displayed in the portal.

  • nullable: Null values are allowed in this column. By default empty values would be used when a row is not completely defined upon insertion.

  • help_description: A description of the columns purpose, will be displayed in the portal.

  • default_value: The value that will be used when a rows with incomplete data is inserted.

  • name: Descriptive name of the column.

exporter_presets

A list of exporter presets. See Exporter Presets for more information.

Row Objects#

Each row of a table is represented as an object, sometimes called a row document.

Row Document#
{
    "row_id": "67516C89A11FC9E773A5580BA2754499",
    "table_id": "67516C8929A170893CB652674DFEC014",
    "c0": "...",
    "c1": "..."
}

row_id

The unique id of the row. Can be used in several api requests for modifying values, etc.

table_id

The id of the table that this rows belongs to.

c0-c249

Values of the row.

On this page