FieldDef 字段元数据定义

Hierarchy

  • FieldDef

Properties

caseSensitive: boolean

是否大小写敏感

category: string

字段类别

createdBy: string

创建者 id

createdByName: string

创建者名字

createdDate: string

创建时间

dataLength: number

字段数据长度

dataType: string

字段类型

defaultValue?: any

默认值

description: string

字段描述

extraSourceAttribute: string

拓展属性

formula?: string

公式

id: string

字段 id

installedPackage: string

安装包

isIndexed: boolean

是否有索引

isSearchable: boolean

是否可搜索

label: string

字段标签

lastModifiedBy: string

最后修改者 id

lastModifiedByName: string

最后修改者名字

lastModifiedDate: string

最后修改时间

maskChar?: string

掩码字符

maskType?: string

掩码类型

minEncryptedSearchableLength?: number

加密文本类型的最小可搜索长度。

name: string

字段名

pattern?: string

自动编码模式

picklistDefaultValue?: string

选项列表默认值

picklistId?: string

选项列表 id

picklistValues?: string[]

选项列表值

protectMode: number

保护模式

referenceObjectsDetails?: FieldRelationship[]

字段关联关系描述

required: boolean

是否必填

scale?: number

字段的数值范围,即该字段的小数点后位数,只对数值类型字段有意义

startingNumber?: number

自动编码开始数字

status: string

字段状态,如果非complete表示尚不可用

unique: boolean

是否唯一