ShowDescriptions Parameter (Connect-ServiceNow Cmdlet)
Controls whether column and table descriptions are returned via the sys_documentation and sys_db_object API endpoints.
Syntax
Connect-ServiceNow -ShowDescriptions string
Possible Values
NONE, TableLabels, ColumnLabels, TableAndColumnLabels, ColumnCommentsData Type
cstr
Default Value
"NONE"
Remarks
Note: By default, it is set to NONE and the descriptions for the tables and their respective columns are not shown. Extra API calls will be executed if this property is set to a value other than NONE.
Set the value of this property to TableLabels if you want to retrieve the Labels (Display Names) for every table from the sys_db_object API endpoint.
Set the value of this property to ColumnLabels if you want to retrieve the Labels (Display Names) for every column from the sys_documentation API endpoint.
Set the value of this property to TableAndColumnLabels if you want to retrieve the Labels (Display Names) for every table and their respective columns from the sys_db_object and sys_documentation API endpoints.
Set the value of this property to ColumnComments if you want to retrieve the Comments for every column from the sys_dictionary API endpoint.