OBJECT

TypeEntity

link GraphQL Schema definition

  • type TypeEntity {
  • # 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!
  • # Unique identifier of entity.
  • id: ID!
  • # Field whose values are strictly defined with an enumeration of values.
  • primitiveType: PrimitiveType!
  • # Field containing json.
  • validator: JSONString
  • # This field is bit flag which determinate purpose of the field and his
  • # abilities on form, following options are allowed
  • #
  • # CUSTOM_ALLOWED = 1 # field of this type can be created as new custom field
  • #
  • # CALC_ALLOWED = 2 # field can have calculation formula defined
  • #
  • # DEFAULT_ALLOWED = 4 # field can have default value defined
  • #
  • # MOBILE_ALLOWED = 8 # field can be displayed on form
  • #
  • # FIELD_MAP_REQUIRED = 16 # Obsolete
  • #
  • # FORM_FORBIDDEN = 32 # field of this type can't be located on form
  • #
  • # READONLY_ALLOWED = 64 # field can be defined as readonly on form
  • #
  • # ONLY_MAIN_FORM = 128 # field can be only at FORM_EDIT form not on e.g FORM_LOST
  • #
  • # ALLOWED_IN_CALC_FORMULA = 256 # field can be used within calculation expression
  • #
  • # MUST_BE_ON_FORM = 512 # field of this type can't be removed from form
  • #
  • #
  • flag: Int!
  • # Generic field wrapping sqlalchemy column, configurable by constructor.
  • #
  • # Good for one-of fields / generated fields.
  • #
  • defaultValue: String
  • # Field whose values are strictly defined with an enumeration of values.
  • relationType: RelationType!
  • # Generic field wrapping sqlalchemy column, configurable by constructor.
  • #
  • # Good for one-of fields / generated fields.
  • #
  • containerSize: Int!
  • # Boolean value.
  • isGroupable: Boolean!
  • # Boolean value.
  • isFilterable: Boolean!
  • # Boolean value.
  • isSortable: Boolean!
  • # Boolean value.
  • isSelectable: Boolean!
  • # Checks which permissions current user has on concrete entity instance.
  • #
  • # Arguments
  • # permissions: [Not documented]
  • instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]!
  • }