Graph search · GraphQL input

GraphSearchQueryInput input

Specifies the search criteria for a single graph query: the object type to return, optional time and location filters, relationship constraints, the where clause, and the columns to return.

Fields

Input Field Description
objectType - GraphObjectType! The type of object to query for.
relationships - [GraphRelationshipSearchInput!] Restrict matches to objects that have or do not have the specified relationships to other objects.
where - String The search condition applied to the returned objects, written as a where-clause string. When null or empty no where filter is applied. Mutually exclusive with whereExpression.
whereExpression - SearchQueryExpressionInput

The same search condition as where, supplied as a data structure instead of a query string — for callers that build a query programmatically rather than composing text. See SearchQueryExpressionInput.

Supplying both where and whereExpression on one query node is an error. The expression is validated against the search schema and planned directly rather than being rendered into query text, so it can carry values the query syntax cannot express, and the search job echoes it back unchanged for resubmission.
objectId - ID When included only the specified object will be returned for this query input.
select - Boolean! True when object property values should be included in the results. When true and columns is empty the object type's default columns are returned.
columns - [GraphSearchColumnInput!] The columns to include in the search results. When empty and select is true the object type's default columns are returned. When select is false this field is ignored.
locationFilter - LocationFilterInput Filters the objects returned by this query node to those at a matching geographic location. Valid only when objectType is itself a 2D geographic position (currently only POSITION_SEEN) — whether this node is the query root or the target of a relationship (see supportsLocationFilter on GraphObjectTypeInfo). Applying it to any other object type is rejected. When null no location filter is applied.

Used by

Example

Example

{
  "objectType": "ACCOUNT_POLICY",
  "relationships": [GraphRelationshipSearchInput],
  "where": "abc123",
  "whereExpression": SearchQueryExpressionInput,
  "objectId": 4,
  "select": true,
  "columns": [GraphSearchColumnInput],
  "locationFilter": LocationFilterInput
}