Skip to main content

CustomFieldDefinitionSearchFilterInput

Defines the filter criteria used when searching for custom field definitions.

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 customFieldDefinitionIds 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 CustomFieldDefinitionSearchFilterInput {
customFieldDefinitionIds: [ID!]
names: [String!]
uniqueCodes: [String!]
}

Fields

CustomFieldDefinitionSearchFilterInput.customFieldDefinitionIds ● [ID!] list scalar

Filter custom field definitions based on their identifiers. Optional.

CustomFieldDefinitionSearchFilterInput.names ● [String!] list scalar

Filter custom field definitions based on their names. Optional.

CustomFieldDefinitionSearchFilterInput.uniqueCodes ● [String!] list scalar

Filter custom field definitions based on their unique codes. Optional.