Skip to main content

AttributeDescriptionSearchInput

Search criteria for filtering attribute descriptions with comprehensive options.

Provides flexible filtering capabilities for attribute descriptions including ID-based lookups, name matching, class filtering, and type-based searches. Supports pagination and sorting for large result sets.

input AttributeDescriptionSearchInput {
  ids: [String!]
  names: [String!]
  classes: [AttributeDescriptionClass!]
  types: [AttributeType!]
  groups: [String!]
  isSearchable: Boolean
  isPublic: Boolean
  isHidden: Boolean
  isSystem: Boolean
  term: String
  termFields: [AttributeAttributeDescriptionTermField!]
  termLanguages: [String!]
  offset: Int
  page: Int
  sortInputs: [AttributeDescriptionSortInput!]
}

Fields​

AttributeDescriptionSearchInput.ids ● [String!] list scalar​

Specific attribute description IDs to retrieve.

Filter results to only include attribute descriptions with the specified UUIDs. Array must not be empty when provided and must contain unique values.

AttributeDescriptionSearchInput.names ● [String!] list scalar​

Specific attribute description names to retrieve.

Filter results to only include attribute descriptions with the specified names. Names must be in SCREAMING_SNAKE_CASE format. Array must not be empty when provided and must contain unique values.

AttributeDescriptionSearchInput.classes ● [AttributeDescriptionClass!] list enum​

Specific attribute description classes to retrieve.

Filter results to only include attribute descriptions with the specified entity classes. Each class maintains its own attribute namespace. Array must not be empty when provided and must contain unique values.

AttributeDescriptionSearchInput.types ● [AttributeType!] list enum​

Specific attribute description data types to retrieve.

Filter results to only include attribute descriptions with the specified data types. Array must not be empty when provided and must contain unique values.

AttributeDescriptionSearchInput.groups ● [String!] list scalar​

Specific attribute description groups to retrieve.

Filter results to only include attribute descriptions that belong to the specified groups. Groups are used for organizing related attributes. Array must not be empty when provided and must contain unique values.

AttributeDescriptionSearchInput.isSearchable ● Boolean scalar​

Filter by searchable status.

When true, returns only attribute descriptions that are enabled for search and filtering operations. When false, returns only non-searchable attribute descriptions.

AttributeDescriptionSearchInput.isPublic ● Boolean scalar​

Filter by public visibility status.

When true, returns only attribute descriptions that are configured to be displayed in product specifications and are visible to end users. When false, returns only attribute descriptions that are not included in public product specifications.

AttributeDescriptionSearchInput.isHidden ● Boolean scalar​

Filter by hidden status for background operations.

When true, returns only attribute descriptions that are hidden from user interfaces and used exclusively for background system operations. When false, returns only visible attribute descriptions.

AttributeDescriptionSearchInput.isSystem ● Boolean scalar​

Filter by system access restriction.

When true, returns only attribute descriptions that are restricted to administrative users and not accessible to regular users. When false, returns only attribute descriptions available to all user types.

AttributeDescriptionSearchInput.term ● String scalar​

Free-text search term to filter by.

Performs a full-text search across attribute description fields. Use this to find attribute descriptions that match a specific keyword or phrase.

AttributeDescriptionSearchInput.termFields ● [AttributeAttributeDescriptionTermField!] list enum​

Fields to search in when using the term filter.

Specifies which fields should be included in the full-text search when a term is provided. Defaults to searching in all fields. Array must contain unique values and be non-empty when provided.

AttributeDescriptionSearchInput.termLanguages ● [String!] list scalar​

Languages to search in when using the term filter.

Specifies which languages should be included in the full-text search when a term is provided. All languages are included by default. Array must contain unique values and be non-empty when provided.

AttributeDescriptionSearchInput.offset ● Int scalar​

Number of results to return per page.

Specifies the maximum number of attribute descriptions to include in each page of results. Used in combination with page number to control pagination and result set size. Defaults to 12 if not specified.

AttributeDescriptionSearchInput.page ● Int scalar​

Current page number for paginated results.

Specifies which page of results to retrieve when dealing with large datasets. Page numbers start from 1. Used together with offset to control pagination behavior. Defaults to 1 if not specified.

AttributeDescriptionSearchInput.sortInputs ● [AttributeDescriptionSortInput!] list input​

Sorting criteria for ordering search results.

Defines how the returned attribute descriptions should be ordered. Multiple sort criteria can be applied in sequence. Array must not be empty when provided and must contain unique sorting configurations.

Member Of​

attributeDescriptions query