Datatable Field

The datatable_field service is used to retrieve information about fields for a datatable.

Within the Datatable service documentation, you will find references to the system field name.
This is used as the field identifier when getting or setting datatable row data and is constructed by prepending 'field_' to the field ID. Eg. field_123


fetchAll

array datatable_field.fetchAll( int datatableId )

Requests a list of datatable fields for the given datatable ID.

Return Values

Returns an array of associative arrays. The possible returned elements are as follows:

Name

Type

Description

datatable_id

int

ID of the profile that contains this field

field_id

int

Field ID

name

string

Name of the field

type_id

int

ID of the field type, see field_type

is_unique

int

Boolean integer to represent whether the field forms part of the datatable's unique fieldset

created_ts

timestamp

DateTime the field was created

update_ts

timestamp

DateTime the field was last updated

Service

datatable_field

Methods