INPUT_OBJECT

CustomEntityFilterInput

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

link GraphQL Schema definition

  • input CustomEntityFilterInput {
  • # Matches records that meet at least one of the listed filters.
  • OR: [CustomEntityFilterInput!]
  • # Matches records that meet all of the listed filters.
  • AND: [CustomEntityFilterInput!]
  • # Matches records that do not meet this filter.
  • NOT: CustomEntityFilterInput
  • # Search term matched against the fields that the global search covers for this
  • # entity.
  • globalSearchQuery: String
  • # Unique identifier of entity.
  • id: EntityFilterStringField
  • # Specifies if the entity is considered deleted.
  • isDeleted: Boolean
  • # Last modification time.
  • modified: EntityFilterDateTimeField
  • # Creation time.
  • created: EntityFilterDateTimeField
  • # Id of the currency exchange rate list applied to this record.
  • currencyExchangeRatesListId: EntityFilterStringField
  • # Name of the entity and its default text representation.
  • name: EntityFilterStringField
  • # Id of the sales user who owns the custom entity record.
  • ownerId: EntityFilterStringField
  • # Sharing model applied on top of the owner/unit visibility (e.g. shared with
  • # selected sales units or selected users).
  • shareMode: ShareModeEnumFilterInput
  • # Discriminator identifying which custom entity type this record belongs to.
  • # Read-only; matches CustomEntityType.entityApiName and is used as the entity name
  • # in REST and GraphQL queries.
  • tableName: EntityFilterStringField
  • # Id of the custom entity type.
  • typeId: EntityFilterStringField
  • # Id of the sales unit.
  • unitId: EntityFilterStringField
  • # Revision when entity was lastly changed.
  • revision: EntityFilterNumberField
  • # Conditions on custom fields, each identified by its api name. All listed
  • # conditions must match.
  • withCustom: [CustomField!]
  • # Currency exchange rate list used to convert monetary fields linked to this
  • # record. Empty to inherit the team space default. Matches records where a related
  • # record meets these conditions.
  • currencyExchangeRatesList: CurrencyExchangeRatesListFilterInput
  • # Sales user who owns this custom entity record. Matches records where a related
  • # record meets these conditions.
  • owner: ClientFilterInput
  • # Custom entity type that classifies this record. Custom entity types are
  • # configurable per team space and define the schema (fields and form) of the
  • # records. Matches records where a related record meets these conditions.
  • type: CustomEntityTypeFilterInput
  • # Sales unit this record is assigned to. Determines which team members can see the
  • # record under unit-based sharing. Matches records where a related record meets
  • # these conditions.
  • unit: SalesUnitFilterInput
  • # Sales units that have been granted shared access to this custom entity record.
  • # Editable only when shareMode allows unit sharing. Matches records where a
  • # related record meets these conditions.
  • sharingUnits: CustomEntitySharingSalesUnitRelationFilterInput
  • # Users that have been granted shared access to this custom entity record.
  • # Editable only when shareMode allows user sharing. Matches records where a
  • # related record meets these conditions.
  • sharingClients: CustomEntitySharingClientRelationFilterInput
  • # Documents linked to this custom entity record. Matches records where a related
  • # record meets these conditions.
  • documents: CloudObjectRelationFilterInput
  • # Saved view profiles this custom entity record currently matches. Matches records
  • # where a related record meets these conditions.
  • staticProfiles: ProfileRelationFilterInput
  • # Tag labels applied to this custom entity record. Matches records where a related
  • # record meets these conditions.
  • tags: TagRelationFilterInput
  • }

link Require by