OBJECT

FieldEntity

link 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!
  • # Generic field wrapping sqlalchemy column, configurable by constructor.
  • #
  • # Good for one-of fields / generated fields.
  • #
  • 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!
  • # Generic field wrapping sqlalchemy column, configurable by constructor.
  • #
  • # Good for one-of fields / generated fields.
  • #
  • useLang: Int
  • # Simple text input field.
  • columnName: String
  • # Generic field wrapping sqlalchemy column, configurable by constructor.
  • #
  • # Good for one-of fields / generated fields.
  • #
  • columnSource: Int
  • # Generic field wrapping sqlalchemy column, configurable by constructor.
  • #
  • # Good for one-of fields / generated fields.
  • #
  • relationId: String
  • # Generic field wrapping sqlalchemy column, configurable by constructor.
  • #
  • # Good for one-of fields / generated fields.
  • #
  • relationWithEntityId: String
  • # Generic field wrapping sqlalchemy column, configurable by constructor.
  • #
  • # Good for one-of fields / generated fields.
  • #
  • sharedWithFieldId: ID
  • # Generic field wrapping sqlalchemy column, configurable by constructor.
  • #
  • # Good for one-of fields / generated fields.
  • #
  • 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!
  • # Generic field wrapping sqlalchemy column, configurable by constructor.
  • #
  • # Good for one-of fields / generated fields.
  • #
  • compositeFieldId: ID
  • # Optional custom data set id can be set.
  • dataSetId: ID
  • # Generic field wrapping sqlalchemy column, configurable by constructor.
  • #
  • # Good for one-of fields / generated fields.
  • #
  • parentDataSetId: ID
  • # Calculated formula used for fields which supports calculation.
  • calcFormula: String
  • # A default value for field.
  • defaultValue: String
  • # Generic field wrapping sqlalchemy column, configurable by constructor.
  • #
  • # Good for one-of fields / generated fields.
  • #
  • sequenceId: ID
  • # Generic field wrapping sqlalchemy column, configurable by constructor.
  • #
  • # Good for one-of fields / generated fields.
  • #
  • systemRequired: Boolean
  • # Generic field wrapping sqlalchemy column, configurable by constructor.
  • #
  • # Good for one-of fields / generated fields.
  • #
  • isPublished: Boolean
  • # Generic field wrapping sqlalchemy column, configurable by constructor.
  • #
  • # Good for one-of fields / generated fields.
  • #
  • systemReadonly: Boolean
  • # If this field is allowed in global search.
  • useInGlobalSearch: Boolean
  • # Field containing json.
  • 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!]
  • # A sequence pattern used for sequence type of field.
  • sequencePattern: String
  • isAvailableForWebresource: Boolean!
  • # Lookup field definition.
  • lookup: LookupProperty
  • # Rollup field definition.
  • rollup: RollupProperty
  • options: FieldOptionsProperty
  • sourceFieldId: String!
  • sourceTypeId: String!
  • useInInterfacePreview: Boolean!
  • translatedName: String!
  • # Arguments
  • # includeDeleted: [Not documented]
  • fieldPermissions(includeDeleted: Boolean): [FieldPermissionEntity!]
  • primitiveType: String!
  • # Checks which permissions current user has on concrete entity instance.
  • #
  • # Arguments
  • # permissions: [Not documented]
  • instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]!
  • }