AckdbContactRelationship

One report-contact to manager-contact episode. Both endpoints are affiliations at entityId; matrix reporting is valid.

Properties

relationshipIdstringrequired
classstringrequired
entityIdstringrequired
reportContactAckdbContactGraphContactrequired
managerContactAckdbContactGraphContactrequired
relationshipTypestringrequired
reportToManagerLabelstringrequired
managerToReportLabelstringrequired
statestringrequired
"active""ended""retracted"
effectiveFromstring <date-time>required
effectiveTostring <date-time> (nullable)required
retractedAtstring <date-time> (nullable)required
provenanceAckdbContactRelationshipProvenancerequired
createdBystring (nullable)required
endedBystring (nullable)required
endedReasonstring (nullable)required
retractedBystring (nullable)required
retractedReasonstring (nullable)required
createdEventIdstring (nullable)required
endedEventIdstring (nullable)required
retractedEventIdstring (nullable)required
createdAtstring <date-time>required
updatedAtstring <date-time>required

Example

AckdbContactRelationship example
{
  "relationshipId": "string",
  "class": "string",
  "entityId": "string",
  "reportContact": {
    "contactId": "string",
    "entityId": "string",
    "personId": "string",
    "name": "string",
    "email": "string",
    "title": "string",
    "department": "string",
    "avatarUrl": "https://example.com",
    "isExternal": false,
    "status": "active",
    "startedAt": "1970-01-01T00:00:00.000Z",
    "endedAt": "1970-01-01T00:00:00.000Z"
  },
  "managerContact": {
    "$ref": "See AckdbContactGraphContact"
  },
  "relationshipType": "string",
  "reportToManagerLabel": "string",
  "managerToReportLabel": "string",
  "state": "active",
  "effectiveFrom": "1970-01-01T00:00:00.000Z",
  "effectiveTo": "1970-01-01T00:00:00.000Z",
  "retractedAt": "1970-01-01T00:00:00.000Z",
  "provenance": {
    "source": "string",
    "workflow": "string",
    "externalRecordId": "string",
    "evidenceUrl": "https://example.com",
    "observedAt": "1970-01-01T00:00:00.000Z",
    "metadata": {}
  },
  "createdBy": "string",
  "endedBy": "string",
  "endedReason": "string",
  "retractedBy": "string",
  "retractedReason": "string",
  "createdEventId": "string",
  "endedEventId": "string",
  "retractedEventId": "string",
  "createdAt": "1970-01-01T00:00:00.000Z",
  "updatedAt": "1970-01-01T00:00:00.000Z"
}