Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

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:DBDomainThe object to which this custom field is attached. This can be any of:SegmentProjectResourceOrderCompanyJobInvoiceDBColumnThe unique ID of the custom field for a given DBDomain.The IDs are CustomStr1, CustomStr2….DisplayOrderUsed for sorting fields in user interfaces.TitleThe name of the custom field as provided by the administrator.DescriptionOptional description.TypeThe field type. Can be "String", "Combo", "ComboEditable" and "Hyperlink".MaxLengthMaximum length of field contents.IsMandatoryIndicates if a value must be supplied when editing a field.ComboOptionsA list of picklist options proposed to user.





  • No labels