Interface FieldDef

FieldDef 字段元数据定义

interface FieldDef {
    caseSensitive: boolean;
    category: string;
    createdBy: string;
    createdByName: string;
    createdDate: string;
    dataLength: number;
    dataType: string;
    defaultValue?: any;
    description: string;
    extraSourceAttribute: string;
    formula?: string;
    id: string;
    installedPackage: string;
    isIndexed: boolean;
    isSearchable: boolean;
    label: string;
    lastModifiedBy: string;
    lastModifiedByName: string;
    lastModifiedDate: string;
    maskChar?: string;
    maskType?: string;
    minEncryptedSearchableLength?: number;
    name: string;
    pattern?: string;
    picklistDefaultValue?: string;
    picklistId?: string;
    picklistValues?: string[];
    protectMode: number;
    referenceObjectsDetails?: FieldRelationship[];
    required: boolean;
    scale?: number;
    startingNumber?: number;
    status: string;
    unique: boolean;
}

Properties

caseSensitive category createdBy createdByName createdDate dataLength dataType defaultValue? description extraSourceAttribute formula? id installedPackage isIndexed isSearchable label lastModifiedBy lastModifiedByName lastModifiedDate maskChar? maskType? minEncryptedSearchableLength? name pattern? picklistDefaultValue? picklistId? picklistValues? protectMode referenceObjectsDetails? required scale? startingNumber? status unique

Properties

caseSensitive

caseSensitive: boolean

是否大小写敏感

category

category: string

字段类别

createdBy

createdBy: string

创建者 id

createdByName

createdByName: string

创建者名字

createdDate

createdDate: string

创建时间

dataLength

dataLength: number

字段数据长度

dataType

dataType: string

字段类型

Optional defaultValue

defaultValue?: any

默认值

description

description: string

字段描述

extraSourceAttribute

extraSourceAttribute: string

拓展属性

Optional formula

formula?: string

公式

id

id: string

字段 id

installedPackage

installedPackage: string

安装包

isIndexed

isIndexed: boolean

是否有索引

isSearchable

isSearchable: boolean

是否可搜索

label

label: string

字段标签

lastModifiedBy

lastModifiedBy: string

最后修改者 id

lastModifiedByName

lastModifiedByName: string

最后修改者名字

lastModifiedDate

lastModifiedDate: string

最后修改时间

Optional maskChar

maskChar?: string

掩码字符

Optional maskType

maskType?: string

掩码类型

Optional minEncryptedSearchableLength

minEncryptedSearchableLength?: number

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

name

name: string

字段名

Optional pattern

pattern?: string

自动编码模式

Optional picklistDefaultValue

picklistDefaultValue?: string

选项列表默认值

Optional picklistId

picklistId?: string

选项列表 id

Optional picklistValues

picklistValues?: string[]

选项列表值

protectMode

protectMode: number

保护模式

Optional referenceObjectsDetails

referenceObjectsDetails?: FieldRelationship[]

字段关联关系描述

required

required: boolean

是否必填

Optional scale

scale?: number

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

Optional startingNumber

startingNumber?: number

自动编码开始数字

status

status: string

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

unique

unique: boolean

是否唯一

Settings

Member Visibility

Theme

On This Page

caseSensitivecategorycreatedBycreatedByNamecreatedDatedataLengthdataTypedefaultValuedescriptionextraSourceAttributeformulaidinstalledPackageisIndexedisSearchablelabellastModifiedBylastModifiedByNamelastModifiedDatemaskCharmaskTypeminEncryptedSearchableLengthnamepatternpicklistDefaultValuepicklistIdpicklistValuesprotectModereferenceObjectsDetailsrequiredscalestartingNumberstatusunique