Graph search · GraphQL input

GraphSearchAutocompleteInput input

Graph search autocomplete input parameters. The whereFragment is a partially typed graph search where clause (the query string form accepted by GraphParseQueryInput) and position is the cursor's offset into it counting UTF-8 characters (runes); suggestions are computed for the expression the cursor is editing.

Fields

Input Field Description
orgId - OrganizationId! The Organization whose indexed values are suggested.
objectType - GraphObjectType! The graph object type scoping the where clause; only its keys and values are suggested.
whereFragment - String! The partially typed where-clause fragment to complete.
position - Int! The cursor's offset into whereFragment counting UTF-8 characters (runes), in the range 0 to the fragment's rune count — the same unit as the position returned in GraphSearchAutocompleteReplacement, so a selected replacement's position can be resubmitted directly.
highlight - Boolean! When true each suggestion's label wraps the matched portion in tags. Default = false
first - Int Returns the first n value suggestions. By default the first 100 are returned. Max is 1,000.

Example

Example

{
  "orgId": "615f3b3b28284380e28a7342",
  "objectType": "ACCOUNT_POLICY",
  "whereFragment": "abc123",
  "position": 123,
  "highlight": true,
  "first": 987
}