FieldMetaData

Detailed field definition

Properties¶

Property	Type	Description
`choiceSetId?`	`string`	-
`createdBy`	`string`	-
`createdTime`	`string`	-
`defaultValue?`	`string`	-
`description?`	`string`	-
`displayName?`	`string`	-
`fieldDataType`	`FieldDataType`	Transformed field data type — present after SDK transformation
`fieldDisplayType`	`FieldDisplayType`	-
`id`	`string`	-
`isAttachment`	`boolean`	-
`isEncrypted`	`boolean`	-
`isExternalField`	`boolean`	-
`isForeignKey`	`boolean`	-
`isHiddenField`	`boolean`	-
`isPrimaryKey`	`boolean`	-
`isRbacEnabled`	`boolean`	-
`isRequired`	`boolean`	-
`isSystemField`	`boolean`	-
`isUnique`	`boolean`	-
`name`	`string`	-
`referenceChoiceSet?`	`RawEntityGetResponse`	-
`referenceEntity?`	`RawEntityGetResponse`	-
`referenceEntityName?`	`string`	Name of the referenced entity (used on write payloads for relationship fields)
`referenceField?`	`Field`	-
`referenceFieldName?`	`string`	Name of the field in the referenced entity (used on write payloads for relationship fields)
`referenceName?`	`string`	-
`referenceType?`	`ManyToOne`	-
`sqlType?`	`SqlType`	Raw SQL type from API — present on raw GET responses, used on write payloads
`updatedBy?`	`string`	-
`updatedTime?`	`string`	-