INPUT_OBJECT

FieldFilterInput

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

link GraphQL Schema definition

  • input FieldFilterInput {
  • # Matches records that meet at least one of the listed filters.
  • OR: [FieldFilterInput!]
  • # Matches records that meet all of the listed filters.
  • AND: [FieldFilterInput!]
  • # Matches records that do not meet this filter.
  • NOT: FieldFilterInput
  • # Search term matched against the fields that the global search covers for this
  • # entity.
  • globalSearchQuery: String
  • # Unique identifier of entity.
  • id: EntityFilterStringField
  • # True when the field is marked as deleted (soft-delete).
  • isDeleted: Boolean
  • # Last modification time.
  • modified: EntityFilterDateTimeField
  • # Creation time.
  • created: EntityFilterDateTimeField
  • # Related entity name for field (e.g. Account, Contact, Lead, Opportunity, ...).
  • # Must be a concrete entity: abstract parents such as LeadOppty or Activity are
  • # rejected. To share a field between Lead and Opportunity (or Task and
  • # Appointment), create it on one of them and set mapDependency to the other.
  • entityName: EntityFilterStringField
  • # Immutable and generated name. This name is used for integrations.
  • apiName: EntityFilterStringField
  • # User friendly name for field.
  • name: EntityFilterStringField
  • # When true, the field name is treated as a translation key and resolved through
  • # the translation system; otherwise the literal name is shown.
  • useLang: EntityFilterNumberField
  • # Storage column name for the field; used as the filter key in API queries.
  • columnName: EntityFilterStringField
  • # Storage origin of the field: on the main entity record, on the custom-field data
  • # record, or computed.
  • columnSource: EntityFilterNumberField
  • # For relation-typed fields, identifier of the relation kind that connects this
  • # entity to the related entity. Empty for non-relation fields.
  • relationId: EntityFilterStringField
  • # For relation-typed fields, the entity the field points to (e.g. Contact,
  • # Account). Empty for non-relation fields.
  • relationWithEntityId: EntityFilterStringField
  • # When the field is shared between abstract entities (e.g. Lead and Opportunity),
  • # id of the counterpart field on the other entity. Empty when the field is not
  • # shared.
  • sharedWithFieldId: EntityFilterStringField
  • # Whether the field is System (built-in, immutable), Protected (built-in, limited
  • # changes), or Custom (user-created).
  • systemType: EntityFilterNumberField
  • # Type of the field. Supported field types are: checkbox, currency,
  • # currency_foreign, date, datetime, dropdown, email, float, input, integer,
  • # multiselect_checkbox, phone, radio, sequence, text_area, url
  • typeId: EntityFilterStringField
  • # For sub-fields of a composite field (e.g. the value/currency parts of a foreign
  • # currency field), id of the parent composite field. Empty for top-level fields.
  • compositeFieldId: EntityFilterStringField
  • # Optional custom data set id can be set.
  • dataSetId: EntityFilterStringField
  • # For dependent dropdown/radio fields, id of the parent field whose selected value
  • # restricts the options shown on this field.
  • parentOptionsFieldId: EntityFilterStringField
  • # Calculated formula used for fields which supports calculation.
  • calcFormula: EntityFilterStringField
  • # Value pre-filled into this field on newly created records, as text converted to
  • # the field type; empty for no default. Accepted only by field types that support
  • # a default value.
  • defaultValue: EntityFilterStringField
  • # For sequence-typed fields, id grouping the FieldSequence rows that drive
  • # auto-numbering for this field.
  • sequenceSetId: EntityFilterStringField
  • # True when the field cannot be made optional (enforced by the platform).
  • systemRequired: Boolean
  • # True when the field configuration is published; false while the field exists
  • # only as an unpublished draft.
  • isPublished: Boolean
  • # True when the field cannot be made writable (enforced by the platform).
  • systemReadonly: Boolean
  • # If this field is allowed in global search.
  • useInGlobalSearch: Boolean
  • # If true, then there will be an API validation if value of entity is unique.
  • isUnique: Boolean
  • # Deprecated - previously returned sequence pattern used for sequence type of
  • # field.
  • sequencePattern: EntityFilterStringField
  • }

link Require by