INPUT_OBJECT

EntityFilterInput

Filter conditions for Entity records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.

link GraphQL Schema definition

  • input EntityFilterInput {
  • # Matches records that meet at least one of the listed filters.
  • OR: [EntityFilterInput!]
  • # Matches records that meet all of the listed filters.
  • AND: [EntityFilterInput!]
  • # Matches records that do not meet this filter.
  • NOT: EntityFilterInput
  • # Search term matched against the fields that the global search covers for this
  • # entity.
  • globalSearchQuery: String
  • # Unique identifier of entity.
  • id: EntityFilterStringField
  • # Stable identifier of the entity (e.g. "Account", "Lead", "Opportunity").
  • entityName: EntityFilterStringField
  • # Storage identifier of the entity. Read-only.
  • tableName: EntityFilterStringField
  • # Storage identifier of the entity's custom-field data. Read-only.
  • tableEx: EntityFilterStringField
  • # Storage identifier of the entity's option relation data. Read-only.
  • tableDataEx: EntityFilterStringField
  • # Id of the field used as the default display label for records of this entity.
  • defaultViewFieldId: EntityFilterStringField
  • # 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: EntityFilterStringField
  • # Kind of the entity in the platform: business entity, system schema, custom
  • # entity, etc.
  • entityType: EntityFilterNumberField
  • # Display order used to sort entities in pickers and navigation lists; lower
  • # values appear first.
  • preferenceOrder: EntityFilterNumberField
  • # 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: EntityFilterNumberField
  • # Numeric icon identifier used to render the entity in the UI.
  • icon: EntityFilterNumberField
  • # True when the entity is marked as deleted (soft-delete). Read-only at the
  • # entity-metadata level.
  • isDeleted: Boolean
  • # Last modification time.
  • modified: EntityFilterDateTimeField
  • # Creation time.
  • created: EntityFilterDateTimeField
  • # Display name of the entity in singular form (e.g. "Account").
  • nameSingular: EntityFilterStringField
  • # Display name of the entity in plural form (e.g. "Accounts").
  • namePlural: EntityFilterStringField
  • }

link Require by