FieldDefinition

A single field definition.

More info: see the get operation and the field definitions endpoint.

Fields

Field	Description
id int (required)	Unique ID Example value:`123`
typeid int (required)	Type ID Example value:`10001`
align string (required)	Alignment of the field definition, when used in a view. Values can be ‘left’, ‘right’ or ‘center’ Example value:`"left"`
description mlstring (required)	Human-readable name for the field definition Example value:`"Created timestamp"`
key string (required)	Key for the field definition. Should only consist of lowercase alphanumeric characters Example value:`"createdtimestamp"`
sqlclause string (required)	The actual definition of the field definition. Contains the sql clause that will retrieve the information element in the database. Example value:`"tm.order.createdts"`
uitype string (required)	Will decide how the field will be rendered when used in a view. Example value:`"number"`
variablewidth bool (required)	Indicates whether the width for the field definition can be adapted when stretching a view that includes the field definition across the whole available width. Example value:`true`
width int (required)	Width of the field definition, when used in a view Example value:`50`
isarchived bool (required)	Whether or not this item is archived
createdts timestamp (required)	Created timestamp Example value:`"2014-09-26 15:24:36"`
lastupdatets timestamp (required)	Last updated timestamp Example value:`"2014-09-26 15:24:36"`

Example

 1{
 2    "id": 123,
 3    "typeid": 10001,
 4    "align": "left",
 5    "description": "Created timestamp",
 6    "key": "createdtimestamp",
 7    "sqlclause": "tm.order.createdts",
 8    "uitype": "number",
 9    "variablewidth": true,
10    "width": 50,
11    "isarchived": false,
12    "createdts": "2014-09-26 15:24:36",
13    "lastupdatets": "2014-09-26 15:24:36"
14}