A Boolean property that determines whether the display names for custom fields should be used instead of their corresponding API names. When enabled, this option will cause the system to use user-friendly display names for custom fields in the UI or API responses, making it easier for users to interpret the data.

Syntax

Connect-JIRA -UseDisplayNames bool

Data Type

bool

Default Value

true

Remarks

This property determines whether custom fields are referenced by their display names or their API names.

• True (default): The system uses display names for custom fields, which are more readable and user-friendly. This is typically preferred in most user interfaces or reports where understanding the field names is important.
• False: The system will use the API names of the custom fields, which are more technical and may be preferred in API calls or backend operations where field identifiers are required for integration purposes.

Enabling this option improves the readability and accessibility of data for non-technical users, while disabling it is useful for scenarios where field names need to match exactly with those used in API requests.