Custom fields

This method retrieves the complete list of custom fields defined in the system.

Custom fields can be defined for various entities in the system. For example, to get all project custom fields, look at the records where DBDomain equals "Project".

URL

(GET) settings/customfields

PARAMETERS

token

The token obtained on connection

Required

RESULTS

Returns a list of ApiCustomField records. Each record has these fields:

DBDomain	The object to which this custom field is attached. This can be any of: Segment Project Resource Order Company Job Invoice
DBColumn	The unique ID of the custom field for a given DBDomain.The IDs are CustomStr1, CustomStr2….
DisplayOrder	Used for sorting fields in user interfaces.
Title	The name of the custom field as provided by the administrator.
Description	Optional description.
Type	The field type. Can be "String", "Combo", "ComboEditable" and "Hyperlink".
MaxLengt	hMaximum length of field contents.
IsMandatory	Indicates if a value must be supplied when editing a field.
ComboOptions	A list of picklist options proposed to user.