2025-03-06 - Graph Handler Docs

Overview

GraphHandler is a service that manages interactions with a neo4j graph database. It acts as an interface between applications and the underlying graph database, ensuring efficient data retrieval, updates, and analytics.

GraphHandler Function

CreateNode

Request Parameters

• objType
  • Type : object
  • Required: true
• objType.objectType
  • Type : string
  • Required : true
• objType.serviceTag
  • Type : string
  • Required : true
• objInstanceFull
  • Type : object
  • Required: true
• objInstanceFull.identifiers
  • Type : string
  • Required : true
• objInstanceFull.fields
  • Type : object
  • Required: optional
• settings
  • Type : object
  • Required : optional
• settings.updatePropertiesOnMatch
  • Type: Boolean // false // true
  • Required : optional
• originTimestamp
  • Type : date.now() // number
  • Required : optional for create or update
• relationships
  • Type : array
  • Required : optional for create
• relationships[item]
  • Type : object
  • Required: optional
• relationships[item].relType
  • Type : object
  • Required: optional
• relationships[item].relationshipProperties
  • Type : object
  • Required: optional
• relationships[item].relationshipDirection
  • Type : string
  • Required: true
• relationships[item].targetIdentifiers
  • Type : object
  • Required: true
• callingFlowConfig
  • Type: object
  • Required : optional
• callingFlowConfig.callingFlow
  • Type: string
  • Required : optional

Request Example

{
  "objType": {
    "objectType": "xxx",
    "serviceTag": "yyy"
  },
  "objInstanceFull": {
    "identifiers": {
      "id": "zzzz"
    },
    "fields": {
      "xxx": "yyy"
    }
  },
  "relationships": [
    {
      "relType": {
        "serviceTag": "xxx",
        "relationshipTag": "yyy"
      },
      "relationshipProperties": {"xxx": "yyy"},
   	  "relationshipDirection": "from", // "from" | "to"
      "targetObjType": {
        "serviceTag": "xxx",
        "objectType": "yyy"
      },
      "targetIdentifiers": {
        "id": "zzz"
      }
    }
  ],
  "originTimestamp": 9999,    // timestamp when create
  "settings": { 
   "updatePropertiesOnMatch": false  // default=false
  },
  "callingFlow": "xxx",
}

Output Response

• returnValue
  • Type: object
• returnValue.queryResult
  • Type: object
  • Description: data from created node
• queryResult.objTypes
  • Type: array
  • Description: serviceTag and objectType
• queryResult.exitsNode
  • Type: object
• queryResult.userNode
  • Type: object
  • Description: return user's created.
• queryResult.additionalReturn
• Type: object
  • Description: data from targetNode
• queryResult.relationships
  • Type: array
  • Description: data from relationships in targetNode
• returnValue.objType
  • Type: object
• returnValue.objInstanceFull
• Type: object
  • Description: data in graph
• returnValue.objInstanceFull.identifiers
  • Type: object
  • Description: Id has properties Key
• returnValue.objInstanceFull.fields
  • Type: object
  • Description: data properties in graph
• returnValue.relationships
  • Type: array
  • Description: data from relationships that create node to targetNode
• returnValue.settings
  • Type: object
• returnValue.Status
  • Type: string
  • Description: Status from create node. Return "error" or "complete".
• returnValue.errorsFound
  • Type: array
• returnValue.graphServiceTag
  • Type: string