OBJECT
FieldEntity

Field of an entity, built-in or custom, with its name, type and configuration.
GraphQL Schema definition

type FieldEntity {
# True when the record is protected against deletion because it must always exist 
# in the space. Deleting a record that is not protected can still fail on other 
# checks. Read-only.
isDeleteProtected: Boolean! 
# True when the record has unpublished draft changes, including pending 
# translation changes, that can be published.
hasDraft: Boolean 
# Unique identifier of entity.
id: ID! 
# True when the field is marked as deleted (soft-delete).
isDeleted: Boolean 
# Last modification time.
modified: DateTime 
# Creation time.
created: DateTime 
# Related entity name for field (e.g. Account, Contact, Lead, Opportunity, ...). 
# Must be a concrete entity: abstract parents such as LeadOppty or Activity are 
# rejected. To share a field between Lead and Opportunity (or Task and 
# Appointment), create it on one of them and set mapDependency to the other.
entityName: String! 
# Immutable and generated name. This name is used for integrations.
apiName: String 
# User friendly name for field.
name: String! 
# When true, the field name is treated as a translation key and resolved through 
# the translation system; otherwise the literal name is shown.
useLang: Int 
# Storage column name for the field; used as the filter key in API queries.
columnName: String 
# Storage origin of the field: on the main entity record, on the custom-field data 
# record, or computed.
columnSource: Int 
# For relation-typed fields, identifier of the relation kind that connects this 
# entity to the related entity. Empty for non-relation fields.
relationId: String 
# For relation-typed fields, the entity the field points to (e.g. Contact, 
# Account). Empty for non-relation fields.
relationWithEntityId: String 
# When the field is shared between abstract entities (e.g. Lead and Opportunity), 
# id of the counterpart field on the other entity. Empty when the field is not 
# shared.
sharedWithFieldId: ID 
# Whether the field is System (built-in, immutable), Protected (built-in, limited 
# changes), or Custom (user-created).
systemType: Int 
# Type of the field. Supported field types are: checkbox, currency, 
# currency_foreign, date, datetime, dropdown, email, float, input, integer, 
# multiselect_checkbox, phone, radio, sequence, text_area, url
typeId: String! 
# For sub-fields of a composite field (e.g. the value/currency parts of a foreign 
# currency field), id of the parent composite field. Empty for top-level fields.
compositeFieldId: ID 
# Optional custom data set id can be set.
dataSetId: ID 
# For dependent dropdown/radio fields, id of the parent field whose selected value 
# restricts the options shown on this field.
parentOptionsFieldId: ID 
# Calculated formula used for fields which supports calculation.
calcFormula: String 
# Value pre-filled into this field on newly created records, as text converted to 
# the field type; empty for no default. Accepted only by field types that support 
# a default value.
defaultValue: String 
# For sequence-typed fields, id grouping the FieldSequence rows that drive 
# auto-numbering for this field.
sequenceSetId: ID 
# Deprecated; always returns null. Use sequenceSetId and FieldSequence instead.
sequenceId: UUID 
# True when the field cannot be made optional (enforced by the platform).
systemRequired: Boolean 
# True when the field configuration is published; false while the field exists 
# only as an unpublished draft.
isPublished: Boolean 
# True when the field cannot be made writable (enforced by the platform).
systemReadonly: Boolean 
# If this field is allowed in global search.
useInGlobalSearch: Boolean 
# Type-specific configuration for the field (e.g. rollup definition, calculated 
# formula, AI options). Shape depends on type_id; null for fields that need no 
# extra configuration. This payload conforms to the `FieldOptionsProperty` JSON 
# Schema: https://api-doc.coevera.com/schemas/FieldOptionsProperty.json
settings: JSONString 
# If true, then there will be an API validation if value of entity is unique.
isUnique: Boolean 
# For dropdown, radio, and multiselect-checkbox fields, the set of available 
# options. Empty for other field types.
# 
# Arguments
# includeDeleted: When true, deleted options are returned too.
dataSet(includeDeleted: Boolean): [FieldDataSetRelation!] 
# Lookup field definition.
lookup: LookupProperty 
# Deprecated - previously returned sequence pattern used for sequence type of 
# field.
sequencePattern: String 
# Sequence field definition.
sequence: SequenceProperty 
# Rollup field definition.
rollup: RollupProperty 
# Type-specific settings of the field, such as the decimal places of a number or 
# the display of a record card; the shape depends on typeId. Empty for types 
# without settings.
options: FieldOptionsProperty 
# AI Smart Field options. Available for input, text_area, integer, float, email, 
# phone, url, currency.
aiOptions: FieldAiOptions 
# Formula of a calculated formula field - the expression, its result type and 
# display - as a JSON object conforming to the `AdvancedFormulaProperty` type; 
# empty for other field types.
advancedFormula: AdvancedFormulaProperty 
# For derived fields, id of the underlying source field that drives this field's 
# value (e.g. the value side of a composite currency field).
sourceFieldId: String! 
# Underlying primitive type id of the field, after resolving 
# composite/rollup/lookup wrappers.
sourceTypeId: String! 
# True when the field can be used in the record interface preview pane.
useInInterfacePreview: Boolean! 
# Field name resolved into the current user's language. When useLang is true, the 
# name is looked up via the translation system; otherwise name is returned as-is.
translatedName: String! 
# Per-user-role access overrides for this field. Empty when the field uses default 
# access (full access for all roles).
# 
# Arguments
# includeDeleted: When true, deleted permission overrides are 
# returned too.
fieldPermissions(includeDeleted: Boolean): [FieldPermissionEntity!] 
# When multiple dropdown/radio fields share a data set, id of the field that 
# originally defined the data set. Null when this field is the originator or has 
# no data set.
originalDatasetFieldId: UUID 
# Map of locale codes to translated field names (e.g. {"en-US": "First name", 
# "de-DE": "Vorname"}). Empty when no translations are defined.
nameTranslations: JSONString! 
# Field name in the current user's language, taken from nameTranslations. Empty 
# when no translation is available for that language.
nameTranslated: String 
# Primitive value type of the field (e.g. STRING, INT, BOOL, DATE, ENUM), derived 
# from sourceTypeId.
primitiveType: String! 
# True when the field cannot be edited on individual occurrences of a recurring 
# appointment (changes must be made on the recurrence master).
isReadonlyOnRecurrentAppointment: Boolean! 
# True when the field can be referenced from a Webresource URL template.
isAvailableForWebresource: Boolean! 
# True when the field can be used as an input in an advanced calculated formula 
# expression on this entity.
isAvailableForAdvancedFormula: Boolean! 
# Permissions the current user has on this record, out of the requested ones.
# 
# Arguments
# permissions: Permissions to check; the result lists those the 
# current user has.
instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]! 
}
FieldEntity

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
