OBJECT

InterfacePreviewEntity

Layout of how records of an entity type are previewed in the app: preview and card fields, detail tabs, widgets and charts.

link GraphQL Schema definition

  • type InterfacePreviewEntity {
  • # 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!
  • # True when the record has unpublished draft changes, including pending
  • # translation changes, that can be published.
  • hasDraft: 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
  • # Account type the interface preview applies to.
  • accountType: AccountTypeEntity
  • # Appointment type the interface preview applies to.
  • appointmentType: AppointmentTypeEntity
  • # Contact type the interface preview applies to.
  • contactType: ContactTypeEntity
  • # Custom entity type the interface preview applies to.
  • customEntityType: CustomEntityTypeEntity
  • # Lead type the interface preview applies to.
  • leadType: LeadTypeEntity
  • # Opportunity type the interface preview applies to.
  • opptyType: OpportunityTypeEntity
  • # Product type the interface preview applies to.
  • productType: ProductTypeEntity
  • # Project type the interface preview applies to.
  • projectType: ProjectTypeEntity
  • # Quote type the interface preview applies to.
  • quoteType: QuoteTypeEntity
  • # Task type the interface preview applies to.
  • taskType: TaskTypeEntity
  • # Id of the account type the interface preview applies to.
  • accountTypeId: ID
  • # Id of the appointment type the interface preview applies to.
  • appointmentTypeId: ID
  • # Ordered ids of fields shown on the record's compact card view.
  • cardFieldIds: [UUID!]!
  • # Chart configurations shown in the preview, each linked to a related entity (e.g.
  • # recent activities, related contacts, comments).
  • charts: [InterfacePreviewChart!]!
  • # Id of the contact type the interface preview applies to.
  • contactTypeId: ID
  • # Id of the custom entity type the interface preview applies to.
  • customEntityTypeId: ID
  • # Tab configurations shown on the record's detail screen (Detail tab plus
  • # related-entity and lookup tabs).
  • detailTabs: [InterfaceDetailTab!]!
  • # Widget configurations shown on the record's detail screen sidebar (e.g. Status,
  • # KPIs).
  • detailWidgets: [InterfaceDetailWidget!]!
  • # Ordered ids of fields shown in the record's preview pane.
  • fieldIds: [UUID!]!
  • # Id of the lead type the interface preview applies to.
  • leadTypeId: ID
  • # Id of the opportunity type.
  • opptyTypeId: ID
  • # Id of the product type the interface preview applies to.
  • productTypeId: ID
  • # Id of the project type the interface preview applies to.
  • projectTypeId: ID
  • # Id of the quote type the interface preview applies to.
  • quoteTypeId: ID
  • # Layout-customization settings for the preview (e.g.
  • # isLayoutCustomizationEnabled). This payload conforms to the
  • # `InterfacePreviewCustomSettings` JSON Schema:
  • # https://api-doc.coevera.com/schemas/InterfacePreviewCustomSettings.json
  • settings: InterfacePreviewCustomSettings!
  • # Id of the task type the interface preview applies to.
  • taskTypeId: ID
  • # True when the interface preview is published; false while it exists only as an
  • # unpublished draft.
  • isPublished: Boolean
  • # Revision when entity was lastly changed.
  • revision: Int
  • # Id of the type the interface preview is configured for, derived from whichever
  • # of the per-entity-type relations is set.
  • entityTypeId: UUID!
  • # For custom entities, the API name of the targeted custom entity. Empty when the
  • # preview targets a built-in entity (use entityType to identify it).
  • entityApiName: String
  • # Entity kind the interface preview applies to (Account, Lead, Opportunity,
  • # Contact, Task, Appointment, Project, Quote, CustomEntity, or Product). Derived
  • # from whichever of the per-entity-type relations is set.
  • entityType: BaseEntityTypeEnum!
  • # 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