SearchCursorMeta

object

Pagination metadata.

pageobjectrequired
Show Child Parameters
Example

SearchCursorMetaPage

object
nextstring(path)

URI to the next page

sizenumberrequired

Requested page size

Example:10

Example

SearchResponse

object

Search response schema.

dataarray[object]

Item included in the list of search results.

Show Child Parameters
metaobject

Pagination metadata.

Show Child Parameters
Example

SearchableEntityTypesResponse

object

The collection of searchable entity types.

dataarray[object]
Show Child Parameters
Example

SearchableEntityAttributesResponse

object

Searchable attribute for the entity type.

typestringrequired

The attribute type.

Allowed values:stringnumberbooleanarray

formatstring

An optional hint at the contents and format of string types.

Allowed values:date-timeuuidemail

itemsobject

An optional hint at the type of content in array types.

Show Child Parameters
namestringrequired

The human-readable attribute name.

descriptionstringrequired

A short description of the attribute.

Example