Specifies whether custom field descriptions should be retrieved. Set this property to 'Columns' to retrieve descriptions for custom fields.

Possible Values

Data Type

string

Default Value

"NONE"

Remarks

This property controls whether custom field descriptions are included in the retrieved metadata. The property takes effect only if IncludeCustomFields is set to 'true'.

When this property is set to 'Columns', it attempts to retrieve the descriptions for custom fields as well, which can be useful for understanding the context or purpose of custom fields in your Jira environment. Retrieving descriptions for custom fields requires administrator access to the Jira system, as this information may be restricted for non-administrative users. Note that enabling this option results in extra API calls to be made to retrieve the custom field descriptions, which could impact performance.

If the retrieval of descriptions fails (for example, due to permission restrictions), the driver reverts to the default behavior, where descriptions are null, and the reason for the failure is logged.

The options for this property are:

• NONE (default): Custom field descriptions are not retrieved.
• Columns: Custom field descriptions are retrieved during metadata retrieval process.