AckdbCompanyGraphResult

Properties

requestedCompanyAckdbCompanyGraphCompanyrequired

canonicalCompanyAckdbCompanyGraphCompanyrequired

identityRelationshipsarray ofrequired

AckdbCompanyIdentityRelationship

companiesarray ofrequired

all of

Option 1

AckdbCompanyGraphCompany

Option 2

depthintegerrequired

companyRelationshipsarray ofrequired

AckdbCompanyRelationship

countsobjectrequired

companiesintegerrequired

relationshipsintegerrequired

maxDepthintegerrequired

queryobjectrequired

scopestringrequired

"parents""children""connected"

relationshipTypesarray ofrequired

string

maxDepthinteger (nullable)required

asOfstring <date-time>required

includeRootbooleanrequired

Example

AckdbCompanyGraphResult example

{
  "requestedCompany": {
    "entityId": "string",
    "name": "string",
    "domain": "string",
    "status": "string",
    "graphOnly": false
  },
  "canonicalCompany": {
    "$ref": "See AckdbCompanyGraphCompany"
  },
  "identityRelationships": [
    {
      "class": "string",
      "type": "string",
      "company": {
        "$ref": "See AckdbCompanyGraphCompany"
      },
      "canonicalCompany": {
        "$ref": "See AckdbCompanyGraphCompany"
      }
    }
  ],
  "companies": [
    {
      "$ref": "See AckdbCompanyGraphCompany",
      "depth": 0
    }
  ],
  "companyRelationships": [
    {
      "relationshipId": "string",
      "class": "string",
      "childCompany": {
        "$ref": "See AckdbCompanyGraphCompany"
      },
      "parentCompany": {
        "$ref": "See AckdbCompanyGraphCompany"
      },
      "relationshipType": "string",
      "childToParentLabel": "string",
      "parentToChildLabel": "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"
    }
  ],
  "counts": {
    "companies": 0,
    "relationships": 0,
    "maxDepth": 0
  },
  "query": {
    "scope": "parents",
    "relationshipTypes": [
      "string"
    ],
    "maxDepth": 0,
    "asOf": "1970-01-01T00:00:00.000Z",
    "includeRoot": false
  }
}