Graph search · GraphQL query

graphSearchAutocomplete query

Requests autocomplete suggestions for a partially typed graph search where clause. See GraphSearchAutocompletePayload.

Response

Returns a GraphSearchAutocompletePayload!

Arguments

Name Description
input - GraphSearchAutocompleteInput! The autocomplete input: the organization, the object type scoping the where clause, the partially typed fragment, and the cursor position.

Example

Query

query graphSearchAutocomplete($input: GraphSearchAutocompleteInput!) {
  graphSearchAutocomplete(input: $input) {
    help
    queryOperators {
      label
      description
      replacement {
        ...GraphSearchAutocompleteReplacementFragment
      }
    }
    keys {
      label
      description
      documentationUrl
      replacement {
        ...GraphSearchAutocompleteReplacementFragment
      }
      field {
        ...SearchQuerySchemaFieldFragment
      }
    }
    keyOperators {
      label
      description
      replacement {
        ...GraphSearchAutocompleteReplacementFragment
      }
    }
    values {
      label
      description
      replacement {
        ...GraphSearchAutocompleteReplacementFragment
      }
    }
    field {
      name
      description
      fieldType
      isMultiKey
      canSort
      canColumn
    }
  }
}

Variables

{"input": GraphSearchAutocompleteInput}

Response

{
  "data": {
    "graphSearchAutocomplete": {
      "help": "xyz789",
      "queryOperators": [GraphSearchAutocomplete],
      "keys": [GraphSearchAutocompleteKey],
      "keyOperators": [GraphSearchAutocomplete],
      "values": [GraphSearchAutocomplete],
      "field": SearchQuerySchemaField
    }
  }
}