The querySearchDomains() GraphQL query is used for query search domains with an organization filter.

For more information on searching repositories and views, see the Searching Data documentation page.

Syntax

Below is the syntax for the querySearchDomains() query field:

querySearchDomains(
   searchFilter: string
   typeFilter: SearchDomainTypes!
   sortBy: Searchdomain__SortBy!
   orderBy: OrderBy = ASC
   skip: integer = 0
   limit: integer = 50
): SearchDomainSearchResultSet!

Given and Returned Datatypes

The given datatype SearchDomainTypes is an enumerated list: All, Views, or repository(). The Searchdomain__SortBy is also an enumerated list of choices: Name, Volume, or DeletedAt

The returned datatype SearchDomainSearchResultSet has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: SearchDomainSearchResultSet

ParameterTypeRequired[a]DefaultDescription
totalResultsintegeryes The total number of matching results.
results[SearchDomain]yes The paginated results set (see SearchDomain Table).

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.