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.
- : Boolean!
- # Unique identifier of entity.
- : ID!
- # Field whose values are strictly defined with an enumeration of values.
- : PrimitiveType!
- # Validation rules applied to values of this type (e.g. max length, regex, allowed
- # enum values), as a JSON document.
- : 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
- #
- #
- : Int!
- # Default value applied to fields of this type when no value is supplied at
- # create-time. Empty when the type has no default.
- : String
- # Cardinality of the relation when the type represents a relation (e.g.
- # one-to-one, many-to-one).
- : RelationType!
- # Maximum length or capacity for fields of this type (e.g. string max-length).
- : Int!
- # True when fields of this type can be used as a grouping column in reports.
- : Boolean!
- # True when fields of this type can be used in filters.
- : Boolean!
- # True when fields of this type can be used to sort records.
- : Boolean!
- # True when fields of this type can be selected in queries.
- : Boolean!
- # Checks which permissions current user has on concrete entity instance.
- #
- # Arguments
- # permissions: [Not documented]
- (: [EntityPermsEnum!]!): [EntityPermsEnum!]!
- }