OBJECT

EntityRelationship

A typed relationship between two Entity instances

link GraphQL Schema definition

  • type EntityRelationship implements EntityRelationshipNodeInterface, Node, NodeVersion {
  • # This property represents an unique ID of the source collector
  • collectionSource: String
  • # Time this Relationship was created. Note: Expressed in UTC ISO-8601 format
  • creationTime: DateTime!
  • # Dest entity in this relationship. Can be null if the entity with the given
  • # entityId is not accessible
  • # due to permissions issues or due to a DB update
  • destEntity: Entity
  • # dest entityId
  • destEntityId: EntityId
  • # dest entity provider if available
  • destEntityProvider: String
  • # dest entity partition key if different to the cloudAccountId in the destEntityId
  • destEntityRemotePartitionKey: String
  • # dest entityType if available
  • destEntityType: String
  • # source entityType projected as an enum value, if available
  • destEntityTypeConst: EntityTypeConst
  • # Opaque global ID
  • id: ID!
  • # Last time this Relationship was updated. Note: Expressed in UTC ISO-8601 format
  • lastUpdateTime: DateTime!
  • # Versioning ID
  • nodeVersion: ID!
  • # 'Other' entity in this relationship
  • #
  • # This is defined as the entity the 'other' side of the traversal.
  • #
  • # - for IN traversal direction, it will be the same as the 'sourceEntity'
  • # - for OUT traversal direction, it will be the same as the 'destEntity'
  • # - for BOTH traversal direction, it will be the 'other' entity, not the one from
  • # which the traversal came.
  • #
  • # The field is not supported for aggregations or filtering.
  • otherEntity: Entity
  • # other entityId
  • otherEntityId: EntityId
  • # other entityType if available
  • otherEntityType: String
  • # other entityType projected as an enum value, if available
  • otherEntityTypeConst: EntityTypeConst
  • properties: [EntityProperty!]
  • # entity relationship id
  • relationshipId: String!
  • # Type of the relationship. e.g. RelatesTo etc
  • relationshipType: String!
  • # Source entity in this relationship. Can be null if the entity with the given
  • # entityId is not accessible
  • # due to permissions issues or due to a DB update
  • sourceEntity: Entity
  • # source entityId
  • sourceEntityId: EntityId
  • # source entity provider if available
  • sourceEntityProvider: String
  • # source entity partition key if different to the cloudAccountId in the
  • # sourceEntityId
  • sourceEntityRemotePartitionKey: String
  • # source entityType if available
  • sourceEntityType: String
  • # source entityType projected as an enum value, if available
  • sourceEntityTypeConst: EntityTypeConst
  • # Scope of relationship's traversal
  • traversalScope: EntityTraversalScope
  • }