Use the user-facing display names of drop-down (enum) field values, rather than their API names, in query results and metadata listings.

Syntax

Connect-SuiteCRM -PushDisplayValues SwitchParameter

Data Type

bool

Default Value

false

Remarks

The SuiteCRM API refers to the possible values associated with drop-down fields using developer-focused names, which are harder to read and interpret than the straightforward names used in the user interface for those same drop-down field values.

When this connection property is set to True, the schema of the cmdlet uses the user-friendly names from the user interface to refer to drop-down field values.

When this connection property is set to False, the schema of the cmdlet uses the developer-focused API names to refer to drop-down field values.

Note: The effects of this connection property only apply when the Schema connection property is set to suitecrmv4. When Schema is set to suitecrmv8, the cmdlet always displays the API names of drop-down fields.