ModelingColumn
Definition of a table column in the model.
API Section: Objects
Type: Object
Properties
Name |
Description |
Required |
Type |
Format |
---|---|---|---|---|
columnId |
The column's system ID |
- |
string |
uuid |
displayName |
The column's display name |
- |
string |
|
description |
The column's description |
- |
string |
|
format |
The column's data format |
- |
string |
|
uniqueName |
The column's unique identifier, used in relationships, hierarchies and measures |
- |
string |
|
parentUniqueName |
Unique identifier of the table that contains this column |
- |
string |
|
sourceColumnName |
The column's name in the database |
- |
string |
|
type |
The column's data type |
- |
string |
|
defaultSortColumnUniqueName |
Unique identifier of the default column to sort by when the user sorts by this column |
- |
string |
|
isDefaultSortDescending |
Is the default sorting descending |
- |
boolean |
|
size |
Size of the source column type (string length or decimal precision) |
- |
integer |
int32 |
scale |
Scale of the source column type (if decimal) |
- |
integer |
int32 |
isVisible |
Is the column displayed in the |
- |
boolean |
|
isSecurity |
Is this a column used in the security panel |
- |
boolean |
|
isDistribution |
Is column for publication distribution |
- |
boolean |
|
displayFolder |
Column's display folder name |
- |
string |
|
isIndexed |
Is this column indexed in the source database |
- |
boolean |
|
columnIndex |
Index of this column in the table, start at 0 |
- |
integer |
int32 |
hasMultiMeasures |
Boolean indicating if this column has multi-measures |
- |
boolean |
|
isAggregatable |
Can this column be aggregated |
- |
boolean |
|
columnCategory |
Predefined category of this column (time intelligence part, location part, etc) |
- | ||
customCategoryId |
User defined category of this column |
- |
string |
|
keyColumn |
Unique identifier of the key column for this column |
- |
string |
|
hasDefaultMember |
Does this column has a default member |
- |
boolean |