ConnectorEntity

Object

One row of a connector's entities namespace: an entity the connector imported from its source system, staged until a merge writes it to the graph.

context is free-form JSON. It holds the connector's own read-only source data, plus, on previewConnectorEntities responses only, a reserved __preview bucket the server computes for each row:

{
  "area": 42.5,
  "number": "B1-204",
  "__preview": {
    "tags": ["selected", "updated", "updatedFields", "firstSeen"],
    "fields": {
      "name":  { "display": "DEFAULT", "diverged": true },
      "floor": { "display": "RULE", "graphCheck": "UNRESOLVED" }
    },
    "selection": { "display": "SETTLED" },
    "selectable": true,
    "missingRequired": [],
    "duplicateUnique": [],
    "removedFields": ["legacyCode"],
    "contextChanged": true,
    "contextChangedKeys": ["buildingCode", "buildingName"],
    "baseTypeChanged": true,
    "rulesError": { "scope": "entity", "message": "Cannot read properties of undefined", "line": 3, "column": 12 }
  }
}

tags values: selected, added, updated, updatedFields, updatedContext, deleted, missing, unresolved, firstSeen. Every updated row also carries exactly one of updatedFields (an entity property changed: a field value, set by a user, a rule or the source system; a field no longer declared; or the base type) and updatedContext (only the connector's source context changed). A row with both kinds of change is updatedFields. display values, in precedence order: CONFLICT, RULE, UNSAVED, DEFAULT, SETTLED. diverged, removedFields, contextChanged and baseTypeChanged appear only when true or non-empty, and say why an updated row changed. contextChangedKeys appears next to contextChanged on the rows of a listing page: the top-level context keys that changed, were added or were removed since the entity's last merge; it is absent when the entity's last merge predates it. rulesError appears only when the merge rule failed for the row: scope is entity for this row only, or rule for the whole rule, on every row. Keys starting with __ are reserved for the platform.

type ConnectorEntity {
  baseType: ConnectorEntityBaseType
  context: GraphQLJSON
  exactType: EntityTypeKey @deprecated
  fields: [ConnectorEntityField]
  id: String
  lastChangeDate: DateTime
  lastChangeKind: ConnectorEntityChangeKind
  legacyMappingKey: String
  mappedId: String
  mappingKey: String
  mergingState: ConnectorEntityMergingState
  refId: String
  sourceType: String
}

Fields

Field	Type	Description
`baseType`	`ConnectorEntityBaseType`
`context`	`GraphQLJSON`	Free-form JSON from the connector, plus the server-computed `__preview` bucket on preview responses; see the example in the type description.
`exactType`	`EntityTypeKey`	Deprecated No longer supported
`fields`	`[ConnectorEntityField]`
`id`	`String`
`lastChangeDate`	`DateTime`
`lastChangeKind`	`ConnectorEntityChangeKind`
`legacyMappingKey`	`String`
`mappedId`	`String`
`mappingKey`	`String`
`mergingState`	`ConnectorEntityMergingState`
`refId`	`String`
`sourceType`	`String`

Used by

ConnectorEntityListResponse.entities (field)
ConnectorEntityMigrationEntity.entity (field)

Fields​

Used by​

Fields

Used by