./list/fields

id

The column ID.

string

type

The data type, any of:

• Integer: A number

• Decimal: A number with optional decimal position '.' (dot).

• String: A string

• Date: Date part only (year, month, day)

• DateTime: Full date/time

• Boolean: A boolean

• Hyperlink: Contains a hyperlink or email link etc.

• Image: Contains an image reference. To display the image you need to call the media related API method.

• Label: The selected option for the label's value or null if label is not assigned. There is one field per label of an object.

• LabelCount: Total assigned labels of an object. Contains a property "cnt" with total set labels and "xp" with explicitly set labels.

• Object: Any other data type

string

control

Specifies how a user can select values (e.g. how a UI filter control would be implemented):

• Standard: Corresponding to the type. For example, a string-type would be a free text field.

• Select: Field can have null or a value from a list. See the "options" property for either AJAX information or list of permitted values/titles.

• SelectMulti: Field can contain multiple values from a list. See "options" property like above.

• SelectEditable: Field proposes a list but user can type any other string as well. See "options" property like above.
  
  

string

name

A user friendly title of the field.

string

desc

A user friendly description of the field.

string

fname

Filter title if different from "title". Whereas "title" is worded to serve as a column header in a list, "ftitle" is focused to be used as a filter control label.

string?

fdesc

Filter description/tooltip if different from "desc"

string?

nullable

If true then the field can have a null value.

bool

max

Optional maximum length of the field value.

int?

isdata

True if the field is always included with the results.

Generally, these are fields not shown to end users: Internal object identifiers etc.

bool

iscol

A column field. A field that can be shown to end users. In the Wordbee system the field is shown in a separate grid column.

bool

iscoldef

A default column field. By default this field is shown to the user.

bool

canquery

If true then the field can be filtered by means of the layout.query parameter.

bool

cansort

If true then data can be sorted by this field.

bool

canautocomplete

If true, then you can use the auto-completion service for this field. See

bool

options

This is used for filtering or querying purposes. For example: Pickup list fields may require you to know which possible values the field can have.

Full details can be found here: Field types and options

Example for an ajax instruction to retrieve the list of all codes and titles. Example for task codes:

"options": {
            "otype": "dicajax",
            "url": "/settings/tasks/codes",
            "key": "v",
            "value": "t"
        }

Example of a key / value list of options:

"options": {
            "otype": "dic",
            "items": [
                {
                    "v": 0,
                    "t": "Fixed assignment"
                },
                {
                    "v": 1,
                    "t": "Job opening"
                },
                {
                    "v": 2,
                    "t": "Crowd"
                }
            ]
        }

 More information

object?

width

Optional default user interface width. For example: "10%", "200px" etc. Null means that the width will be adjusted automatically in the web interface.

string?

uifilter

Internal use. 0 = no filter, 1 = top, 2 = primary, 3 = secondary