OBJECT

CustomEntityTypeEntity

link GraphQL Schema definition

  • type CustomEntityTypeEntity {
  • hasDraft: Boolean
  • # 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!
  • formEditApi: Form
  • # Returns if user can change readonly flag on this entity_type.
  • canChangeReadonly: Boolean
  • # Unique identifier of entity.
  • id: ID!
  • # Specifies if the entity is considered deleted.
  • isDeleted: Boolean
  • # Last modification time.
  • modified: DateTime
  • # Creation time.
  • created: DateTime
  • # JSON definition of the form layout used by the UI when creating or editing
  • # records of this custom entity type.
  • formEdit: JSONString!
  • # True when the custom entity type is system-managed and cannot be edited or
  • # deleted by users.
  • isReadonly: Boolean!
  • # Name of the entity and its default text representation.
  • name: String!
  • # Per-type configuration for records of this entity type, e.g. allowed task and
  • # appointment types that may be linked to records of this type.
  • settings: EntityTypeSettings!
  • # True when the entity configuration is published; false while it exists only as
  • # an unpublished draft.
  • isPublished: Boolean
  • # API name of the custom entity type (e.g. "Vehicle", "Project_Phase"). Used as
  • # the entity name when calling REST endpoints or selecting a concrete custom
  • # entity in GraphQL.
  • entityApiName: String
  • # Checks which permissions current user has on concrete entity instance.
  • #
  • # Arguments
  • # permissions: [Not documented]
  • instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]!
  • }