Skip to main content
Get Configuration Fields

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.

Query Parameters

$select
string

Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.

Body

ErpConnectorId

GetConfigurationFields: Returns all fields needed to connect to the given connector

ErpConnectorId
integer<int32>

Response

OK

FieldKey
string

Internal key/name of the field. Used as the key in the ConnectionConfigField values when TestConnection is called.

Rank
integer<int32>

A way to set the order of the fields. Lowest value will be displayed first/over the fields with other values.

DisplayName
string

Localized field name – shown in the GUI

DisplayDescription
string

Tooltip for the field name.

FieldType
enum<string>

String, int, decimal, etc.

Available options:
Checkbox,
Text,
Password,
Integer,
Double,
List,
Date,
Label
ListName
string

MDO List provider name for list fields

DefaultValue
string

A default value for the field.

MaxLength
integer<int32>

Maximum length for strings, if set. 0 means no restriction. (Though sooner or later something will no doubt overflow if you pile on the gigabytes.)

Access
enum<string>

Access restrictions on the field

Available options:
Normal,
Mandatory,
ReadOnly

True if this field is displayed in search result

TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.