OBJECT

CustomEntityTypeEntity

Configurable category of records of a custom entity that defines their form layout and settings; entityApiName names the custom entity.

link GraphQL Schema definition

  • type CustomEntityTypeEntity {
  • # True when the record has unpublished draft changes, including pending
  • # translation changes, that can be published.
  • hasDraft: Boolean
  • # 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!
  • # Typed, read-only view of a form layout of this type: formEditApi mirrors the
  • # edit form (formEdit), formLostApi the form shown when archiving as lost
  • # (formLost).
  • formEditApi: Form
  • # False for types whose read-only setting is fixed, such as the recurrent
  • # appointment type; true otherwise.
  • 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
  • # 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