The entitiesSearch() is used to query assets across LogScale views and repositories. It will return only the first page. The response includes a cursor that can be sent to entitiesPage() to get next or previous pages with the same parameters.

Syntax

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

graphql
entitiesSearch(
      input: EntitySearchInputType!
   ): SearchResult!

For the input,see the Given Datatypes section below. What to use for the return, for SearchResult is listed in the Results Datatypes section.

Given Datatypes

For EntitySearchInputType, there are a few parameters that may be given. Below is a list of them along with their datatypes and a description of each:

Table: EntitySearchInputType

ParameterTypeRequired[a]DefaultDescription
entityTypes[EntitySearchEntityType]yes The types of entity. See EntitySearchEntityType.
pageSizeinteger 100The number of records to return per page.
paths[string]yes Theh paths to search.
searchTermstring  Text on which to search assets in views and repositories.
sortBy[EntitySearchSortInfoType]yes Enter name with a string for the field on which to sort. See EntitySearchSortInfoType.

[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.


Returned Datatypes

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

Table: SearchResult

ParameterTypeRequired[a]DefaultDescription
totalResultsintegeryes The total number of results that matched the search query. Only pageSize elements will be returned.
data[EntitySearchResultEntity]yes The results of the search.
cursorstring  The cursor useds for going to the next or previous page.
hasNextPagebooleanyes Whether there is a next page. False indicates it's the last page.
hasPreviousPagebooleanyes Whether there is a previous page. False indicates it's the first page.

[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.