Get
/api/v1/Catalog/custom-fields/column
Returns a list of column custom fields
Responses
200
OK
object
sections
Array of object (Configuration.Api.Models.v1.CustomFieldSection)
List of custom field sections
object
name
string | null
The name of the section
fields
Array of object (Configuration.Api.Models.v1.CustomFieldDetail)
List of fields in the section
object
name
string | null
The name of the field
description
string | null
The description of the field
referenceKey
string | null
The reference key of the field
dataType
string
Valid values[
"ShortText",
"Date",
"Paragraph",
"UserGroupList",
"Dropdown",
"TagList",
"TableMetadataReference",
"ColumnMetadataReference"
]
options
Array of string
List of options for the field
string
visibility
object (Configuration.Api.Models.v1.SectionFieldVisibility)
type
string
Valid values[
"AlwaysShow",
"AlwaysHide",
"RuleLogic"
]
technicalMetadataRules
Array of object (Configuration.Api.Models.v1.MetaObjectTechnicalColumnFilter)
List of technical metadata visibility rules
object
field
string
Valid values[
"SchemaName",
"TableName",
"TableType",
"ColumnName",
"ColumnDataType",
"ColumnMappedType",
"ColumnNullable",
"ColumnIdentity",
"ColumnPrimaryKey",
"ColumnMaxLength",
"TableRecordCount",
"DataSourceName",
"DataSourceEnvironment",
"DataSourceConnectionType",
"DataSourceServer",
"DataSourceDatabaseName",
"DataSourceTemplate"
]
customMetadataRules
Array of object (Configuration.Api.Models.v1.MetaObjectCustomColumnFilter)
List of custom metadata visibility rules
object
objectType
string
Valid values[
"DataSource",
"Table",
"Column",
"Schema"
]
referenceOptions
object (Configuration.Api.Models.v1.ReferenceFieldOptions)
scope
string
Valid values[
"AnyDataSource",
"SameDataSource",
"SameSchema",
"SameTable"
]
allowMultipleValues
boolean
Whether to allow multiple values for the field
visibility
object (Configuration.Api.Models.v1.SectionFieldVisibility)
type
string
Valid values[
"AlwaysShow",
"AlwaysHide",
"RuleLogic"
]
technicalMetadataRules
Array of object (Configuration.Api.Models.v1.MetaObjectTechnicalColumnFilter)
List of technical metadata visibility rules
object
field
string
Valid values[
"SchemaName",
"TableName",
"TableType",
"ColumnName",
"ColumnDataType",
"ColumnMappedType",
"ColumnNullable",
"ColumnIdentity",
"ColumnPrimaryKey",
"ColumnMaxLength",
"TableRecordCount",
"DataSourceName",
"DataSourceEnvironment",
"DataSourceConnectionType",
"DataSourceServer",
"DataSourceDatabaseName",
"DataSourceTemplate"
]
customMetadataRules
Array of object (Configuration.Api.Models.v1.MetaObjectCustomColumnFilter)
List of custom metadata visibility rules
object
objectType
string
Valid values[
"DataSource",
"Table",
"Column",
"Schema"
]
404
Not Found
object
error
string | null