Custom Fields

Last Updated: April 26, 2016

Following is a list of the properties that belong to a customfield object, and a description of each.

id:
Integer. Id of customfield.
active:
Boolean. true or false. If true, this custom field is active. If false, this custom field is archived.
name:
String. Name of the customfield.
short_code:
String. This is a shortened code or alias that is associated with the customfield. It may only consist of letters and numbers.
required:
Boolean. true or false. Indicates whether a value for this customfield is required on a timesheet.
applies_to:
String. 'timesheet' or 'user' or 'jobcode'. Indicates what type of object this customfield applies to.
type:
String. 'managed-list' or 'free-form'. If free-form, then it should be displayed in a UI as a text box, where users can enter values for this customfield and they'll get added automatically to the customfield if they don't already exist. If managed-list, then it should be displayed as a select-box and users can only choose an existing value.
ui_preference:
String. 'drop_down' or 'text_box_with_suggest'. Indicates the suggested user interface depending on the specified type.
regex_filter:
String. Regular expression that will be applied to any new items as they're added to the customfield. If they do not match the regex_filter, they may not be added.
last_modified:
String (ISO8601 format). Date/time when this customfield was last modified (i.e. 2004-02-12T15:19:21+00:00).
created:
String (ISO8601 format). Date/time when this customfield was created (i.e. 2004-02-12T15:19:21+00:00).
required_customfields:
Array. Ids of customfields that should be displayed when an item from this customfield is selected on a timecard.