OBJECT

EntityEntity

Kind of record in the space, such as Account, Lead or a custom entity, with its display names and behavior.

link GraphQL Schema definition

  • type EntityEntity {
  • # 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!
  • # Stable identifier of the entity (e.g. "Account", "Lead", "Opportunity").
  • entityName: String
  • # Storage identifier of the entity. Read-only.
  • tableName: String
  • # Storage identifier of the entity's custom-field data. Read-only.
  • tableEx: String
  • # Storage identifier of the entity's option relation data. Read-only.
  • tableDataEx: String
  • # Id of the field used as the default display label for records of this entity.
  • defaultViewFieldId: ID!
  • # For sub-entities (e.g. Lead/Opportunity sharing a LeadOppty parent), the entity
  • # name of the parent abstract entity. Empty for stand-alone entities.
  • abstractEntityId: ID!
  • # Kind of the entity in the platform: business entity, system schema, custom
  • # entity, etc.
  • entityType: Int!
  • # Display order used to sort entities in pickers and navigation lists; lower
  • # values appear first.
  • preferenceOrder: Int!
  • # True when records of this entity can be linked to multiple records of the same
  • # other entity through the same relation.
  • allowsMultipleRelation: Boolean
  • # True when records of this entity support drafts (changes go through a draft
  • # before being published).
  • hasDraft: Boolean!
  • # Access scope of records of this entity: shared across the entire space, scoped
  • # to a sales unit, or owner-only.
  • accessMode: Int!
  • # Numeric icon identifier used to render the entity in the UI.
  • icon: Int!
  • # True when the entity is marked as deleted (soft-delete). Read-only at the
  • # entity-metadata level.
  • isDeleted: Boolean
  • # Last modification time.
  • modified: DateTime
  • # Creation time.
  • created: DateTime
  • # Optional space-level configuration for the entity (e.g. UI/feature flags). Empty
  • # when no overrides are set.
  • settings: JSONString
  • # Display name of the entity in singular form (e.g. "Account").
  • nameSingular: String
  • # Display name of the entity in plural form (e.g. "Accounts").
  • namePlural: 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