Skip to main content
Get Custom Field Info List

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Response

OK

FieldType
enum<string>

What sort of data does this field contain. 1 = int, 2 = short text, ...

Available options:
Unknown,
Integer,
ShortText,
LongText,
Date,
Blob,
Checkbox,
MdoList,
Decimal,
DateTime,
Time,
TimeSpan,
RelationTo,
Attachment,
DynamicLink,
ListText
FieldName
string

Database name or prog-id: 'x_foobar' or 'SuperOffice:2'.

DisplayName
string

Label for field. May be multi-lang string encoded.

Description
string

Optional tooltip text for this field

ShortLabel
string

Short name to be used in Archive headings and on page 1. If blank, the fieldLabel will be used everywhere.

HideLabel
boolean

Hide the label if 1

HideField
boolean

Hide the field from the UI. Only allow API access.

IsIndexed
boolean

Is this field indexed? 0 if no, index no. if yes

IsMandatory
boolean

0 = no, 1 = yes (field must be filled out)

IsReadOnly
boolean

0 = read/write, 1 = readonly (don't combine with mandatory 8-) )

IsExternal
boolean

Should this field be shown to external users via customer center?

IsDisplayField
boolean

Flag indicating that this field is chosen as DisplayField for a table it belongs

Rank
integer<int32>

Tab order, ranking within the custom fields.

TemplateVariableName
string

Template variable name: 'cs01', 'cl02' etc. Null for extra fields.