Graph search · GraphQL type

GraphSearchQueryInputPayload type

Output mirror of GraphSearchQueryInput used when an executed query is returned as a field on another type (for example as part of a GraphSearchInputPayload).

Fields

Field Name Description
objectType - GraphObjectType! The type of object that was queried for.
relationships - [GraphRelationshipSearchInputPayload!]! Relationship constraints applied to the query.
where - String

The where-clause string the caller supplied, echoed back verbatim so it can be resubmitted unchanged. Null when the caller supplied whereExpression instead. At most one of where and whereExpression is ever set.

A string the caller sent is echoed exactly as sent, so a blank or whitespace-only one comes back non-null even though it applies no filter: test it for content rather than for null.

whereExpression - SearchQueryExpressionPayload The structured search condition the caller supplied, echoed back exactly as sent so it can be resubmitted unchanged. Null when the caller supplied a where string instead, and null when the query node carried no where filter. See SearchQueryExpressionPayload.
objectId - ID When included only the specified object will be returned for this query input.
select - Boolean! True when object property values were included in the results.
columns - [GraphSearchColumnInputPayload!]! The columns that were requested in the search results.
locationFilter - LocationFilter The location filter that was applied, if any. See GraphSearchQueryInput for the conditions under which it takes effect.

Used by

Example

Example

{
  "objectType": "ACCOUNT_POLICY",
  "relationships": [GraphRelationshipSearchInputPayload],
  "where": "xyz789",
  "whereExpression": SearchQueryExpressionPayload,
  "objectId": 4,
  "select": true,
  "columns": [GraphSearchColumnInputPayload],
  "locationFilter": LocationFilter
}