Graph search · GraphQL type

Relationship type

Describes a relationship between two graph object types: the source and target object types, the relationship label, its cardinality, and additional options.

Fields

Field Name Description
source - GraphObjectType! The source GraphObjectType of the relationship.
sourceLabel - String! A human friendly label for the source GraphObjectType (e.g. "Application").
relationship - RelationshipType! The relationship label.
relationshipLabel - String! A human friendly label for the relationship verb — the RelationshipType connecting source to target (e.g. "installed on").
target - GraphObjectType! The target GraphObjectType of the relationship.
targetLabel - String! A human friendly label for the target GraphObjectType (e.g. "Endpoint").
invertRelationship - RelationshipType! The label applied to the inverse traversal of the relationship.
invertRelationshipLabel - String! A human friendly label for the inverse relationship verb — the RelationshipType applied when traversing target to source (e.g. "installs").
cardinality - RelationshipCardinality! The cardinality of the relationship.
options - RelationshipOptions! Additional attributes that modify the relationship behavior.
targetIs2DPosition - Boolean! True when the target of the relationship is a PositionSeen object that is itself a 2D geographic position and therefore supports a location filter on geospatial queries. Derived from the target GraphObjectType.
label - String! A human friendly label for the entire relationship — source noun, verb, and target noun (e.g. "Application installed on Endpoint").

Used by

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

Example

Example

{
  "source": "ACCOUNT_POLICY",
  "sourceLabel": "abc123",
  "relationship": "ACTING_AS_GATEWAY_FOR",
  "relationshipLabel": "abc123",
  "target": "ACCOUNT_POLICY",
  "targetLabel": "abc123",
  "invertRelationship": "ACTING_AS_GATEWAY_FOR",
  "invertRelationshipLabel": "xyz789",
  "cardinality": "ONE_TO_ONE",
  "options": RelationshipOptions,
  "targetIs2DPosition": true,
  "label": "xyz789"
}