OBJECT
FieldEntity

GraphQL Schema definition

type FieldEntity {
#   Tells if the entity instance is protected against delete (Entities that need to 
#   be present in the system at any time). Delete action still may fail if entity is 
#   deletable, due some other additional validations.
isDeleteProtected: Boolean! 
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, ...)
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 
#   A default value for field.
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 sequence_set_id 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.
settings: JSONString 
#   If true, then there will be an API validation if value of entity is unique.
isUnique: Boolean 
# Arguments
#   includeDeleted: [Not documented]
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 
#   Available option values for dropdown, radio, and multiselect-checkbox fields, 
#   including labels and translations. Empty for other field types.
options: FieldOptionsProperty 
#   AI Smart Field options. Available for input, text_area, integer, float, email, 
#   phone, url, currency.
aiOptions: FieldAiOptions 
#   Advanced calculated formula
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 use_lang is true, the 
#   name is looked up via the translation system; otherwise name is returned as-is.
translatedName: String! 
# Arguments
#   includeDeleted: [Not documented]
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 name_translations. 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 source_type_id.
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! 
#   Checks which permissions current user has on concrete entity instance.
# 
# Arguments
#   permissions: [Not documented]
instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]! 
}
FieldEntity

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
