Skip to main content

CustomFieldSearchFilterInput

Defines the filter criteria used when searching for custom fields.

The following rules apply:

  • Where a field accepts a list of values as a filter, those values are applied using an OR operator.
  • If specifying multiple fields to filter on (for example both CustomFieldSearchFilterInput and names), fields are applied using an AND operator.

Throws an error with code:

  • BAD_USER_INPUT if all fields in the input have a combined total number of values exceeding 1,000
input CustomFieldSearchFilterInput {
definitionIds: [ID!]
names: [String!]
uniqueCodes: [String!]
}

Fields

CustomFieldSearchFilterInput.definitionIds ● [ID!] list scalar

Filter custom fields based on their definition identifiers. Optional.

CustomFieldSearchFilterInput.names ● [String!] list scalar

Filter custom field based on their names. Optional.

CustomFieldSearchFilterInput.uniqueCodes ● [String!] list scalar

Filter custom fields based on their unique codes. Optional.