Graph search · GraphQL type

RelationshipDirected type

A Relationship paired with the RelationshipDirection in which it is traversed from a particular graph object type.

Fields

Field Name Description
id - ID! Stable identifier for the directed relationship, used to reference it from search queries.
relationship - Relationship! The underlying Relationship — source and target object types, label, cardinality, and options.
direction - RelationshipDirection! The direction in which the relationship is traversed.
directionLabel - String! A human friendly label for the relationship verb in the configured traversal direction — the forward verb when SOURCE_TO_TARGET, or the inverse verb when TARGET_TO_SOURCE (e.g. "installed on" vs "installs").
labelFromSource - String! A human friendly label describing the portion of the relationship that follows the source object — the verb phrase plus the directed target's GraphObjectType label (e.g. "installed on Endpoint" when SOURCE_TO_TARGET, or "installs Application" when TARGET_TO_SOURCE).
label - String! A human friendly label.

Used by

  • GraphObjectTypeInfo type: Describes a single graph object type: its enum value, the relationships it participates in, and the properties available for use in search query…
  • GraphRelationshipSearchInput input: A relationship constraint applied to a GraphSearchQueryInput: match objects that have (or, when negated, do not have) a relationship to other…
  • GraphRelationshipSearchInputPayload type: Output mirror of GraphRelationshipSearchInput used when an executed query is returned as a field on another type.

Example

Example

{
  "id": "4",
  "relationship": Relationship,
  "direction": "SOURCE_TO_TARGET",
  "directionLabel": "xyz789",
  "labelFromSource": "xyz789",
  "label": "xyz789"
}