OBJECT

TypeEntity

Data type of fields, defining the kind of value, its validation and whether fields of the type can be filtered, sorted or grouped.

link GraphQL Schema definition

  • type TypeEntity {
  • # 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!
  • # Unique identifier of entity.
  • id: ID!
  • # Underlying data type of values of this field type, such as STRING, DECIMAL or
  • # DATETIME. Read-only.
  • primitiveType: PrimitiveType!
  • # Validation rules applied to values of this type (e.g. max length, regex, allowed
  • # enum values), as a JSON document.
  • validator: JSONString
  • # What fields of this type can do, as a sum of flags: 1 - can be a custom field, 2
  • # - can have a calculation formula, 4 - can have a default value, 8 - can be shown
  • # on mobile, 16 - needs a field mapping, 32 - cannot be placed on forms, 64 - can
  • # be read-only on forms, 128 - only on the main form, 256 - can be used in
  • # calculation formulas, 512 - must stay on the form, 1024 - searchable in global
  • # search, 2048 - needs a calculation formula, 4096 - can be used in advanced
  • # calculation formulas.
  • flag: Int!
  • # Default value applied to fields of this type when no value is supplied at
  • # create-time. Empty when the type has no default.
  • defaultValue: String
  • # Whether fields of this type hold a plain value (NO_RELATION), a reference to one
  • # related record (MANY_TO_ONE_SCALAR) or a collection of related records
  • # (MANY_TO_MANY_VECTOR).
  • relationType: RelationType!
  • # Maximum length or capacity for fields of this type (e.g. string max-length).
  • containerSize: Int!
  • # True when fields of this type can be used as a grouping column in reports.
  • isGroupable: Boolean!
  • # True when fields of this type can be used in filters.
  • isFilterable: Boolean!
  • # True when fields of this type can be used to sort records.
  • isSortable: Boolean!
  • # True when fields of this type can be selected in queries.
  • isSelectable: 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!]!
  • }

link Require by